Innehåll

    När ska man skapa ett plugin och varför?

    Wordpress plugins är en stor del av vad som gör wordpress till det verktyg det idag är. Woocommerce, diverse sitebuilders och mycket annat hade inte funnits om inte plugins fanns. Det man kan fråga sig är när ska man använda sig av ett plugin och skapa plugins? Personligen så använder jag mig väldigt ofta av child tema när jag vill addera in egen funktionalitet. Plugins skapar jag när det finns ett behov för återanvändning av koden. Detta tar till en början lite längre tid men ger dig möjlighet att enkelt använda det på fler sidor.

    Har du en idé på något som du anser borde finnas på marknaden men du inte funnit? Då kan det finnas en möjlighet att skapa ett eget plugins som man i bästa fall kan tjäna en slant på. Vi kommer i denna guide gå igenom hur man skapar upp en bra filstruktur och sedan implementera en shortcode. Med denna grund och kunskap inom PHP så kommer du kunna bygga vidare till ett fullskaligt plugin.

    Skapa filer och göra det till ett WordPress plugin

    Att skapa ett WordPress plugin är väldigt simpelt. Det krävs som minst 4 rader kod i en PHP fil, detta är inte optimalt men det registreras som ett plugin via dessa 4 rader. Vi kommer att gå igenom mer än så, det finns en del inställningar man kan göra till sitt plugin. Säkerhet är något som också är en viktig aspekt när man bygger ett plugin. Det finns några kod snuttar som vi alltid rekommenderar att man använder sig utav till sitt plugin. Allt som vi nämnt ovan kommer vi nu gå igenom, när du är klar med dessa steg kommer du ha ett plugin. Till en början kommer det inte att fylla någon funktion men vi kommer att implementera en shortcode som skriver ut “Hello World”.

    Skapa filstruktur

    Det är alltid viktigt att ha en bra struktur på sina filer. Då vi idag bara kommer skapa ett väldigt simpelt plugin kommer det inte krävas så mycket. Vi kommer dock att separera upp filerna lite så därav kommer det bli lite saker att skapa upp. Först behöver vi en huvudmapp, vi döper vår till “wpt_helloworld”. Detta namn är inte namnet för ditt plugin utan bara ett namn som är förklarande för ditt plugin. En rekommendation är att använda sig av ett prefix i sitt plugin – vi kommer att använda wpt (wordpresstips).

    Därefter ska vi börja skapa lite PHP filer i huvudmappen som vi skapade precis. De filer som behövs skapas är: index.php (Denna är bara till för att man inte ska kunna nå ditt plugin från webbläsaren), wpt_helloworld.php (Huvudfilen som vi initierar pluginet via och inkluderar shortcoden). Du bör nu ha en filstruktur som ser ut som följande:

    WordPress Plugin header och grund säkerhet

    Som tidigare nämnt är säkerhet en viktig sak att tänka på när man skapar egna plugins. Vi kommer nu att gå igenom hur man förhindrar att din kod kan anropas utanför wordpress. Ska du bygga vidare på ditt plugin rekommenderar vi att man kollar upp lite mer information kring säkerhet för plugins. Det vi implementerar i detta plugin är enbart standard kod som motverkar de vanligaste problemen.

    Fil: index.php
    <?php # Silence is golden. ?>

    index.php i denna fil lägger vi bara till en kommentar. Denna fil är som tidigare nämnt bara till för att inte tillåta folk nå plugin mappen ifrån sin webbläsare.

    Fil: wpt_helloworld.php
    <?php /*
    Plugin Name: WPT Hello World
    Plugin URI: https://wordpresstips.se/
    Description: Detta är mitt första plugin
    Version: 1
    Author: Kevin
    Author URI: https://wordpresstips.se/
    License: GPLv2 or later
    Text Domain: wpt_helloworld
    */

    if ( !function_exists'add_action' ) ) {
        echo 
    'Hi there!  I\'m just a plugin, not much I can do when called directly.';
        exit;
    ?>

    wpt_helloworld.php detta är vår huvud fil. Det är i denna vi initerar pluginet via texten som ligger i kommentaren. Nedan kommer en förklaring på de olika raderna som ligger inom kommentaren.

    • Plugin Name – Namnet på ditt plugin
    • Plugin URI – Länk till eventuell sida tillhörande ditt plugin
    • Description – Beskrivning av ditt plugin
    • Version – Version på plugin
    • Author – Skapare utav plugin
    • Author URI – Länk till eventuell personlig/annan sida
    • License – License pluginet innehar normal GPL
    • Text Domain – Används huvudsakligen för översättning utav plugin

    Detta finns några fler parametrar du kan använda, du finner alla på wordpress.org.
    Sedan har vi if ( !function_exists( ‘add_action’ ) ) {. Denna if-sats koller om funktionen add_action, denna finns bara om pluginet anropas med wordpress. Det innebär att anropar folk ditt plugin direkt kommer dom får en text som säger “‘Hi there! I’m just a plugin, not much I can do when called directly.”.

    Aktivera plugin och lägga till shortcode

    Har du följt stegen korret ska du nu kunna gå till Tillägg i din meny. Väl där inne så ska du se ditt ny skapade plugin, i mitt fall WPT Hello World då jag skrev Plugin Name: WPT Hello World i wpt_helloworld.php filen. Sedan finns din beskrivning, version och skapare även där. Se nedan för en bild på hur det ska se ut, där kan du nu aktivera ditt plugin. Då vi inte har lagt in någon faktisk kod kommer det inte att ske något speciellt när du aktivera det.

    Skapa ny fil och inkludera denna

    Nu ska vi lägga till vår första riktiga kod i vårt plugin. Det kommer att vara en shortcode [wpt_helloworld] som kommer att skriva ut Hello World. För skapar vi en ny mapp i wpt_helloworld som heter inc. I denna map skapar vi en ny fil som heter wpt_shortcode.php. Nu måste vi inkludera denna fil i vår huvudfil så att pluginet registrerar den nya koden vi ska skriva. För att inkludera denna fil måste du lägga till include(‘inc/wpt_shortcode.php’); under den koden som redan finns i wpt_helloworld.php. Din kod ska nu se ut som följande.

    Fil: wpt_helloworld.php
    <?php /*
    Plugin Name: WPT Hello World
    Plugin URI: https://wordpresstips.se/
    Description: Detta är mitt första plugin
    Version: 1
    Author: Kevin
    Author URI: https://wordpresstips.se/
    License: GPLv2 or later
    Text Domain: wpt_helloworld
    */

    if ( !function_exists'add_action' ) ) {
        echo 
    'Hi there!  I\'m just a plugin, not much I can do when called directly.';
        exit;
    }

    include(
    'inc/wpt_shortcode.php'); ?>

    index.php i denna fil lägger vi bara en kommentar. Denna fil är som tidigare nämnt bara till för att inte tillåta folk nå plugin mappen ifrån sin webbläsare.

    Lägga till shortcode och testa denna

    Nu när vi har skapat upp filerna och inkluderat dessa i vår huvudfil är det bara koden kvar. WordPress har gjort det lätt att skapa shortcodes med en inbyggd funktion kallad add_shortcode. Denna funktion kan ta emot två stycken parametrar, ett shortcode-tag och en funktion som anropas utav shortcoden. Nedan kan du se hur vi skapat vår funktion och sedan anropat add_shortcode.

    Fil: inc/wpt_helloworld.php
    <?php function wpt_hello_world_shortcode() {
        return 
    'Hello World';
    }
    add_shortcode'wpt_helloworld''wpt_hello_world_shortcode' ); ?>

    Ovan har du nu en funktion vid namn “wpt_hello_world_shortcode”. Du kan se under denna funktion att vi har anropat add_shortcode med taggen wpt_helloworld som då kommer att anropas via [wpt_helloworld]. Sedan anropar vi “wpt_hello_world_shortcode” som returnerar “Hello World”. Du kan nu testa att skapa en sida och lägga till [wpt_helloworld] i din text. Du ska du se Hello World där du lagt denna shortcode om du gjort allting korrekt.

    Slutord, hur går man vidare?

    Nu har du lärt dig hur du skapar ditt egna plugin. Detta är en väldigt bra kunskap att ha men frågan blir ofta, hur går man vidare? Mycket beror på din kunskap inom programmering, kan du PHP väl har du goda chanser att göra något bra. Saknar du kunskap inom detta område finns det mycket bra guider på hur man tar sig vidare, du finner alla våra guider gällande plugins på vår wordpress plugins sida. Hoppas att denna guide gett dig någon ny kunskap – vi önskar dig all lycka i WordPress byggandet!