Å skrive en enkel WordPress-plugin, opplæring for nybegynnere

På lekmannsspråk er en WordPress-plugin et enkelt program som hjelper deg å tilpasse og forbedre WordPress-nettstedet ditt uten å måtte redigere kjerneprogrammeringen. Når du mestrer Utvikling av WordPress-plugin, vil du kunne legge til all slags funksjonalitet til WordPress-bloggen din på kort tid. Men før du blir proff, må du lære tauene.


Et WordPress Plugin er et program, eller et sett med en eller flere funksjoner, skrevet på PHP-skriptspråk, som tilfører et spesifikt sett med funksjoner eller tjenester til WordPress-webloggen, som sømløst kan integreres med webloggen ved å bruke tilgangspunkter og metoder levert av WordPress Plugin Application Program Interface (API). – Skrive en plugin, WordPress Codex

I dagens innlegg vil vi guide deg gjennom prosessen med å lage din første WordPress-plugin. Vi vil holde opplæringen enkel å imøtekomme for første gangs utvikler som har liten eller ingen kunnskap om PHP (skriptspråket bak WordPress).

Før du går ned på faktisk koding, vil vi imidlertid se på noen få ting du burde forstå om WordPress-plugin-utvikling.

Grunnleggende å vite før du oppretter et WordPress-plugin

I denne delen vil vi avsløre første trinn du må følge når du oppretter en WordPress-plugin. I tillegg vil vi nevne alle de forskjellige tingene du trenger å ta i betraktning når du skriver pluginen. Flott. La oss begynne med det grunnleggende.

Hvordan navngi et WordPress-plugin

Før alt annet, må du komme med et unikt navn på WordPress-plugin-en din. En av de beste måtene å finne et gunstig navn på er å tenke på hva pluginen din vil gjøre. Så hvis for eksempel plugin-en din vil hjelpe folk med å dele innhold via sosiale medier, kan du inkludere uttrykket “deling av sosiale medier” i navnet. En annen ting, plugin-navn kan være flere ord, så ikke hakk kreativitet.

Plugin-navnet ditt må være unikt for å unngå konflikter med andre plugins. For å sikre at navnet ditt er unikt, kan du gjøre et Google-søk på navnet. I tillegg kan du søke i forskjellige plugin-kataloger, inkludert WordPress plugin repository.

For å navngi en plugin, må vi opprette minst en plugin-fil (hoved PHP-filen), som introduserer oss til vår neste seksjon.

Hvordan lage plugin-filer

En plugin kan bestå av en enkelt PHP-fil eller flere filer, avhengig av hva den er designet for å gjøre. Den viktigste filen er den viktigste PHP-fil, som tilsvarer index.php og index.html i WordPress-temaer og HTML-design.

Det anbefales at WordPress-utviklere navngir sin viktigste plugin-fil etter plugin-en etter avtale. For eksempel vil hovedtilleggsfilen for en plugin som heter WP Renym-plugin være wp-renym.php. Hvis du legger til en separator i navnet ditt, bruker du bare bindestrek (-) mellom ord i motsetning til understrekinger (_).

Som nevnt over, kan en plugin være laget av en eller flere filer (bilder, JavaScript, språk, CSS filer osv.). Uansett må pluginfilene dine leve i en enkelt katalog. Så for en plugins som heter WP Renym the wp-renym.php filen vil bli plassert i en wp-renym mappe. Ytterligere undermapper kan legges i hoved-plugin-mappen for å inneholde og organisere andre filer.

Etter at du har lagt ned all koden for et plugin, komprimerer du deretter hovedmappen til en zip-fil (i dette tilfellet vil det være wp-renym.zip-arkivet) som skal lastes opp og installeres på et WordPress-nettsted.

Legge til en filhode til PHP-filen

Når du navngir plugin-modulen din, bør du legge til andre detaljer som beskrivelse, versjon, lisens, forfatternavn – i utgangspunktet alt som vil vises under og ved siden av plugin-programmet WordPress Plugins-skjerm – plugin-overskriften. For dette må du bruke a standard plugin-informasjonshode øverst i PHP-filen. Slik ser en typisk topptekst ut:


/ *
Plugin Name: Navnet på plugin-modulen
Plugin URI: http: // lenke til plugins hjemmesiden
Beskrivelse: Beskriv hva pluginen din handler om i noen få korte setninger
Versjon: 1.0
Forfatter: Navnet ditt (Yay! Here kommer berømmelse ...)
Forfatter URI: http: // lenke til nettstedet ditt
Lisens: GPL2 osv
Lisens URI: http: // lenke til plugin-lisensen din
* /

