Verktøykasse av Smart WordPress Utvikler The WordPress Plugin Boilerplate

Visste du at du faktisk kan forårsake døden ved å skrive et WordPress-plugin? Det er sant: Hvis du lager et plugin som er dårlig kodet nok til å forårsake et sikkerhetsproblem, og si at noen hacker nettsiden til et lite land med en diktatorisk regel, kan noen hodene rulle.

Selv om det er en liten sjanse og ikke rapportert å være sant (enda), er det faktisk en gyldig grunn for deg å skrive bedre plugins. Og i denne delen av "Toolbox of the Smart WordPress Developer" -serien, skal vi lagre noen liv ved å gå gjennom WordPress Plugin Boilerplate.

Skriver plugins i WordPress

Hva er det viktigste supermakt av WordPress? Jeg har spurt og besvart dette spørsmålet mer enn noen få ganger i mine opplæringsprogrammer, men du kjenner kanskje allerede svaret: utvidbarhet.

En måte å utnytte denne kraften på er å lage WordPress-plugins og sette dem i bruk for samfunnet. Du kan slippe et plugin på GitHub, i WordPress Plugin Repository, på CodeCanyon, eller på ditt eget nettsted. Du kan gi det gratis, eller be om penger eller donasjoner.

I alle fall vil du utvide funksjonaliteten til WordPress på en eller annen måte og på dine egne betingelser. Du er en del av WordPress-fellesskapet, og du lar samfunnet vokse ved å utvide WordPress. Hvor kult er det? Dette er faktisk den viktigste supermakt i WordPress, og du har lov til å bruke den.

Men du må også minne deg på det med stor makt kommer stort ansvar. Du må bruke denne kraften for godt, og bruk den godt. Ved å lage dårlig skrevet WordPress-plugins kan du forårsake noen virkelig dårlige ting, spesielt når det gjelder sikkerhet. Det er derfor du trenger å handle forsiktig og lage godt kodede plugins med et solid fundament.

Mens det ikke løser alle dine kodingsproblemer, vil WordPress Plugin Boilerplate hjelpe deg med å starte på høyre fot ved å gi det "solide fundamentet" og veilede deg til å kode bedre.

WordPress Plugin Boilerplate til redning!

Tilbake i desember 2011 lanserte Tom McFarlin, redaktør av Tuts + Code, den første versjonen av WordPress Plugin Boilerplate. I løpet av tre år har prosjektet blitt overvåket av over 250 personer, gaffelt nesten 700 ganger, og fikk over 2.700 stjerner på GitHub.

I mars 2015 annonserte Tom at Devin Vinson hadde overtatt eierskapet til WordPress Plugin Boilerplate-prosjektet. I dag er prosjektets GitHub-depot vert i Devins konto.

Hva er WordPress Plugin Boilerplate og hvorfor skal vi bruke dette verktøyet?

På WordPress Plugin Boilerplate hjemmeside er prosjektet definert som "et standardisert, organisert, objektorientert grunnlag for å bygge WordPress plugins av høy kvalitet".

I utgangspunktet er WordPress Plugin Boilerplate et av de beste verktøyene rundt for å starte et nytt WordPress-plugin med et solid fundament. Den gir den nødvendige filen og mappestrukturen for å holde orden, og ved å bruke startkodene i filene, kan du optimalisere arbeidsflyten din og skrive plugin den riktige måten.

Bruke WordPress Plugin Boilerplate

Gitt, dette verktøyet er ikke for WordPress nybegynnere. Men du trenger ikke å være en WordPress-guru heller: Selv om du har en grunnleggende forståelse av WordPress plugin-utvikling, vil WordPress Plugin Boilerplate være et lettforståelig verktøy for å lage bedre WordPress-plugins.

Starte et WordPress-pluginprosjekt med WordPress Plugin Boilerplate er ganske grei, faktisk. I begynnelsen er alt du trenger å gjøre, å endre plugin-navn mappe til pluginens navn og redigere alle filer (PHP, JS, CSS-filer og bilder) for å endre "boilerplate values" til dine egne plugin-verdier.

Du vil legge merke til at det er ganske mange filer å jobbe med, og mange deler å redigere selv før du skriver din egen kode. Ikke la dette sette deg av - det er jo bare en gangs ting.

La oss raskt gå over noen av filene og mappene:

  • plugin-navn / admin /: Inkluderer CSS-filer, JS-filer, partials og PHP-filen for en admin-spesifikk klasse (klasse-plugin-navn-admin.php).
  • plugin-navn / includes /: Denne mappen er en slags "ryggrad" av pluginet ditt. Det består av:
    • plugin-navn / includes / class-plugin-name.php: Den viktigste PHP-klassen av pluginet ditt.
    • plugin-navn / includes / class-plugin-navn-activator.php: Inkluderer pluginaktiveringsfunksjonene.
    • plugin-navn / includes / class-plugin-navn-deactivator.php: Inkluderer deaktiveringsfunksjonene for plugin.
    • plugin-navn / includes / class-plugin-navn-i18n.php: Inkluderer internasjonaliseringsfunksjonaliteten.
    • plugin-navn / includes / class-plugin-navn-loader.php: Inkluderer handlinger og filtre for pluginet ditt.
  • plugin-navn / språk /: Denne mappen inneholder pluginens språkfiler. Inkluderer en standard plugin-name.pot fil.
  • plugin-navn / offentlig /: Inkluderer CSS-filer, JS-filer, partials og PHP-filen for en offentlig-vendt funksjonalitet (klasse-plugin-navn-admin.php).
  • plugin-navn / LICENSE.txt: En kopi av GPL-2 lisensen.
  • plugin-navn / plugin-name.php: Hovedpluginfilen.
  • plugin-navn / README.txt: En standard README-fil for plugin-modulen din. Ikke glem å endre denne!
  • plugin-navn / uninstall.php: Fil som skal kjøres når brukeren sletter pluginet ditt.

Vær oppmerksom på at mappestrukturen er basert på systemet til WordPress.org Plugin Repository.

Raskt tips: Ved hjelp av WordPress Plugin Boilerplate Generator verktøyet, kan du generere en tilpasset kopi. Du oppgir navnet på ditt plugin, slug, nettside og navn, e-postadresse og nettside; deretter erstatter verktøyet alle tilsvarende verdier i kjelepapelfilene. Ryddig!

For å konkludere

Den WordPress Plugin Boilerplate sikkert er et flott verktøy (selv det beste verktøyet, kanskje) for å skape bedre WordPress plugins. Men som jeg sa i begynnelsen av denne artikkelen, er det ikke nok. Du må være oppmerksom på WordPress Coding Standards, overholde prosessprosjektene for plugin, og være opptatt av sikkerhetsproblemer generelt. Og hvis du vil lære mer om å skrive bedre plugins, må du sjekke ut "Introduksjon til WordPress Plugin Development" -kursus, også skapt av Tom McFarlin.

Hva synes du om WordPress Plugin Boilerplate, og gjør plugins med den? Del dine tanker med oss ​​ved å legge ut i kommentarfeltet nedenfor. Og hvis du likte opplæringen, må du dele den med vennene dine!

Vi ser deg i neste del der vi snakker om Envato WordPress Toolkit, et verktøy for å installere og oppdatere temaer kjøpt fra ThemeForest.