Ahol a dolgok kissé technikussá válnak: Hogyan valósítottuk meg a Shortcode Mapping saját verzióját

Szerző:

itt:

,

How-We-Made-Our-Version-Of-Shortcode-Mapping-Happen-2Az előző cikkben megvitattuk a shortcode-leképezés alapjait, és azt, hogyan juthatsz hozzá a nagyszerű előnyeihez. Úgy döntöttünk, hogy a Page Builder Sandwich-féle Shortcode Mappinget bemutató cikket kettéválasztjuk, mivel a következő írás egy kicsit technikaibbá válhat.

Az alábbiakban részletesebben bemutatjuk a shortcode-leképezési funkciónk belső működését, és azt, hogyan sikerült működésre bírnunk.

Egy automatizált folyamat

Annak eldöntésére, hogy mely bővítményeket vegyük fel a shortcode-leképezőbe, készítettünk egy automatizált szkriptet, amely a következő szempontok alapján gyűjti össze a legjobb bővítményeket a WordPress bővítménykönyvtárából:

  • Az 1000 legnépszerűbb, legjobbra értékelt és frissített bővítmény közül kerül ki,
  • Legalább 4000 aktív telepítéssel rendelkezik,
  • Legalább 20 értékeléssel bír, és;
  • Legalább 3 csillagos átlagos értékeléssel rendelkezik

Ezt a lekérdezést naponta futtatjuk a WordPress bővítménykönyvtárában. Ezek a szűrők biztosítják, hogy olyan jó minőségű bővítmények listáját kapjuk meg, amelyeket sokan használnak. Ennek a bejegyzésnek az írásakor ez a feltételrendszer 800 bővítményt eredményezett. Ez rengeteg. Nagyon sok.

Some of the most popular plugins detected for shortcode mapping.
A shortcode-leképezéshez felismert legnépszerűbb bővítmények egy része.

Ezután egy sor automatizált ellenőrzést futtatunk az egyes bővítmények forráskódján, hogy kiderítsük, tartalmaznak-e shortcode-okat, majd megpróbáljuk megkeresni az összes ilyen shortcode-ot az összes attribútumukkal együtt. Az adatok feldolgozása után ez több mint 2000 shortcode-ot eredményezett. Dupla wow. Az észlelt shortcode-ok ezután bekerülnek a shortcode-leképezési adatbázisba kézi ellenőrzés céljából.

E folyamat végére egy hatalmas bővítménylista áll össze, valamint a lehetséges shortcode-jaik. Innentől kezdve már csak az adatok megtisztítása a feladat, hogy megbizonyosodjunk arról, minden helyes.

Egy kézi folyamat

Ez valószínűleg a legnehezebb része az egész leképezési rendszernek. A bővítmények kódja különböző formákban és méretekben érkezik, nem minden shortcode-ot ismernek fel automatikusan a szkriptjeink. Bár a WordPress Codex szerint a `shortcode_atts` függvényt kellene használni a shortcode attribútumainak szűrésére, ez csak egy ajánlás, és nem mindenki teszi meg. Arra sincs biztos módszer, hogy egy bővítmény telepítésekor ellenőrizzük egy shortcode belső működését.

Annak érdekében, hogy minden shortcode-ot és azok attribútumait helyesen kapjuk meg, létrehoztunk egy frontend felületet, amely kifejezetten a shortcode-ok és attribútumok szerkesztésére szolgál, és AngularJS valamint Bootstrap használatával készült.

Bootstrap & AngularJS interface for fixing up all the mapped shortcodes.
Bootstrap & AngularJS felület a leképezett shortcode-ok rendbetételéhez.

Manuálisan kell átnéznünk minden egyes bővítményt, ellenőriznünk a shortcode-dokumentációjukat, és meg kell győződnünk arról, hogy minden rendelkezésünkre álló adat helyes.

Bár ez rendkívül fáradságos munka, az automatizált folyamatnak azért vannak előnyei:

  • Korai statisztikáink szerint nagyjából csak minden második bővítmény tartalmaz shortcode-okat.
  • A felismert shortcode-ok felének nincsenek attribútumai (bár ennek egy része téves pozitív eredmény lehet)
  • Mivel csak jó minőségű bővítményeket veszünk alapul, nagy valószínűséggel rendelkeznek shortcode-dokumentációval

Amikor egy bővítmény összes shortcode-ját ellenőriztük, a szerver csak akkor kezdi el terjeszteni az adott bővítmény shortcode-leképezéseit a felhasználók felé.

Egy REST API hívás

A kirakós utolsó darabja maga a bővítmény. Az elgondolás itt egyszerű: derítsd ki, milyen bővítmények aktívak, milyen sablont használ az oldal, és milyen shortcode-ok érhetők el, majd kérdezd meg a shortcode-leképezési adatbázist, hogy vannak-e leképezései. Ehhez létrehoztunk egy egyedi WP REST API végpontot, amelyet az összes kliens pingel, hogy megkapja a legfrissebb shortcode-leképezéseket.

A jövő: Közösségi forrásbevonás (Crowdsourcing)

Az egyes bővítmények kézi ellenőrzése rengeteg időt és energiát igényel. Amint a shortcode-leképezési platform stabilizálódik, azt tervezzük, hogy mindenki számára megnyitjuk a shortcode-leképezést. Ez azt jelenti, hogy bárki segíthet a shortcode-ok hozzáadásában.

Talán arra gondolsz: „miért segítenék a shortcode-ok leképezésében? Mi hasznom származik belőle?” Nos, néhány dolog eszünkbe jut, amiért az emberek szívesen segítenének:

  1. Ha készítettél egy bővítményt, és a fenti feltételek miatt még nem fedeztük fel (és bent van a WordPress bővítménykönyvtárában), akkor te magad is hozzáadhatod a leképezéseket. Bővítményedet így a PBS teljes mértékben támogatni fogja!
  2. Mivel az automatizált folyamatban csak a WordPress bővítménykönyvtárában található elemekkel foglalkozunk, a prémium bővítmény- és sablonkészítők nem kerülnek bele. Ha van ilyened, te magad is hozzáadhatod hozzájuk a shortcode-leképezéseket.
  3. A nem bővítményfejlesztőknek pedig: megjutalmazhatjuk azokat, akik segítenek. Hogy vonzó vállalkozássá tegyük a shortcode-leképezést, a lelkes segítőket megajándékozhatjuk egy személyes licenccel vagy egy prémium PBS licencfrissítéssel!

Iratkozz fel a hírlevelünkre

A shortcode-leképezési funkció az ügyfeleink számára várhatóan 2016. augusztus 12-én  augusztus 15-én  2016. augusztus 16-án jelenik meg. Erre az időpontra még nem lesz leképezve az összes shortcode (becslésünk szerint talán 100 bővítmény), de a leképezést folyamatosan végezzük, és a felhasználók azonnal megkapják őket, amint az újak elkészülnek.

Iratkozz fel hírlevelünkre, hogy híreket kapj a shortcode-leképezésről, annak megjelenéséről, és arról, mikor nyitjuk meg a shortcode-leképezést a nyilvánosság számára!