Sprievodca pre začiatočníkov pre WordPress Plugin Development

WordPress CMS zmenil tvár nášho internetu a umožnil prudký nárast nových nápadov a jeho otvorené zdrojové hnutie má silnú prítomnosť založenú na vývoji softvéru a webu. WordPress je blogová platforma, ktorá má schopnosť spustiť do mnohých ďalších skriptov, ako sú webové fóra, pracovné dosky a dokonca aj klasický webový systém pre správu obsahu.

Budeme ísť cez niekoľko spôsobov, ako začať s vývojom plug-in pre WordPress. Kroky sú pomerne jednoduché a nevyžadujú veľké odhodlanie študovať. Bezprostredné znalosti PHP by boli užitočné aj pri základnom chápaní štruktúry súborov WordPress a Administration panelu.

V tejto stručnej príručke sa budeme zaoberať základnými krokmi potrebnými na vytvorenie jednoduchého doplnku WordPress. Táto funkcia sa použije na vytvorenie dynamických úryvkov na základe čísla prechádzajúceho do nášho volania funkcie. Budete musieť odovzdať súbor doplnku a aktivovať ho z panelu Administrátora a následne sa obrátiť na našu funkciu z akýchkoľvek stránok, na ktorých chceme, aby sa výňatok zobrazil. Odkazy na dokončený plug-in zdrojový kód už boli pridané neskôr v tomto článku :)

Prečo sa vyvíjať pre WordPress?

Plug-ins sú skvelý spôsob, ako zlepšiť funkčnosť vášho blogu pridaním ďalších funkcií. Tieto môžu byť umiestnené kdekoľvek vo vašej šablóne pomocou funkčných háčikov. V priebehu času rozšírenie plug-in systému WordPress umožnilo obrovský rast a stovky kusov softvéru dodávaných vývojárom.

WordPress špeciálne ponúka takéto pokročilé funkcie v CMS, že jedinečné doplnky sú málo a ďaleko. Ako vývojár máte úplnú kontrolu nad špecifikami vášho weblogu. Prijímanie vývojára PHP na vytvorenie doplnku systému by stálo oveľa viac, než si dokážete predstaviť a rozhranie API je dostatočne jednoduché na to, aby ste pracovali a učili sa.

Ako sekundárny argument, rozvoj cez WordPress je skvelá prax pre ladenie sa do iných oblastí. Budovanie menších pluginov a widgetov na bočných paneloch v aplikácii WordPress vám pomôže rozvinúť pochopenie toho, ako funguje backendový systém. To nie je obmedzené len na WordPress, pretože získate hlbšie pochopenie drvivej väčšiny Content Systems.

1. Štruktúra priečinkov WP

Úvod do štruktúry priečinkov WordPress zobrazí základné adresáre aplikácií. Vo vnútri wp-obsahu nájdete a plugins adresár. Tu je miesto, kde budú umiestnené všetky vaše jednotlivé pluginy, a to buď jednotlivé súbory, alebo správne menované podadresáre.

Pre menšie zásuvné moduly, ktoré vyžadujú iba jeden .php súbor, máte možnosť umiestniť to priamo do adresárov plug-in / adresár. Avšak keď začnete s vývojom komplikovanejších aplikácií, je oveľa užitočnejšie vytvoriť podadresár s názvom po vašom plug-in. Vo vnútri môžete umiestňovať funkcie JavaScript, CSS a HTML spolu s funkciami PHP.

readme.txt Súbor môže byť tiež užitočný, ak plánujete ponúknuť svoj plugin na stiahnutie. Tento súbor by mal obsahovať vaše meno a to, čo plugin vykonáva. Ako autor môžete tiež zvážiť zahrnutie podrobností o každej revízii a ktoré aktualizácie vyšli.

2. Spustenie PHP súboru

Pri vytváraní nového pluginu budete musieť začať s jednoduchým PHP súborom. Toto môže byť pomenované ako čokoľvek, ale vo všeobecnosti by malo odrážať oficiálny názov vášho doplnku. Napríklad som vytvoril náš základný kód a pomenoval môj súbor hongkiat-excerpt.phps.

Prvé riadky vášho doplnku musieť byť komentár informácie pre analyzátor motora. To je veľmi dôležité, pretože WordPress nebude môcť spracovať váš súbor bez. Nižšie je uvedený príklad kódu, ktorý môžete kopírovať a formovať smerom k sebe.

Názov pluginu je to, čo sa pri aktivácii zobrazí v paneli administrátora Backend. To isté platí pre identifikátor URI, ktorý sa umiestni do tabuľky s podrobnosťami v paneli zásuvných modulov. Hoci sa nepožaduje, aby obsahoval verziu alebo popis, urobí to, že váš doplnok je oveľa profesionálnejší.

3. Dohovory a najlepšie postupy pre pomenovávanie WordPress

Existuje niekoľko spôsobov, ako skutočne štruktúrovať svoj plug-in. Mnohokrát vývojári PHP vytvoria celý systém tried, aby sa vyhli kolíziám s názvami funkcií a premenných. Ak nie ste oboznámení s pokročilou funkčnosťou OOP v PHP, potom je najlepšie len napísať kód do vzorových funkcií.

