The Beginner’s Guide to Writing Your Own Custom Shortcode

A rövidkódok egy népszerű funkciót tartalmaznak számos bővítményben és témában. Ha azonban még soha nem készítettél saját rövidkódokat, lehet, hogy fogalmad sincs, hogyan adhatod hozzá őket a saját WordPress projektjeidhez.

Szerencsére a WordPress rövidkód API-ja meglehetősen egyszerűvé teszi a saját rövidkódok létrehozását. Ezzel lehetővé teszi a felhasználók számára, hogy kihasználják a plugin vagy téma funkcióit a WordPress webhelyük bármely szöveges területéről. A rövidkódok beépítése a projektjeibe egy egyszerű módja annak, hogy a már létrehozott funkciókra építsen, így a lehető legtöbbet kapja a pénzéért.

Ebben a cikkben egy kicsit többet fogunk beszélni a rövidkódok működéséről. Ezután három lépésben megmutatjuk, milyen egyszerű lehet sajátokat programozni. Lássunk hozzá!

Egy bevezetés a rövidkódok és a Shortcode API

A WordPress Shortcode API egy praktikus eszköz a fejlesztők számára.

A rövidkódok úgy néznek ki, mint szögletes zárójelben lévő kis szövegdarabok, például így: . Mindegyik egy előre definiált kód egyedi végrehajtását jelenti, amelyet igény szerint indítunk el. Szinte bárhol használhatod őket, ahol a WordPressben szöveg adható hozzá.

Míg a legtöbb rövidkódot témák és bővítmények adják hozzá, a WordPress magja rendelkezik néhány alapértelmezett rövidkóddal, amelyeket használhatsz. Néhány példa ezekre az audio, a galéria és a felirat.

Ha például egy képet adsz hozzá egy felirattal, a WordPress egy bizonyos rövidkódot generál:

Ha ezt a frontendben nézed meg, egy képet látsz egy felirattal:

Szerencsére a Shortcode API segítségével viszonylag egyszerűen készíthetsz egyéni rövidkódokat a saját WordPress-projektjeidhez. Ez gyakran okos ötlet, mert megkönnyíti a felhasználók életét, mivel lehetővé teszi számukra az összetett funkciók használatát néhány billentyűleütéssel.

Hogyan írj saját egyéni rövidkódot (3 egyszerű lépésben)

Most, hogy megértetted, hogyan működnek a rövidkódok, tanuljuk meg, hogyan adj hozzá egyet a saját témádhoz vagy bővítményedhez! Természetesen az, hogy mit csinál a rövidkódod, csak rajtad múlik. Ebben a példában egy egyszerű “Hello world!” funkciót fogunk használni a kezdéshez.

A rövidkód funkció megírása

Először is nyiss egy új fájlt egy szövegszerkesztőben. Ezután írj egy egyedi nevű függvényt, amely végrehajtja azt a kódot, amelyet a rövidkóddal szeretnél kiváltani:

function torque_hello_world_shortcode() { return 'Hello world!';}

Ha ezt a függvényt normálisan használnánk, akkor egy HTML-ben kiadható stringként adná vissza a Hello world! fájlt. Ez a függvény egyéni paramétereket is elfogadhat. Ha például azt szeretnénk, hogy valaki azt szeretné, hogy helyette azt mondja: Hello Bob!, akkor hozzáadhatunk egy név paramétert. Ezeket a paramétereket attribútumoknak nevezzük, és mindegyiket a WordPress által $atts néven előre definiált egyetlen tömb segítségével kezeljük.

Itt egy példa arra, hogyan használjuk a rövidkód $atts függvényt a rövidkód attribútumok megfelelő kezelésére a WordPressben. A WordPress codexben többet megtudhatsz arról, hogyan működik ez a saját igényeidre:

