Att skriva ett enkelt WordPress-plugin, nybörjarhandledning

På lekmänsspråk är ett WordPress-plugin ett enkelt program som hjälper dig att anpassa och förbättra din WordPress-webbplats utan att behöva redigera kärnprogrammeringen. När du behärskar Utveckling av WordPress-plugin, kommer du att kunna lägga till all slags funktionalitet till din WordPress-blogg på nolltid. Men innan du blir proffs måste du lära dig repen.


Ett WordPress-plugin är ett program, eller en uppsättning av en eller flera funktioner, skrivna på PHP-skriptspråk, som lägger till en specifik uppsättning funktioner eller tjänster till WordPress-webloggen, som sömlöst kan integreras med webloggen med hjälp av åtkomstpunkter och metoder tillhandahålls av WordPress Plugin Application Program Interface (API). – Att skriva ett plugin, WordPress Codex

I dagens inlägg guidar vi dig genom processen att skapa ditt första WordPress-plugin. Vi kommer att hålla lektionen enkel att ta hand om för första gången utvecklare som har liten eller ingen kunskap om PHP (skriptspråket bakom WordPress).

Innan vi går ner till faktisk kodning kommer vi dock att titta på några saker du borde förstå om WordPress-pluginutveckling.

Grunder att veta innan du skapar ett WordPress-plugin

I det här avsnittet kommer vi att avslöja första stegen du måste följa när du skapar ett WordPress-plugin. Dessutom kommer vi att nämna alla olika saker du behöver ta hänsyn till när du skriver din plugin. Bra. Låt oss börja med grunderna.

Hur man namnger ett WordPress-plugin

Innan allt annat måste du ta fram ett unikt namn för din WordPress-plugin. Ett av de bästa sätten att bestämma ett gynnsamt namn är att tänka på vad din plugin kommer att göra. Så, till exempel, om din plugin hjälper människor att dela innehåll via sociala medier, kan du inkludera frasen “social media sharing” i namnet. En annan sak, plugin-namnen kan vara flera ord, så hacka inte kreativiteten.

Ditt plugin-namn måste vara unikt för att undvika konflikter med andra plugins. För att säkerställa att ditt namn är unikt kan du göra en Google-sökning på namnet. Dessutom kan du söka i de olika plugin-katalogerna inklusive WordPress-plugin-arkiv.

För att namnge något plugin måste vi skapa minst en plugin-fil (huvud PHP-filen), som introducerar oss till nästa avsnitt.

Hur man skapar plugin-filer

En plugin kan bestå av en enda PHP-fil eller flera filer beroende på vad den är utformad för att göra. Den viktigaste filen är den viktigaste PHP-fil, vilket motsvarar index.php och index.html i WordPress-teman respektive HTML-design.

Det rekommenderas att WordPress-utvecklare namnger sin huvudsakliga plugin-fil efter deras plugin enligt konvention. Till exempel skulle huvudpluginfilen för ett plugin som heter WP Renym-plugin vara wp-renym.php. Om du lägger till en separator i ditt namn, använd bara bindestreck (-) mellan ord i motsats till understreck (_).

Som nämnts ovan kan ett plugin göras av en enda eller flera filer (bilder, JavaScript, språk, CSS-filer etc). Hursomhelst måste dina plugin-filer lever i en enda katalog. Så för en plugin som heter WP Renym the wp-renym.php filen skulle placeras i en wp-renym mapp. Ytterligare undermappar kan läggas till i huvudpluginmappen för att innehålla och organisera andra filer.

När du har lagt ner all kod för ett plugin komprimerar du sedan din huvudmapp till en zip-fil (i detta fall skulle det vara wp-renym.zip-arkivet) som ska laddas upp och installeras på en WordPress-webbplats.

Lägga till en filhuvud till PHP-filen

När du namnger ditt plugin bör du lägga till andra detaljer som beskrivning, version, licens, författarnamn – i princip allt som kommer att visas under och bredvid din plugin i WordPress Plugins-skärm – pluginhuvudet. För detta måste du använda a standard plugin informationsrubrik högst upp i din huvudsakliga PHP-fil. Så här ser en typisk rubrik ut:


/ *
Plugin Name: Namnet på din plugin
Plugin URI: http: // länk till din plugins hemsida
Beskrivning: Beskriv vad din plugin handlar om i några korta meningar
Version: 1.0
Författare: Ditt namn (Yay! Här kommer berömmelse ...)
Författare URI: http: // länk till din webbplats
Licens: GPL2 osv
Licens URI: http: // länk till din plugin-licens
* /