Pre náš príklad kód napíšeme jednu funkciu, ktorá usporiada naše dáta. Takisto je potrebné definovať niekoľko premenných, ktoré sú kľúčové pre implementáciu vo vnútri našich súborov šablón. Nižšie je uvedený príklad bit kódu odobratý z nášho súboru s logikou jadra, ktorý bol odstránený.

Pri písaní vzorového kódu je najlepšie dodržiavať pravidlá a pokyny nastavené službou WordPress. Vzhľadom na to, že už existuje toľko vnútorných funkcií, môžete vyhnúť sa duplicitám tým, že predpíšete štítok na všetky vaše premenné a názvy funkcií.

Vo vyššie uvedených príkladoch sme predpísali všetky naše nastavovacie mená hongkiat. Toto môže byť nahradené ľubovoľným kľúčovým slovom podľa vášho výberu, ktoré sa zvyčajne týka vášho názvu pluginu. Vyššie uvedený kód je jednoduchý nastavenia vzoriek a nemali by sa týkať nášho konečného doplnku. Toto je len na to, aby ste získali prehľad o tom, ako by mali byť napísané vaše mená premenných a funkčné volania.

4. Potápanie do filtrov a akcií

Existuje ďalšia koncepcia pozoruhodná zmienka skôr, než sa dostaneme do nášho surového kódu. Akcia a filtre sú dva úplne odlišné koncepty, ktoré sa hlboko týkajú spôsobov, ktorými manipulujú s dátami doplnkov.

Tieto dva kúsky kódu sa štandardne nachádzajú v API aplikácie WordPress. Filtre a akcie umožňujú vývojárom zásuvných modulov aktualizovať bity kódu v administrátorskom paneli aplikácie WordPress, ktoré sa týkajú vášho nového doplnku. To znamená, že môžete pridať novú kartu v bočnom paneli alebo v ďalších nastaveniach odkazov pre vaše možnosti doplnkov.

Pochopenie add_filter ()

filter sa používa na trochu textu alebo dát prechádzajúcich do WordPress. S filtremi, ktoré doslova dokážete obsah filtra prostredníctvom svojich vlastných písomných funkcií akýmkoľvek spôsobom meniť údaje.

Môžete napríklad vytvoriť filter na zmenu $ the_content čo je premenná nastavená WordPress obsahujúca celý príspevkový obsah článku WordPress. Pre náš plug-in budeme brať $ the_content a skrátenie dĺžky znakov do výňatku.

Filtre vám pomôžu pri písaní doplnkov prispôsobiť vzhľad a dojem vášho blogu. Tieto sú obzvlášť populárne pri písaní widgetov na bočných paneloch alebo menších funkcií, ktoré menia spôsob zobrazovania príspevku. Nižšie je vzorový riadok kódu, ktorý zobrazuje, ako použiť filter.

add_filter ('wp_title', 'hongkiat_func');

Tu pridávame filter do názvu stránky WordPress. Tento kód sa netýka nášho oficiálneho doplnku a používa sa iba ako príklad.

add_filter funkcia je natívna pre WordPress a používa sa na pridanie nového filtra do premennej nachádzajúcej sa v rámci obsahu stránky. V našom riadku sme zacielení $ wp_title ktorý obsahuje názov našej aktuálnej stránky. Premenujeme túto premennú na falošnú funkciu nazvanú hongkiat_func () ktorý by mohol manipulovať a vrátiť novú značku názvu na akékoľvek účely.

Pochopenie add_action ()

Akcie sú podobné filtrem v tom, že nefungujú na bitoch údajov, ale namiesto toho zacielia na vopred definované oblasti vo vašich šablónach a administrátorskom paneli. Ako príklad môžete použiť akciu vždy, keď aktualizujete alebo upravíte obsah stránky. WordPress ponúka komplexný zoznam činností v dokumentácii k API. Nižšie je uvedený malý zoznam príkladov akcií, ktoré vám umožnia oboznámiť sa s niektorými z preddefinovaných cieľových oblastí.

• publish_post - keď sa uverejní príspevok alebo keď sa zmenil stav “uverejnený”
• save_post - keď sa po spustení alebo aktualizácii vytvorí príspevok / stránka
• wp_head - keď sa šablóna načíta a spustí wp_head () funkcie
• loop_end - nazvaný bezprostredne po spracovaní konečného príspevku cez slučku WordPress
• trackback_post - keď sa k príspevku pridá nový trackback

Opäť môžeme vidieť, ako jednoduchý tento kód kódu klesá. Ak pochopíte rozdiel medzi akciami a filtremi, budete oveľa bližšie k vytváraniu komplexných pracovných modulov WordPress. Nižšie je ďalší riadok kódu inicializujúci akčnú funkciu na save_post háčik. Aby sme to znova objasnili, toto sa nevzťahuje na náš súčasný vývojový doplnok a používa sa iba ako príklad kódu na pochopenie ADD_ACTION () funkcie.

