Skrivning af et simpelt WordPress-plugin, begyndervejledning

På lægmandssprog er et WordPress-plugin et simpelt program, der hjælper dig med at tilpasse og forbedre dit WordPress-websted uden at skulle redigere kerneprogrammeringen. Når du mestrer Udvikling af WordPress-plugin, vil du være i stand til at tilføje enhver form for funktionalitet til din WordPress-blog på kort tid. Men inden du bliver en proff, skal du lære rebene.


Et WordPress Plugin er et program eller et sæt af en eller flere funktioner, skrevet på PHP-scriptingsprog, der tilføjer et specifikt sæt funktioner eller tjenester til WordPress-webloggen, som kan integreres problemfrit med webloggen ved hjælp af adgangspunkter og metoder leveres af WordPress Plugin Application Program Interface (API). – Skrivning af et plugin, WordPress Codex

I dagens indlæg vil vi guide dig gennem processen med at oprette dit første WordPress-plugin. Vi vil holde tutorials enkel til at tage højde for den første gang udvikler, der har ringe eller ingen kendskab til PHP (scriptsproget bag WordPress).

Før vi går ned på faktisk kodning, vil vi imidlertid se på et par ting, du burde forstå om WordPress-pluginudvikling.

Grundlæggende at vide, inden du opretter et WordPress-plugin

I dette afsnit afslører vi første par trin du skal følge, når du opretter et WordPress-plugin. Derudover vil vi nævne alle de forskellige ting, du skal tage i betragtning, når du skriver dit plugin. Store. Lad os starte med det grundlæggende.

Sådan navngives et WordPress-plugin

Før alt andet skal du komme med et unikt navn på dit WordPress-plugin. En af de bedste måder at bestemme et gunstigt navn er at tænke på, hvad dit plugin vil gøre. Så hvis f.eks. Dit plugin hjælper folk med at dele indhold via sociale medier, kan du medtage udtrykket “deling af sociale medier” i navnet. En anden ting, plugin-navne kan være flere ord, så du skal ikke hakke kreativitet.

Dit plugin-navn skal være unikt for at undgå konflikter med andre plugins. For at sikre, at dit navn er unikt, kan du foretage en Google-søgning på navnet. Derudover kan du søge i de forskellige plugin-mapper, herunder WordPress-plugin-lager.

For at navngive ethvert plugin skal vi oprette mindst en plugin-fil (den vigtigste PHP-fil), som introducerer os til vores næste afsnit.

Sådan opretter du plugin-filer

Et plugin kan bestå af en enkelt PHP-fil eller flere filer, afhængigt af hvad det er designet til at gøre. Den vigtigste fil er den vigtigste PHP-fil, hvilket er ækvivalent med index.php og index.html i henholdsvis WordPress-temaer og HTML-design.

Det anbefales, at WordPress-udviklere navngiver deres vigtigste plugin-fil efter deres plugin efter konvention. For eksempel ville den vigtigste plugin-fil for et plugin kaldet WP Renym-plugin være wp-renym.php. Hvis du tilføjer en separator i dit navn, skal du kun bruge bindestreger (-) mellem ord i modsætning til understregninger (_).

Som nævnt ovenfor kan et plugin være lavet af en enkelt eller flere filer (billeder, JavaScript, sprog, CSS-filer osv.). Uanset hvad, skal dine plugin-filer leve i et enkelt bibliotek. Så for et plugin ved navn WP Renym the wp-renym.php filen vil blive placeret i en wp-renym folder. Yderligere undermapper kan tilføjes i hoved-plugin-mappen for at indeholde og organisere andre filer.

Når du har lagt al koden til et plugin, komprimerer du derefter din hovedmappe til en zip-fil (i dette tilfælde ville det være wp-renym.zip arkiv), der skal uploades og installeres på et WordPress-sted.

Føjelse af en filhoved til den vigtigste PHP-fil

Når du navngiver dit plugin, skal du tilføje andre detaljer såsom beskrivelse, version, licens, forfatternavn – dybest set alt, hvad der vises under og ved siden af ​​dit plugin i WordPress Plugins skærm – pluginhovedet. Til dette skal du bruge en standard plugin information header øverst på din vigtigste PHP-fil. Sådan ser en typisk header ud:


/ *
Plugin Navn: Navn på dit plugin
Plugin URI: http: // link til din plugins startside
Beskrivelse: Beskriv, hvad dit plugin handler om i nogle få korte sætninger
Version: 1.0
Forfatter: Dit navn (Yay! Her kommer berømmelse ...)
Forfatter URI: http: // link til dit websted
Licens: GPL2 osv
Licens URI: http: // link til din plugin-licens
* /