Varje parameter i rubriken ovan är självförklarande så jag kommer inte gå in på detaljerna. Se bara till att du inkluderar det relevanta http: // eller https: // när du skriver dina plugin- och författar-URI: ar eller länkarna fungerar inte.

Följ din rubrik med följande licensinformation om du använder a GPL2-licens eller en licens kompatibel med GPL2:

/ * Copyright YEAR PLUGIN_AUTHOR_NAME (e-post: din e-postadress)
(Plugin Name) är gratis programvara: du kan omfördela det och / eller ändra
det enligt villkoren i GNU General Public License som publiceras av
Free Software Foundation, antingen version 2 av licensen, eller
någon senare version.

(Plugin Name) distribueras i hopp om att det kommer att vara användbart,
men UTAN NÅGON GARANTI; utan ens den underförstådda garantin från
FÖRSÄLJNINGS- OCH FITNESS FÖR EN SÄRSKILT SYFTE. Se
GNU General Public License för mer information.

Du borde ha fått en kopia av GNU General Public License
tillsammans med (plugin-namn). Om inte, se (http: // länk till din plugin-licens).
* /

Omfattningen av denna handledning tillåter oss inte att gå längre än dessa grundläggande steg. Du måste kolla in skriver ett plugin guide i kodxen för att lära dig mer om WordPress-pluginhakar, malltaggar, spara plugin-data i databaser, pluginalternativmekanism och uppdatera din plugin bland annat. Koden innehåller också en massiv Plugin-resurser samling som är full av videoguider, avancerade ämnen och mer.

Nu när vi har täckt grunderna, låt oss skriva ett enkelt WordPress-plugin som kommer att utföra två grundläggande (men snygga) funktioner:

  • Byt ut ord i ditt innehåll med ditt eget val av ord
  • Lägg till en “tack för att du har läst den här tutorialen …” i slutet av varje blogginlägg.

Hur man skriver ett enkelt WordPress-plugin – WP Renym

I det här avsnittet kommer vi att skriva kod för WP Renym-plugin som jag har nämnt hela tiden.

Vad du behöver:

Namnge vår plugin

Först kontrollerade vi WordPress-pluginförvaret och gjorde en Google-sökning på vårt namn; WP Renym var gratis. Mitt första val var WP Rename men det hade redan tagits.

Gå vidare … Öppna en ny fil i din kodredigerare och lägg till följande kod överst efter att du har öppnat din plugin med :

/ *
Plugin Namn: WP Renym
Plugin URI: http: // länk till din plugins hemsida
Beskrivning: Denna plugin ersätter ord med ditt eget val av ord.
Version: 1.0
Författare: Freddy Muriuki
Författare URI: http: // länk till din webbplats
Licens: GPL2 osv
Licens URI: https: // länk till din plugin-licens

Copyright YEAR PLUGIN_AUTHOR_NAME (e-post: din e-postadress)
(Plugin Name) är gratis programvara: du kan omfördela det och / eller ändra
det enligt villkoren i GNU General Public License som publiceras av
Free Software Foundation, antingen version 2 av licensen, eller
någon senare version.

(Plugin Name) distribueras i hopp om att det kommer att vara användbart,
men UTAN NÅGON GARANTI; utan ens den underförstådda garantin från
FÖRSÄLJNINGS- OCH FITNESS FÖR EN SÄRSKILT SYFTE. Se
GNU General Public License för mer information.

Du borde ha fått en kopia av GNU General Public License
tillsammans med (plugin-namn). Om inte, se (http: // länk till din plugin-licens).
* /

Spara filen som wp-renym.php i wp-renym-mappen. Om du inte redan har mappen skapar du den. wp-renym.php kommer att vara din huvudsakliga PHP-fil.

Lägga till funktioner

Nu för att lägga till de faktiska funktionerna i plugin. Precis under koden ovan, lägg till följande funktion för att korrigera felstavningar av wordpress till WordPress:

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

renym_wordpress_typo_fix är det unika namnet vi har gett vår funktion. När du lägger till nya funktioner bör du aldrig starta dem med wp_ – detta för att förhindra framtida oförenlighet med WordPress-kodfunktioner som alla använder prefixet wp_.

Vår PHP-funktion tar ($ text) som argument och returnerar den första strängen ‘wordpress’ ersatt med den andra strängen ‘WordPress’.

Vi har lagt till ett filter (add_filter) till vårt plugin för att berätta om vår funktion ( renym_wordpress_typo_fix ) för att arbeta med texten vi har valt, som i detta fall är hela inläggets innehåll (innehållet).

För att ersätta mer än ett ord (kanske du vill redigera flera ord i din blogg eller använda plugin som ett enkelt blantringsfilter), ersätt koden ovan med följande kod:

funktion renym_content_replace ($ innehåll) {
$ search = array ('wordpress', 'get', 'Easter', '70', 'sensationell');
$ byte = matris ('WordPress', 'kaffe', 'påsklov', 'sjuttio', 'extraordinärt');
return str_replace ($ sökning, $ ersätt, $ innehåll);
}
add_filter ('the_content', 'renym_content_replace');

I vår kod ovan har vi redan valt orden att ersätta t.ex. wordpress, get, påsk, etc. Vi har också valt ersättningsorden t.ex. WordPress, kaffe, påskhelg osv. Förhoppningsvis är koden något självförklarande:

  • De renym_content_replace funktionen tar ($ innehåll) som argument, ersätter alla orden i $ -sökfältet och returnerar de nu modifierade orden till WordPress.
  • $ sökning innehåller alla ord som ska ersättas
  • $ byte innehåller ersättningsorden
  • str_replace gör vad den gör bäst och ersätter ord med de nya orden

Lägg märke till hur vi lägger till prefixet renym till varje funktion. Detta förhindrar konflikter med andra plugins som kan installeras. Du bör gå in i vanan att lägga till prefix till dina funktioner oavsett om du utvecklar plugins, teman eller widgets.

Om du har slutfört stegen ovan kan din plugin ersätta alla dina valda ord effektivt. Låt oss nu lägga till “Tack för att du har läst den här handledning …” -notatet som kommer att visas längst ner i varje inlägg. Lägg till följande kod i din huvudsakliga plugin-fil ( renym_content_replace ) innan den stängande PHP-konsolen ( ?> ) Som kommer i den sista raden:

funktion renym_content_footer_note ($ innehåll) {
$ innehåll. = '
Tack för att du läser den här handledningen. Kanske nästa gång jag låter dig köpa mig ett kaffe! För mer WordPress-tutorials besök vår blogg
'; returnera $ innehåll; } add_filter ('the_content', 'renym_content_footer_note');

Spara ändringarna. De renym_content_footer_note -funktionen lägger till HTML-markeringen till $ content-parametern och returnerar det nya värdet till WordPress. Vi har också lagt till en sidfot i vår text så att den lätt kan utformas senare.

Vi har inkluderat ett filter (add_filter) som säger att vår funktion ska fungera på texten vi har valt, vilket är inläggets innehåll som representeras av_kontinen.

Komprimera din mapp

Vid denna punkt, din final wp-renym.php filen ska se ut så här:

Tack för att du läser den här handledningen. Kanske nästa gång jag låter dig köpa mig ett kaffe! För mer WordPress-tutorials besök vår blogg';
returnera $ innehåll;
}
add_filter ('the_content', 'renym_content_footer_note');

?>

Spara alla dina ändringar. Komprimera mappen WP Renym till en wp-renym.zip arkiv (på en Mac är det lika enkelt som högerklicka, komprimera fil – och på PC tror jag att det är väldigt likt). Se bara till att din fil sparas som en .ZIP-förlängning eller att plugin-programmet inte kommer att installeras.

Använd din plugin

Ladda upp och aktivera din nya WP Renym-plugin via WordPress Plugins-skärm. Grattis med att skriva ditt första plugin!

Installera Renym WordPress-plugin

Resurser

För att lära dig mer om WordPress-pluginutveckling, vänligen kolla in följande resurser:

Slutsats

Jag hoppas att denna handledning pekade dig i rätt riktning så långt det går att förstå plugins. Det här inlägget bör fungera som ett steg för att utveckla komplexa WordPress-plugins som gör vad du än kommer. Sluta inte här, kolla in resurserna som jag rekommenderade ovan för att öka din kunskap om WordPress-pluginutveckling.

Om du tyckte att den här handledningen var till hjälp eller om du har något annat att lägga till skulle vi gärna veta. Vänligen dela dina tankar i kommentarerna nedan. Ser dig runt ��

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