add_action ('save_post', 'notify');

Takže tu vidíme podobné nastavenie ako predtým s add_filter (). Potrebujeme dve premenné, prvé obsahuje názov nášho háku, na ktorý sa zameriavame. V tomto prípade save_post čo znamená, že vždy, keď je uložený nový príspevok, budeme nazývať našu funkciu definovanú v druhej pozícii (oznámiť ()). Môžete samozrejme aktualizovať upozornenie na akýkoľvek názov funkcie, ktorý by ste chceli spustiť, avšak to nie je potrebné pre náš súčasný príklad plug-in.

Dokončenie Plugin Logic

Po dokončení našej cesty pridáme našu konečnú funkciu priamo do nášho súboru plug-in. Dokumentácia rozhrania API je veľmi špecifická a poskytuje vynikajúci zdroj pre vývojárov, ktorí môžu mať pokročilé otázky. Materiál sa môže zdať ťažký, ak nie ste oboznámení s PHP, ale venujte svoj čas konceptom a veci sa začnú prirodzene prúdiť!

Nasledujúca funkcia by sa mala pridať priamo po komentári záhlavia doplnku. Prípadne by to mohlo byť umiestnené aj vo vašej téme functions.php súboru. Kód sa používa na vytvorenie dynamického príspevkového obsahu založeného na obmedzenom rozsahu znakov.

Pre náš príklad môžeme obmedziť výňatky z príbehu iba 55 znakov dlhým hk_trim_content () Funkcie. Jednoducho by ste mohli zavolať tento bit kódu z miniaplikácie bočného panela alebo jedného z vašich súborov motívov, ktoré chcete nahradiť $ the_content.

= $ limit) array_pop ($ obsah); $ content = implode ("", $ obsah).  iný $ content = implode ("", $ obsah);  $ Content = preg_replace ( '/\[.+\]/', "obsah $); $ content = apply_filters ( 'the_content', $ obsah); return obsah $;?> 

Nemalo by sa očakávať, že budete plne chápať všetky interné premenné alebo funkcie, ktoré sa tu používajú. Stačí získať všeobecné pochopenie toho, ako by mali byť vaše funkcie napísané a aký príklad by vyzeral, je to veľmi dobrý začiatok.

Môžete si tiež všimnúť, že používame hovor apply_filters čo je ďalšia funkcia špecifická pre WordPress. To je ďalší aspekt, ktorý nepotrebujete úplne pochopiť, ale pomôže s budúcim programovaním cez WP. Pozrite sa na referenčnú stránku apply_filters a získajte ďalšie podrobnosti a najčastejšie otázky týkajúce sa tejto témy.

Hlavná funkcia uvedená vyššie je pomenovaná hk_trim_content (). Toto vyžaduje len jeden parameter s názvom $ medza. Tiež by sa to mohlo skrátiť $ lim ktorý by mal ukladať celé číslo, ktoré určuje, koľko znakov obmedzí váš úryvok. Obsah sa používa na celých stránkach pošty a tiež na statických stránkach (o nás, kontakte).

Preto, aby sme zavolali túto funkciu, bolo by potrebné pridať parameter do našich súborov šablón. To by bolo umiestnené niekde vo vašom index.php alebo loop.php súborov a bude vyžadovať, aby ste najskôr nainštalovali doplnok. Príklad nižšie:

Inštalácia a spustenie doplnku

Vytvoril som vzorový súbor pre plugin na demo, ak by ste chceli preskočiť tvrdé kódovanie. Jednoducho si stiahnite tento súbor (premenujte ho na .php) alebo skopírujte / prilepte kód do nového dokumentu PHP a odovzdajte ho do svojho / WP-obsah / plugins adresár.

Po dokončení budete chcieť získať prístup k panelu správy aplikácií WordPress a prezerať si aktuálnu sadu doplnkov pre inštalovanú ukážku. Akonáhle aktivujete nič nové sa stane, až kým ručne pridáme naše volanie funkcie. Ak to chcete urobiť, jednoducho prejdite Vzhľad -> Editor a hľadať single.php.

Tento súbor obsahuje všetky šablóny HTML / CSS pre vašu základnú stránku článku. Prejdite nadol, kým nenájdete obsah() a nahraďte ho vyššie uvedeným kódom. Týmto obmedzíte všetky stránky článku na 55 znakov bez ohľadu na to, aký pohľad sa používa. Túto funkciu môžete pridať aj na podobné stránky v adresári šablón, ako napríklad search.php alebo archive.php.

záver

To sú niektoré zo základov, ako začať pracovať v rámci vývoja WordPress. Zásuvný systém je obrovský a obsahuje veľké množstvo interných funkcií. Ak už máte nápad na plug-in, vyskúšajte to v miestnej inštalácii aplikácie WordPress, aby ste mohli tieto témy praktizovať.

Ak ste stále zmätení veľa informácií, môžete si prezrieť dokumentáciu WordPress a vyhľadať tam svoju odpoveď. Vývojová komunita je plná užitočných používateľov a fóra obsahujú archívy s otázkami z rokov späť.