Hver parameter i overskriften ovenfor er selvforklarende, så jeg vil ikke gå nærmere ind på detaljerne. Bare sørg for at medtage det relevante http: // eller https: // når du skriver dine plugin- og forfatter-URI’er, eller linkene fungerer ikke.

Følg din overskrift med følgende licensoplysninger, hvis du bruger a GPL2-licens eller en licens kompatibel med GPL2:

/ * Copyright YEAR PLUGIN_AUTHOR_NAME (e-mail: din e-mail-adresse)
(Plugin Name) er gratis software: du kan omfordele det og / eller ændre
det under betingelserne i GNU General Public License, som offentliggjort af
Free Software Foundation, enten version 2 af licensen, eller
enhver senere version.

(Plugin Name) distribueres i håb om, at det vil være nyttigt,
men uden nogen garanti; uden endda den underforståede garanti af
SALGBARHED eller egnethed til et bestemt formål. Se
GNU General Public License for flere detaljer.

Du skulle have modtaget en kopi af GNU General Public License
sammen med (plugin-navn). Hvis ikke, se (http: // link til din plugin-licens).
* /

Omfanget af denne tutorial tillader os ikke at gå ud over disse grundlæggende trin. Du skal tjekke skriver et plugin vejledning i kodeksen for at lære mere om WordPress-plugin-kroge, skabelon-tags, gemme plugin-data til databaser, plugin-indstillingsmekanisme og opdatere dit plugin blandt andet. Codex inkluderer også en massiv Plugin-ressourcer samling, der er fuld af videoguider, avancerede emner og mere.

Nu hvor vi har dækket det grundlæggende, lad os skrive et simpelt WordPress-plugin, der udfører to basale (men pæne) funktioner:

  • Udskift ord i dit indhold med dit eget valg af ord
  • Tilføj en “tak, fordi du læser denne tutorial …” -notat i slutningen af ​​hvert blogindlæg.

Hvordan man skriver et simpelt WordPress-plugin – WP Renym

I dette afsnit skriver vi kode til WP Renym-pluginet, som jeg har nævnt hele tiden.

Hvad du har brug for:

Navngivning af vores plugin

Først kontrollerede vi WordPress-plugin-lageret og foretog en Google-søgning på vores navn; WP Renym var fri. Mit oprindelige valg var WP Rename, men det var allerede taget.

Gå videre … Åbn en ny fil i din kodeditor, og tilføj følgende kode øverst, når du har åbnet dit plugin med :

/ *
Plugin Navn: WP Renym
Plugin URI: http: // link til din plugins startside
Beskrivelse: Dette plugin erstatter ord med dit eget valg af ord.
Version: 1.0
Forfatter: Freddy Muriuki
Forfatter URI: http: // link til dit websted
Licens: GPL2 osv
Licens URI: https: // link til din plugin-licens

Copyright YEAR PLUGIN_AUTHOR_NAME (e-mail: din e-mail-adresse)
(Plugin Name) er gratis software: du kan omfordele det og / eller ændre
det under betingelserne i GNU General Public License, som offentliggjort af
Free Software Foundation, enten version 2 af licensen, eller
enhver senere version.

(Plugin Name) distribueres i håb om, at det vil være nyttigt,
men uden nogen garanti; uden endda den underforståede garanti af
SALGBARHED eller egnethed til et bestemt formål. Se
GNU General Public License for flere detaljer.

Du skulle have modtaget en kopi af GNU General Public License
sammen med (plugin-navn). Hvis ikke, se (http: // link til din plugin-licens).
* /

Gem filen som wp-renym.php i wp-renym-mappen. Hvis du ikke allerede har mappen, skal du oprette den. wp-renym.php vil være din vigtigste PHP-fil.

Tilføjelse af funktioner

Nu for at tilføje de faktiske funktioner til plugin. Lige under koden ovenfor, tilføj følgende funktion til at rette stavefejl af wordpress til WordPress:

funktion 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 unikke navn, vi har givet vores funktion. Når du tilføjer nye funktioner, start dem aldrig med wp_ – dette for at forhindre fremtidige uforeneligheder med WordPress-kodefunktioner, som alle bruger præfikset wp_.

Vores PHP-funktion tager ($ tekst) som argumentet og returnerer den første streng ‘wordpress’ erstattet med den anden streng ‘WordPress’.

Vi har tilføjet et filter (add_filter) til vores plugin for at fortælle vores funktion ( renym_wordpress_typo_fix ) for at arbejde på den tekst, vi har valgt, som i dette tilfælde er hele indholdet af indlæg (indholdet).

Hvis du vil erstatte mere end et ord (måske du gerne vil redigere flere ord på tværs af din blog eller bruge plugin som et simpelt bande-filter), skal du erstatte ovenstående kode med følgende kode:

funktion renym_content_replace ($ indhold) {
$ search = array ('wordpress', 'ged', 'Easter', '70', 'sensational');
$ erstatte = matrix ('WordPress', 'kaffe', 'påskeferie', 'halvfjerds', 'ekstraordinær');
return str_replace ($ søgning, $ erstatte, $ indhold);
}
add_filter ('the_content', 'renym_content_replace');

I vores kode ovenfor har vi allerede valgt de ord, der skal erstattes f.eks. wordpress, ged, påske osv. Vi har også valgt erstatningsord f.eks. WordPress, kaffe, påskeferie osv. Forhåbentlig er koden noget selvforklarende:

  • Det renym_content_replace funktionen tager ($ indhold) som argumentet, erstatter alle de ord, der findes i $ søgeopstillingen og returnerer de nu ændrede ord til WordPress.
  • $ søgning indeholder alle de ord, der skal udskiftes
  • $ erstatte indeholder erstatningsordene
  • str_replace gør, hvad det gør bedst, og erstatter ord med de nye ord

Bemærk, hvordan vi tilføjer præfikset renym til hver funktion. Dette forhindrer konflikter med andre plugins, der muligvis er installeret. Du skal komme ind i vanen med at tilføje præfikser til dine funktioner, uanset om du udvikler plugins, temaer eller widgets.

Hvis du har afsluttet ovenstående trin, kan dit plugin erstatte alle dine valgte ord effektivt. Lad os nu tilføje “Tak, fordi du læser denne tutorial …” note, der vises nederst i hvert indlæg. Føj følgende kode til din vigtigste plugin-fil ( renym_content_replace ) før den lukkende PHP-beslag ( ?> ) Der kommer i den sidste linje:

funktion renym_content_footer_note ($ indhold) {
$ indhold. = '
Tak, fordi du læser denne tutorial. Måske næste gang jeg lader dig købe en kop kaffe! Besøg vores blog for flere WordPress-tutorials
'; returnere $ indhold; } add_filter ('the_content', 'renym_content_footer_note');

Gem ændringerne. Det renym_content_footer_note -funktionen tilføjer HTML-markeringen til $ content-parameteren og returnerer den nye værdi til WordPress. Vi har også tilføjet en sidefodsklasse til vores tekst, så den let kan styles senere.

Vi har inkluderet et filter (add_filter), der fortæller vores funktion til at fungere på den tekst, vi har valgt, som er indholdet af indlæg som repræsenteret af_indholdet.

Komprimere din mappe

På dette tidspunkt, din finale wp-renym.php filen skal se sådan ud:

Tak, fordi du læser denne tutorial. Måske næste gang jeg lader dig købe en kop kaffe! Besøg vores blog for flere WordPress-tutorials';
returnere $ indhold;
}
add_filter ('the_content', 'renym_content_footer_note');

?>

Gem alle dine ændringer. Komprimerer WP Renym-mappen i en wp-renym.zip arkiv (på en Mac er det så let som højreklik, komprimeringsfil – og på pc tror jeg, det er meget ens). Bare sørg for, at din fil gemmes som en .ZIP-udvidelse, eller at plugin ikke installeres.

Brug dit plugin

Upload og aktiver dit nye WP Renym-plugin via WordPress Plugins skærm. Tillykke med at skrive dit første plugin!

Installer Renym WordPress-plugin

Ressourcer

Hvis du vil lære mere om WordPress-pluginudvikling, skal du tjekke følgende ressourcer:

Konklusion

Jeg håber, at denne tutorial pegede dig i den rigtige retning, så vidt forståelse af plugins går. Dette indlæg skal fungere som et springbræt for at udvikle komplekse WordPress-plugins, der gør hvad du vil. Stop ikke her, tjek de ressourcer, jeg anbefalede ovenfor for at øge din viden om WordPress-pluginudvikling.

Hvis du fandt, at denne tutorial var nyttig, eller hvis du har noget andet at tilføje, ville vi meget gerne vide det. Del dine tanker i kommentarfeltet nedenfor. Ser dig omkring ��

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