Búðu til fyrsta WordPress-viðbótina þína (Part 1)
Eitt af meginástæðum fyrir áframhaldandi vinsældum WordPress er vellíðan sem hægt er að framlengja og sérsníða með viðbætur.
Uppbygging tappi kann að virðast eins og ómögulegt verkefni, en það er einfaldara en þú getur hugsað. Í dag byrjum við að byggja upp fyrsta WordPress tappi röðina sem mun ná yfir mikilvægustu meginreglurnar og hvernig ferlið er.
Í lok seríunnar verður þú að fullu reiðubúin til að gera frekari tilraunir þínar eigin, að treysta á bestu starfsvenjur og samninga sem samþykktar eru af víðtæku WordPress samfélaginu.
Hvað er WordPress tappi?
Það er PHP handrit sem breytir eða lengir innbyggða virkni WordPress.
Með því að veita mjög einfalt en sveigjanlegt Forritaskil , WordPress veitir hverjum forritara með eftirfarandi kostum fyrir notkun tappa:
- Engin þörf á að breyta kjarnaskrám til að fá viðbótar eða aðra valkosti. Þetta þýðir að hægt er að varðveita tappi virkni með algeru uppfærslum
- WordPress hefur innbyggt kerfi aflögun tappa þegar banvæn villa gæti hugsanlega brotið á síðuna
- Modularity kóða fyrir tiltekið verkefni eykst; uppfærslur og viðhald verða auðveldara
- Plugin virkni er aðskilin frá þemum
- Sama tappi er hægt að nota með mismunandi þemum og hefur einhverja hönnun-sjálfstæða virkni
- Extended kóða stöð
- Sem PHP handrit getur tappi hrint í framkvæmd nútíma forritunartækni, OOP til dæmis, en á sama tíma hefur það getu til að nota innfæddur WordPress aðgerðir, námskeið og API.
Óháð PHP erfðaskrá reynslu þína - þitt skrifaði sannarlega fyrsta tappi hennar eftir að hafa lokið "PHP for Dummies" bók - þú ert eitt lítið skref í burtu frá því að búa til fyrsta tappi fyrir WordPress. Við skulum taka þetta skref saman.
Helstu verkefni sem við ætlum að kanna í dag, er að byggja upp traustan tappa grunn. Þessi grundvöllur þarf að uppfylla kröfur WordPress og gera viðbótina auðkennd með kjarna. Á sama tíma ætti að fylgja almennum venjum og samningum, samþykkt af samfélaginu, til að forðast hugsanlegar átök við aðrar viðbætur sem gætu verið settar upp á vefsvæðinu.
Plugin nafn og skrár
Fyrst af öllu þarftu að tryggja að nafn tappi þíns sé einstakt. Jafnvel ef þú ert ekki að fara að gera verkið þitt opinberlega, þá verður þú að vera viss um að ekki sé hægt að eiga síðuna þína með því að nota tvo tappi með sama nafni. Einföld viðbótargögnum (og Google) leit er vinur þinn þegar þú forðast rangt val.
Til að auka líkurnar á að nafn sé einstakt búa margir forritarar við forskeyti vörumerkisins, sem er skammstöfun á nafn verktaki (eða gælunafn). Þetta forskeyti með stuttum tilvísun í nafn viðbótarinnar ætti síðan að vera notað alls staðar - í nöfn skrár, aðgerða, bekkja, breytur osfrv. Það hjálpar til við að forðast að nefna átök við aðra viðbætur, þemu og kjarna sjálfsins.
Við skulum byrja með dæmi. Við samþykkjum nafnið "Hello World Plugin" og til að auka líkurnar á að vera einstakt sem við notum "Super prefix" mitt breytt í skammstöfun "MSP". Sem gefur okkur hið raunverulega einstaka nafn "MSP Hello World Plugin"; að leita í gegnum viðbótargagnið staðfestir að enginn annar sé að nota það.
Næsta skref okkar er að búa til skrárnar. Það er mjög mælt með því að þú geymir þau í sérstakri möppu inni í hollur tappi möppu. Þessi mappa ætti að vera nefnd í samræmi við tappi sjálft, í tilfelli okkar gæti það verið 'msp-helloworld'. Mappan ætti að innihalda aðal viðbótaskrána með sama nafni: 'msp-helloworld.php'.
The WordPress Codex mælir einnig með að þú sért með readme.txt skrá. Þessi skrá inniheldur upplýsingar um viðbótina þína staðlað snið . Ef þú ert að fara að leggja inn tappi í WordPress repository er tilvist readme.txt skylt. En ekki hugsa um það sem byrði, það eru fullt af ávinningi að gera þetta.
Ef tappi þín átti að hafa margar skrár eða hlaða nokkrum eignum (myndir, css og js skrár), þá ættu þeir að vera skipulögð í undirmöppum. Rétt skráafélag er merki um faglegt starf. Þú getur treyst á eftirfarandi mynstur:
Tappi hausinn
Sérhver tappi ætti að hafa skylt haus . Það hjálpar WordPress að viðurkenna handritið sem gilt tappi og framleiða réttar upplýsingar á stjórnunarskjánum viðbætur.
Þessi haus er PHP athugasemd blokk staðsett efst á helstu tappi er skrá:
/*Plugin Name: MSP Hello WorldDescription: Create hello world messageVersion: 1.0Author: Author's nameAuthor URI: http://authorsite.com/Plugin URI: http://authorsite.com/msp-helloworld*/Upplýsingarnar í hausnum verða kynntar í röðinni sem samsvarandi tappi er á stjórnunarskjánum.
Röð línanna er ekki mikilvægt, en skráin þarf að vera í UTF-8 kóðun.
Athugaðu að það er mikilvægt að vera í samræmi við útgáfuarnúmerið sem þú hefur valið (tdxxx) fyrir WordPress uppfærsluna til að greina það rétt.
Leiðir til skráa
Svo langt höfum við búið til mismunandi skrár fyrir tappi okkar (í rétta undirmöppur), við þurfum nú að ákvarða rétta slóðir (eða vefslóðir) við þá innan viðbótarkóðans. Með hliðsjón af þeirri staðreynd að wp-innihaldsmappinn gæti verið fluttur frá sjálfgefna staðsetningu sinni, verður ljóst að leiðir til viðbótarskrár ættu ekki að vera harður dulmáli, heldur ætti að greina það.
WordPress hefur tvær aðgerðir, plugin_dir_path og plugin_dir_url til að takast á við málið, en við getum farið frekar með því að nota eftirfarandi bragð:
define('MSP_HELLOWORLD_DIR', plugin_dir_path(__FILE__));define('MSP_HELLOWORLD_URL', plugin_dir_url(__FILE__)); Með þessu litla stikli (innifalið í aðalforritaskránni) finnum við slóðina og slóðina í möppu tappi okkar í WordPress uppsetninguinni og gefur þeim viðeigandi stillingar. Eftir það getum við notað þessar stöðvar í sambandi við þekktar ættingjar leiðir til undirmöppur, til dæmis MSP_HELLOWORLD_DIR.'assets/img/image.jpg' .
Með því að nota þessa stöðugleika getum við einnig auðveldlega tekið í tappi skrár úr undirmöppum inni í aðalskránni:
function msp_helloworld_load(){if(is_admin()) //load admin files only in adminrequire_once(MSP_HELLOWORLD_DIR.'includes/admin.php');require_once(MSP_HELLOWORLD_DIR.'includes/core.php');}msp_helloworld_load();Plugin States
Eftir uppsetningu gæti tappi okkar verið í virku eða óvirku ástandi.
Virk ástand þýðir að það var virkjað af notandanum og kóðinn hans verður keyrður af WordPress í hvert skipti sem um er að ræða síðu.
Tappi gæti einnig verið óvirkt af notandanum sem þýðir að skrár eru geymdar á sínum stöðum, en kóðinn er ekki framkvæmdur.
(Tappi gæti líka verið alveg afnotað af notanda, sem þýðir að skrár eru eytt úr möppunni.)
WordPress getur grípa til breytinga á þessum ríkjum og framkvæma nokkur kóða sem er áætlað fyrir slíkar breytingar. Ef einhver kóði er áætlaður til að virkja eða slökkva á, verður það aðeins framkvæmt á þessu augnabliki, ekki á hverri síðu álag.
Til dæmis, ef tappi er ætlað að vinna með umritunarreglum ætti það að hreinsa þau við virkjun / afvirkjun. Ef tappi býr til nokkrar færslur í gagnagrunni, til dæmis með því að geyma valkosti, þá er heilbrigt starf að eyða þeim þegar tappi er fjarlægt.
Hvernig er hægt að gera það?
Til að virkja og aftengja aðgerðir getum við skráð svokölluð "virkjunarkrokka" og "afvirkjunarkrokka". Þeir eru bara stykki af kóða sem segir WordPress að framkvæma eina tiltekna virkni við virkjun og aðra tiltekna virkni við afvirkjun. Hér er dæmi um slíka kóða:
register_activation_hook(__FILE__, 'msp_helloworld_activation');register_deactivation_hook(__FILE__, 'msp_helloworld_deactivation');function msp_helloworld_activation() {//actions to perform once on plugin activation go here}function msp_helloworld_deactivation() {// actions to perform once on plugin deactivation go here}Til að fjarlægja aðgerðir höfum við tvo kosti.
Einn kostur er að búa til uninstall.php skrá í möppu tappans (ásamt helstu tappi skrá og readme.txt) og innihalda allar nauðsynlegar kóða þar. Ef uninstall.php er til staðar mun WordPress framkvæma það sjálfkrafa þegar notandinn hefur eytt tappi. Að öðrum kosti getum við skráð uninstall krók á næstum eins og við gerðum með virkjun og afvirkjun krókar. Erfiður hluti er að hringja í það einu sinni einu sinni á virkjun. Hér er dæmi:
register_activation_hook(__FILE__, 'msp_helloworld_activation');function msp_helloworld_activation() {//actions to perform once on plugin activation go here//register uninstallerregister_uninstall_hook(__FILE__, 'msp_helloworld_uninstall');}function msp_helloworld_uninstall(){//actions to perform once on plugin uninstall go here}Það er mikilvægt að vita að aðeins einn af þeim valkostum sem lýst er muni virka: Ef uninstall.php er til, þá verður það framkvæmt og allir uninstall krókur verða ekki rekinn.
Bestu venjur
Samantekt allt hér að ofan, hér er yfirlit um að skapa traustan grundvöll fyrir WordPress tappi:
- Finndu einstakt nafn
- Setja upp forskeyti (tengt vörumerkinu þínu)
- Búðu til möppu viðbótarins
- Búðu til undirmöppur fyrir PHP skrár, eignir og þýðingar
- Búðu til aðal viðbótaskrána og fylltu út upplýsingar um skylduupplýsingar
- Búðu til readme.txt skrá
- Notaðu rétta fasti og aðgerðir til að greina slóðir til viðbótarskráa
- Búðu til viðbótar PHP skrár og settu þau inn í aðalnafnið
- Búðu til virkjun og afvirkjun
- Búðu til uninstall handrit
Niðurstaða
Eftir öll þessi skref ertu tilbúinn til að gera tappi þína til að gera eitthvað með því að búa til kóðann. Við kynnumst nokkrar gagnlegar hugmyndir sem gera WordPress viðbætur spennandi og sveigjanleg í næstu grein þessari röð. En nokkur mikilvæg atriði má auðkenna núna:
- Aldrei þróast án kembiforrita. Það er nóg af upplýsingum um WordPress kembiforrit og ýmsar viðbætur til að fá auka tilkynningar. Þeir eru áreiðanlegar aðstoðarmenn þína á leiðinni til villa-frjáls og upp-til-dag kóðann.
- Forskeyti allt. Notaðu sérstakt forskeyti (venjulega nafnafleiðan frá viðbótinni) fyrir allar aðgerðir þínar, breytur, flokka osfrv. Til að tryggja að tappi sé samhæft við vinnu annarra vinnustjóra.
- Fylgja WordPress erfðaskrá staðla . Þessar staðlar eru reglur settar af kjarnahópnum fyrir alla WordPress kóða til að auðvelda að lesa og viðhalda. Eftirfarandi staðlar hjálpa til við að viðhalda samræmi kjarnakóðans innan tappa.
- Notaðu algerlega aðgerðir, API og flokka fyrir sameiginlegar verkefni. WordPress veitir verktaki mikið úrval af verkfærum fyrir algengar aðgerðir (eins og gagnvirk gagnvirking eða notendavottun), svo að þú getir einbeitt þér að virkilega einstaka virkni tappi þinnar.
- Skráðu kóðann þinn. Reyndar er ekki mikið að segja um þessa reglu - óháð þeim samningum sem notuð eru, bæði sem verktaki og við sem samfélag njóta góðs af vel skjalfestum kóða.
Ég vona að þessar inngangsupplýsingar hvetja þig til að byrja að þróa með WordPress. Horfðu á næstu hluti af röðinni í náinni framtíð.
Smelltu hér til að sækja "Hello World" tappi dæmi til að nota sem beinagrind til eigin þróunar.
Hvaða ráð gætir þú bætt við þessari kynningu? Hvað viltu sjá í næstu grein í röðinni? Láttu okkur vita í athugasemdum!