Hver parameter i overskriften ovenfor er selvforklarende, så jeg vil ikke gå inn på detaljene. Bare sørg for at du inkluderer det aktuelle http: // eller https: // når du skriver URI-kodene for plugin- og forfattere, eller koblingene fungerer ikke.

Følg overskriften med følgende lisensinformasjon hvis du bruker a GPL2 lisens eller en lisens kompatibel med GPL2:

/ * Copyright YEAR PLUGIN_AUTHOR_NAME (e-post: e-postadressen din)
(Plugin Name) er gratis programvare: du kan distribuere det og / eller endre
den under betingelsene i GNU General Public License som publisert av
Free Software Foundation, enten versjon 2 av lisensen, eller
enhver senere versjon.

(Plugin Name) distribueres i håp om at det vil være nyttig,
men UTEN NOEN GARANTI; uten engang den underforståtte garantien fra
MERCHANTABILITY eller EGNETHET FOR ET SÆRLIGT FORMÅL. Se
GNU General Public License for mer informasjon.

Du burde ha mottatt en kopi av GNU General Public License
sammen med (Plugin Name). Hvis ikke, se (http: // link til din plugin-lisens).
* /

Omfanget av denne opplæringen tillater oss ikke å gå utover disse grunnleggende trinnene. Du må sjekke ut skriver en plugin guide i kodeksen for å lære mer om WordPress-plugin-kroker, malkoder, lagre plugin-data i databaser, plugin-alternativmekanisme og oppdatere plugin-en din blant annet. Codex inkluderer også en massiv Plugin-ressurser samling som er full av videoguider, avanserte emner og mer.

Nå som vi har dekket det grunnleggende, la oss skrive en enkel WordPress-plugin som vil utføre to grunnleggende (men nifty) funksjoner:

  • Bytt ut ord i innholdet med ditt eget valg av ord
  • Legg til et “Takk for at du har lest denne opplæringen …” -notatet på slutten av hvert blogginnlegg.

Hvordan skrive en enkel WordPress-plugin – WP Renym

I denne delen vil vi skrive kode for WP Renym-pluginen jeg har nevnt hele tiden.

Hva trenger du:

Navngi Plugin vår

Først sjekket vi WordPress-plugin-repository og gjorde et Google-søk på navnet vårt; WP Renym var gratis. Mitt første valg var WP Rename, men det var allerede tatt.

Gå videre … Åpne en ny fil i koderedigereren, og legg til følgende kode øverst etter at du har åpnet plugin-modulen din :

/ *
Plugin Navn: WP Renym
Plugin URI: http: // lenke til plugins hjemmesiden
Beskrivelse: Denne pluginen erstatter ord med ditt eget valg av ord.
Versjon: 1.0
Forfatter: Freddy Muriuki
Forfatter URI: http: // lenke til nettstedet ditt
Lisens: GPL2 osv
Lisens URI: https: // lenke til plugin-lisensen din

Copyright YEAR PLUGIN_AUTHOR_NAME (e-post: e-postadressen din)
(Plugin Name) er gratis programvare: du kan distribuere det og / eller endre
den under betingelsene i GNU General Public License som publisert av
Free Software Foundation, enten versjon 2 av lisensen, eller
enhver senere versjon.

(Plugin Name) distribueres i håp om at det vil være nyttig,
men UTEN NOEN GARANTI; uten engang den underforståtte garantien fra
MERCHANTABILITY eller EGNETHET FOR ET SÆRLIGT FORMÅL. Se
GNU General Public License for mer informasjon.

Du burde ha mottatt en kopi av GNU General Public License
sammen med (Plugin Name). Hvis ikke, se (http: // link til din plugin-lisens).
* /

Lagre filen som wp-renym.php i wp-renym-mappen. Hvis du ikke allerede har mappen, oppretter du den. wp-renym.php vil være din viktigste PHP-fil.

Legge til funksjoner

Nå for å legge til de faktiske funksjonene i pluginen. Bare under koden over, legg til følgende funksjon for å rette stavefeil av wordpress til WordPress:

funksjon renym_wordpress_typo_fix ($ tekst) {
return str_replace ('wordpress', 'WordPress', $ text);
}
add_filter ('the_content', 'renym_wordpress_typo_fix');

renym_wordpress_typo_fix er det unike navnet vi har gitt vår funksjon. Når du legger til nye funksjoner, må du aldri starte dem med wp_ – dette for å forhindre fremtidig inkompatibilitet med WordPress-kodefunksjoner som alle bruker prefikset wp_.

PHP-funksjonen vår tar ($ tekst) som argumentet, og returnerer den første strengen ‘wordpress’ erstattet med den andre strengen ‘WordPress’.

Vi har lagt til et filter (add_filter) i pluginen vår for å fortelle vår funksjon ( renym_wordpress_typo_fix ) for å jobbe med teksten vi har valgt, som i dette tilfellet er hele innleggets innhold (innholdet).

Hvis du vil erstatte mer enn ett ord (kanskje du ønsker å redigere flere ord i bloggen din eller bruke plugin-modulen som et enkelt banning-filter), erstatter du koden ovenfor med følgende kode:

funksjon renym_content_replace ($ innhold) {
$ search = array ('wordpress', 'geit', 'Easter', '70', 'sensational');
$ erstatte = matrise ('WordPress', 'kaffe', 'påskeferie', 'sytti', 'ekstraordinær');
return str_replace ($ search, $ erstatte, $ content);
}
add_filter ('the_content', 'renym_content_replace');

I koden over har vi allerede valgt ordene som skal erstattes, f.eks. wordpress, geit, Easter, etc. Vi har også valgt erstatningsordene f.eks. WordPress, kaffe, påskeferie osv. Forhåpentligvis er koden noe selvforklarende:

  • De renym_content_replace -funksjonen tar ($ innhold) som argument, erstatter alle ordene i $ -søk-arrayen og returnerer de nå endrede ordene til WordPress.
  • $ søk inneholder alle ordene som skal erstattes
  • $ erstatte inneholder erstatningsordene
  • str_replace gjør det den gjør best, og erstatter ord med de nye ordene

Legg merke til hvordan vi legger til prefikset renym til hver funksjon. Dette forhindrer konflikter med andre plugins som kan installeres. Du bør sette deg inn i vanen med å legge prefikser til funksjonene dine, uansett om du utvikler plugins, temaer eller widgeter.

Hvis du har fullført trinnene ovenfor, kan pluginen erstatte alle de valgte ordene dine effektivt. La oss nå legge til “Takk for at du har lest denne opplæringen …” -notatet som vises nederst i hvert innlegg. Legg til følgende kode i hovedtilleggsfilen din ( renym_content_replace ) før den lukkende PHP-braketten ( ?> ) Som kommer i den siste linjen:

funksjon renym_content_footer_note ($ content) {
$ innhold. = '
Takk for at du leser denne opplæringen. Kanskje neste gang jeg lar deg kjøpe meg en kaffe! For mer WordPress-veiledninger, besøk vår blogg
'; returner $ innhold; } add_filter ('the_content', 'renym_content_footer_note');

Lagre endringene. De renym_content_footer_note -funksjonen legger HTML-markeringen til $ content-parameteren og returnerer den nye verdien til WordPress. Vi har også lagt til en bunntekstklasse til teksten vår, slik at den lett kan styles senere.

Vi har tatt med et filter (add_filter) som forteller at vår funksjon skal fungere på teksten vi har valgt, som er innleggets innhold som representert av_kontinen.

Komprimer mappen

På dette tidspunktet, finalen din wp-renym.php filen skal se slik ut:

Takk for at du leser denne opplæringen. Kanskje neste gang jeg lar deg kjøpe meg en kaffe! For mer WordPress-veiledninger, besøk vår blogg';
returner $ innhold;
}
add_filter ('the_content', 'renym_content_footer_note');

?>

Lagre alle endringene dine. Komprimerer WP Renym-mappen til en wp-renym.zip arkiv (på en Mac er det like enkelt som å høyreklikke, komprimere fil – og på PC tror jeg at den er veldig lik). Bare sørg for at filen lagres som en .ZIP-utvidelse, eller at plugin-en ikke installeres.

Bruk plugin-modulen din

Last opp og aktiver din nye WP Renym-plugin via WordPress Plugins-skjerm. Gratulerer med å skrive din første plugin!

Installer Renym WordPress Plugin

ressurser

For å lære mer om WordPress-plugin-utvikling, vennligst sjekk ut følgende ressurser:

Konklusjon

Jeg håper denne opplæringen pekte deg i riktig retning så langt forståelsen av plugins går. Dette innlegget skal fungere som et springbrett for å utvikle komplekse WordPress-plugins som gjør hva du vil. Ikke stopp her, sjekk ressursene jeg anbefalte ovenfor for å øke kunnskapen din om WordPress-plugin-utvikling.

Hvis du synes denne opplæringen var nyttig, eller hvis du har noe annet å legge til, vil vi gjerne vite det. Del tankene dine i kommentarfeltet nedenfor. Ser deg rundt ��

Jeffrey Wilson Administrator
Sorry! The Author has not filled his profile.
follow me
    Like this post? Please share to your friends:
    Adblock
    detector
    map