Ako vývojári WordPress sme zodpovední za vytváranie doplnkov, z ktorých budú mať úžitok naši používatelia nielen vďaka funkciám, ktoré naše doplnky pridávajú. Naše doplnky by sa tiež mali vyhýbať načítavaniu nepotrebných zdrojov, nemali by spomaľovať backend a mali by byť ľahko použiteľné, ako napríklad plugin WPPB.
Pamätajte, že ekosystém WordPress sa pestuje na kóde s otvoreným zdrojovým kódom a vývojári stavajú na svojich doplnkoch. Je to duch otvoreného zdroja spolupracovať a spoločne vytvárať vylepšený kód. Potrebujeme však aj rámec na efektívnu spoluprácu. teda Automatické používa prísne pokyny pri prijímaní doplnku do svojho úložiska (to isté platí pre témy).
Našťastie existujú vývojári ako Tom McFarlin a Devin Vinson. Oni vytvorili Štandardný doplnok WPPBktorého cieľom je uľahčiť vytváranie doplnkov WordPress.
Prečo používať Plugin Boilerplate, ako je WPPB Boilerplate?
Najprv si povedzme, prečo by ste mali zvážiť použitie štandardnej verzie vo svojom vývojovom pracovnom postupe.
Existuje niekoľko situácií, v ktorých má použitie štandardnej verzie WPPB zmysel:
- S tímom vývojárov vytvárate doplnok úplne od začiatku
- Doplnok je určený na zverejnenie v úložisku doplnkov WP
- Váš doplnok sa stane povinným v podnikaní vašich klientov a musí byť spoľahlivý a stabilný
- Chcete sa dozvedieť o štandardoch kódovania WordPress a osvedčených postupoch
Poďme si tieto dôvody rozobrať jeden po druhom:
1.: Vytvárate doplnok od nuly s tímom vývojárov.
Vždy, keď na rovnakej kódovej základni pracuje viacero vývojárov, nastanú výzvy, ktorým jednotliví vývojári čelia len zriedka. Musíte sa uistiť, že:
- Každý rozumie štruktúre súborov.
- Účel každého jedného súboru a triedy je jasný.
- Funkcie sú dobre zdokumentované
- Vývojári chápu, kam umiestniť akcie, spätné volania atď.
- Proces presadzovania zmien do vašich inscenačných a živých systémov je jasný.
Ako jediný vývojár si zvyčajne s týmito vecami príliš nelámete hlavu. Na doplnku pracujete iba vy, takže štruktúra je aj tak vaša. Pri mnohých vývojároch sa však musíte uistiť, že vývojár A rozumie tomu, prečo vývojár B píše kód tak, ako je.
Štandard WPPB pomáha predchádzať zmätkom, pretože všetkých stavia na rovnakú stránku.
2.: Doplnok je určený na zverejnenie v úložisku doplnkov WP
Ako už bolo povedané, Automattic presadzuje prísne pokyny pre doplnky, ktoré sú akceptované v úložisku WP. Používanie štandardného kódu WPPB zjednodušuje dodržiavanie týchto pokynov, pretože kód je už napísaný nasledujúcim spôsobom kódovacie štandardy a dokumentačné štandardy. Takže ušetríte čas prehliadaním kódexu WordPress a môžete sa hneď pustiť do práce, pričom jednoducho budete postupovať podľa štruktúr uvedených v štandarde.
Okrem toho sú súbory už usporiadané tak, ako to vyžaduje úložisko doplnkov. Štruktúra súboru jasne ukazuje, ktorý súbor kam ide a odstraňuje všetky dohady.
3.: Podnikanie vašich klientov sa bude spoliehať na váš doplnok
Zatiaľ čo vývoj stabilného a spoľahlivého doplnku by mal byť vždy cieľom, existujú situácie, v ktorých chcete, aby bol váš doplnok skalopevný. Ak váš doplnok vykonáva akcie, bez ktorých trpí podnikanie vášho klienta, vaša kódová základňa musí byť stabilná, efektívna a ľahko udržiavateľná.
Použitím štandardného doplnku ako základu bude práca s kódom tým jednoduchšia, čím viac ste zvyknutí na štandardnú štruktúru. Bez tejto pevnej štruktúry je ľahké – podvedome – vytvoriť novú štruktúru doplnkov pre každý projekt, na ktorom pracujete. To by značne sťažilo prácu na kóde, ktorého ste sa nedotkli 6 až 12 mesiacov.
4.: Chcete sa dozvedieť o štandardoch kódovania WordPress a osvedčených postupoch
Aby ste sa stali lepším vývojárom, musíte sa neustále učiť nové veci a prispôsobovať sa osvedčeným postupom. Jedným z najrýchlejších spôsobov, ako sa zoznámiť so štandardmi kódovania WordPress, je rozšírenie doplnku, ktorý ich už implementuje. WPPB to robí veľmi pohodlným. Môžete klonovať ktorýkoľvek z príklady pluginov a začať sa učiť.
Čoskoro pochopíte, prečo sú vytvorené tak, ako sú, a ako k nim môžete pridať vlastnú funkčnosť.
Nastavte lokálnu inštaláciu a prezrite si kód vzorových doplnkov.
Začíname s vaším novým doplnkom pomocou WPPB Boilerplate pre WordPress
Dosť bolo teórie, poďme sa vrhnúť na používanie WPPB.
Pre tento príspevok predpokladám, že ako vývojové prostredie máte nainštalovanú lokálnu stránku. Mať nainštalovaný Git na vašom počítači pomáha, ale nie je to povinné.
Prvým krokom je prejsť na WPPB.me.
Keďže štandard WPPB sa dodáva s mnohými miestami, ktoré odkazujú na názov vášho pluginu, slimáka, meno autora atď., pri sťahovaní súborov je dobré použiť generátor WPPB.me. Mohol by si klonovať úložisko WPPB Githubale to by všetko hľadanie a nahradzovanie nechalo na vás.
V tomto príklade použijeme nasledujúce podrobnosti:
Po kliknutí na „Vytvoriť doplnok“ váš prehliadač stiahne archív zip, ktorý si potom môžete nainštalovať na svoju miestnu stránku. Na tento účel môžete použiť bežný inštalačný program doplnkov alebo rozbaľte archív a umiestnite ho do súboru wp-content/plugins. Po aktivácii doplnku sa zobrazí v zozname doplnkov.
Pochopenie štruktúry zásuvného modulu WordPress
Ok, proces generovania a inštalácie doplnkov neboli príliš vzrušujúce – ale pre začiatočníkov nevyhnutné. Ak chcete skutočne začať s vývojom pomocou doplnku, pozrime sa na štruktúru súborov.
Ako by ste očakávali, súbory sú veľmi dobre usporiadané.
Priečinok „admin“ obsahuje logiku a používateľské rozhrania, ktoré sa načítavajú v oblasti WP-Admin webovej stránky. Každý vývojár, ktorý sa pozrie na tento plugin, to okamžite pochopí.
Priečinok „zahŕňa“ obsahuje jadro pluginu, do ktorého umiestnite väčšinu funkcií. Ako príklad môžete rozšíriť class-my-plugin-activator.php na nastavenie vlastných databázových tabuliek, vlastných úloh wp-cron alebo na kontrolu iných doplnkov a závislostí. V rámci class-my-plugin-deactivator.php môžete vyčistiť webovú stránku, keď je váš plugin deaktivovaný.
Nasleduj Normy internacionalizácieclass-my-plugin-i18n.php načíta textovú doménu pluginov.
Bez ohľadu na to, aký súbor doplnku si prezeráte, zistíte, že kód je mimoriadne dobre zdokumentovaný.
Na snímke obrazovky môžete vidieť hlavný súbor vášho nového doplnku, ktorý je pre mňa ideálnym východiskovým bodom na pochopenie toho, ako funguje logika doplnku. Vždy, keď narazíte na reťazec „my-plugin“ alebo „My_Plugin“, nezabudnite, že som ho nastavil v generátore. To je dôvod, prečo uprednostňujem generovanie štandardnej verzie pred jednoduchým klonovaním Github repo. Bez generátora by ste museli prejsť všetky súbory doplnkov a upraviť tieto reťazce tak, aby zodpovedali názvu vášho doplnku.
Poďme sa krátko dotknúť štruktúry súborov pre aktíva, ako sú súbory JS alebo CSS.
Aby sa z vývoja odstránili všetky dohady, WPPB je usporiadaný do samostatných priečinkov pre CSS, JS a čiastočné. Ako by ste očakávali, class-my-plugin-public.php je zodpovedný za správne zaradenie CSS a JS do frontu a za načítanie častí podľa potreby. Keď súbor otvoríte, uvidíte, že používa bežný skript wp_enqueue_script, wp_enqueue_style a wp.
Ak nie ste oboznámení s prácou s čiastočnými časťami, odporúčam vám prečítať si Dokumentácia súboru šablóny. „Čiastočná šablóna je časť šablóny, ktorá je súčasťou inej šablóny, ako je napríklad hlavička lokality. Časti šablóny možno vložiť do viacerých šablón, čo zjednodušuje vytváranie tém.“ – WordPress dokumentácia
Zatiaľ čo dokumentácia hovorí o vytváraní tém, môžete samozrejme zahrnúť časti aj do doplnkov, a to ako v backende, tak aj vo frontende. Pokiaľ ide o frontend, životaschopným spôsobom použitia časti môže byť jej vloženie do krátkeho kódu. V backende možno budete chcieť použiť časť na stránkach správcu vášho doplnku (ktorým sa budeme venovať v tomto článku).
Je zrejmé, že súbory sú teraz takmer prázdne a existuje iba najzákladnejšia logika. Je to skvelé na spustenie nového doplnku od začiatku, ale nemusí to byť ideálne na učenie sa, ako funguje štandardný kód. Na učenie vám odporúčam nainštalovať WPPB Demo Plugin a zoznámte sa s ním.
Príklad: Nastavenie stránky možností v backende
Ako môžete vidieť po aktivácii doplnku WPPB Demo Plugin, v ponuke „Pluginy“ je nová stránka možností.
Ak chcete zistiť, ako bola táto stránka pridaná, prejdime si kód doplnku.
Hľadanie miesta, kde bola pridaná stránka „WPPB Demo Options“ je jednoduché, musíme sa pozrieť do priečinka „admin“. Na základe štruktúry priečinkov jednoducho neexistuje žiadne iné miesto na vloženie kódu, ktorý sa načíta do oblasti WP-Admin.
Tento nový súbor spracováva obsah zobrazený na stránke správcu. Môžete preskúmať jeho logiku a uvidíte, že je schopný:
- Zobrazenie hlavičky, obsahu alebo päty
- Ukladanie odkazov na sociálne profily
- Sú tam aj príklady spracovania vstupov
Pozrite si prosím, čo sú tieto funkcie: príklady. Nečakajte, že budú hlboko integrované do akejkoľvek témy, ktorú používate. Ich účelom je vysvetliť, ako môžete vytvoriť podobnú funkčnosť s vaším novým doplnkom. Načítanie obsahu prebieha v class-wppb-demo-plugin-admin.php vo funkcii load_dependencies() v riadku 70.
Samozrejme, je len na vás, či pridáte nastavenia pluginu ako položku v ponuke „Pluginy“, ako položku hlavnej ponuky alebo stránku Možnosti. Implementáciu môžete kedykoľvek zmeniť úpravou funkcie setup_plugin_options_menu() v riadku 55 súboru class-wppb-demo-plugin-settings.php.
Navrhujem však, aby ste sa zamerali na UX backendu. Nie je vždy dobrý nápad zahltiť ponuku WP-Admin stránkami s ponukami, len preto, že si myslíte, že váš doplnok je dôležitejší ako iné doplnky.
Záver o doplnku WPPB Boilerplate pre WordPress
Doplnok WPPB je pre mňa fantastickým základom na vytvorenie doplnku WordPress od začiatku.
Myslím, že to vyhovuje projektom, ktoré:
- Vyžadovať prácu viacerých vývojárov na novom doplnku
- Plánujte odoslať doplnok do úložiska doplnkov WordPress
- Chcete vytvoriť spoľahlivú a udržiavateľnú kódovú základňu
- Sú určené na oboznámenie vývojára so štandardmi kódovania WordPress
Zásuvný modul WPPB môže byť tiež prehnaný, najmä ak:
- Chcete vytvoriť doplnok MVP na overenie nápadu
- Potrebujete dočasnú opravu jednoduchého problému
Majte na pamäti, že vývojári, ktorí pracujú s kódom prvýkrát, sa budú musieť oboznámiť so štandardom. Keď však spoznajú štandard WPPB, budú v dobrej pozícii na vytvorenie doplnku, ktorý sa riadi štandardmi kódovania a dokumentácie WordPress.
Potrebujete rýchlejšieho poskytovateľa hostingu WordPress?
Riešenie Hostinger Managed WordPress automaticky spracováva kompresiu obrázkov a všetky aktualizácie doplnkov a základných WordPress, takže sa môžete sústrediť na vytvorenie výnimočného doplnku.
Začnite s plne spravovaným WordPress od Hostinger.