function torque_hello_world_shortcode( $atts ) { $a = shortcode_atts( array( 'name' => 'world' ), $atts ); return 'Hello ' . $a . !';}

Ez a name attribútum alapértelmezett értéke world, ha nincs más név. Ha megadunk egy nevet, a függvény azt adja ki helyette. Íme egy példa arra, hogyan lehetne ezt egy rövidkóddal végrehajtani:

// Outputs "Hello world!" // Outputs "Hello Bob!"

Amint elkészültél, ez használható a WordPress oldal minden olyan szöveges területén, ahol a rövidkódot tartalmazó plugin vagy téma telepítve van.

Mentsd el a fájlt és add hozzá a projektedhez

Amint elkészült a rövidkódod, létrehozhatsz egy új fájlt az egyéni témádban vagy pluginodban a funkció mentéséhez. Egy leíró név segít majd később megtalálni ezt a fájlt (például: shortcode-function-hello-world.php).

Most itt az ideje, hogy tájékoztasd a projekted többi részét erről az új fájlról. Ha témával dolgozol, akkor a functions.php fájlba kell beillesztened. Ha egy bővítményt készítesz, akkor bármely, a projektbe már betöltött fájlba beillesztheted.

Íme egy példa arra, hogyan töltenéd be a fájlt egy témába a get_stylesheet_directory() segítségével. Ügyeljen arra, hogy a fájl elérési útvonalát úgy szerkessze meg, hogy megfeleljen a témán belüli mappaszerkezetnek:

include( get_stylesheet_directory() . 'path/to/shortcode-function-hello-world.php' );

A másik oldalon így néz ki a fájl betöltése egy pluginba a plugin_dir_url() segítségével. Ismét szerkeszd meg a fájlod elérési útvonalát, hogy megfeleljen a plugin mappaszerkezetének:

Ezzel a ponttal a funkciód már használható! Már csak a rövidkód aktív regisztrálása van hátra a WordPressen belül.

Regisztrálni a rövidkódot

Az utolsó lépés az új rövidkód regisztrálása a Shortcode API-ban. Ez az add_shortcode függvénnyel történik. Két argumentumot igényel:

  1. A szövegszerkesztőben használandó rövidkód tag
  2. A rövidkód végrehajtását kezelő függvény neve

A rövidkód függvényed alá illeszd be ezt a kódsort, és frissítsd a saját értékeidnek megfelelően:

add_shortcode( 'helloworld', 'torque_hello_world_shortcode' );

Az első érték szögletes zárójelek közé kerül a szövegszerkesztőben. A második az előző két lépésben írt függvénynévnek fog megfelelni. Mindkettőnek elég egyedinek kell lennie ahhoz, hogy ne zavarja a WordPress mag, témák vagy bővítmények által bevont más rövidkódokat.

Amint elkészültél, már csak a tesztelés van hátra. Jelentkezz be a WordPress adminisztrációjába, és próbáld meg hozzáadni a rövidkódodat egy bejegyzéshez:

Ez minden, ami kell! A rövidkódod lehet olyan bonyolult vagy egyszerű, amilyet csak akarsz – hogy mit döntesz, hogy mit építesz ebből az erőből, csak rajtad múlik! Haladó helyzetekben, amikor a kimenetet különböző helyzetekhez szeretnéd igazítani, érdemes lehet egy egyedi PHP osztályt írni az új rövidkódod kezeléséhez.

Következtetés

A WordPress bejegyzésekhez és oldalakhoz összetett funkciók hozzáadása egyszerű a rövidkódokkal. Egyszerűen programozhatók, és az egyszerű tartalmak dinamikussá tételével értéket adnak a meglévő projektedhez.

Ebben a cikkben megtanultad, hogy mindössze három egyszerű lépés szükséges egy rövidkód létrehozásához:

  1. Írd meg a kívánt egyéni kódot végrehajtó szabályos függvényt.
  2. Mentsd el a kódot a WordPress pluginodba vagy témádba.
  3. Regisztráld a rövidkódot a WordPressben.

Szólj hozzá!