Průvodce začátečníka napsáním vlastního zkratkového kódu

Zkratkové kódy jsou oblíbenou funkcí obsaženou v mnoha pluginech a tématech. Pokud jste však nikdy předtím nevytvářeli vlastní zkrácené kódy, možná netušíte, jak je přidat do vlastních projektů WordPressu.

Naštěstí rozhraní API pro zkrácené kódy ve WordPressu umožňuje poměrně snadno vytvářet vlastní zkrácené kódy. Pokud to uděláte, umožníte uživatelům využívat funkce vašeho pluginu nebo tématu z libovolné textové oblasti na webu WordPress. Zahrnutí zkratek do vašich projektů představuje snadný způsob, jak navázat na již vytvořené funkce, a získat tak co nejvíce peněz.

V tomto článku si povíme něco více o tom, jak zkratky fungují. Pak vám ukážeme, jak jednoduché může být naprogramovat si vlastní ve třech krocích. Pojďme začít!

Úvod do krátkých kódů a rozhraní Shortcode API

Rozhraní WordPress Shortcode API je užitečný nástroj pro vývojáře.

Kódy zkratek vypadají jako malé kousky textu v hranatých závorkách, například takto: . Každý z nich představuje jedinečné provedení předdefinovaného kódu, které se spouští na vyžádání. Můžete je použít téměř kdekoli, kam lze ve WordPressu přidat text.

Ačkoli většinu zkratek přidávají témata a pluginy, jádro WordPressu obsahuje několik výchozích zkratek, které můžete použít. Mezi ně patří například zvuk, galerie a titulek.

Příklad když přidáte obrázek s popiskem, WordPress vygeneruje konkrétní zkrácený kód:

Při zobrazení na titulní straně se zobrazí obrázek s popiskem:

Naštěstí rozhraní Shortcode API umožňuje poměrně snadno vytvářet vlastní zkrácené kódy pro vlastní projekty WordPress. Často se jedná o chytrý nápad, protože usnadňuje život vašim uživatelům tím, že jim umožňuje používat složité funkce pomocí několika stisků kláves.

Jak napsat vlastní zkrácený kód (ve 3 jednoduchých krocích)

Teď, když už víte, jak zkrácené kódy fungují, se naučíme, jak jeden přidat do vlastního tématu nebo pluginu! Samozřejmě bude záležet jen na vás, co váš zkrácený kód bude dělat. V tomto příkladu použijeme pro začátek jednoduchou funkci „Hello world!“

Napsání funkce zkratky

Nejprve budete chtít otevřít nový soubor v textovém editoru. Poté napište funkci s jedinečným názvem, která provede kód, který chcete, aby zkratka spustila:

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

Pokud bychom tuto funkci použili normálně, vrátila by Hello world! jako řetězec, který by se dal vypsat do HTML. Tato funkce může také přijímat vlastní parametry. Pokud například chcete, aby někdo mohl místo toho říkat Hello Bob!, můžete přidat parametr name. Těmto parametrům se říká atributy a všechny se zpracovávají pomocí jediného pole, které je ve WordPressu předdefinováno jako $atts.

Tady je příklad použití funkce $atts pro správné zpracování atributů zkratek ve WordPressu. Více informací o tom, jak to funguje pro vaše vlastní potřeby, najdete v kodexu WordPressu:

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

Pokud není k dispozici jiný název, je atribut name výchozí hodnotou world. Pokud je zadán název, funkce jej vypíše místo něj. Zde je příklad, jak by se tato funkce provedla se zkratkou:

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

Po dokončení můžete tuto funkci použít ve všech textových oblastech na webu WordPress, kde je nainstalován doplněk nebo téma, které tuto zkratku obsahuje.

Uložení souboru a jeho přidání do projektu

Když je zkratka hotová, můžete v rámci vlastního tématu nebo doplňku vytvořit nový soubor a funkci uložit. Popisný název vám později pomůže tento soubor najít (například: shortcode-function-hello-world.php).

Nyní je čas informovat o tomto novém souboru zbytek vašeho projektu. Pokud pracujete s tématem, budete jej chtít zahrnout do souboru functions.php. Pokud vytváříte zásuvný modul, můžete jej zahrnout do libovolného souboru, který již byl do projektu načten.

Níže je uveden příklad, jak byste tento soubor načetli do tématu pomocí funkce get_stylesheet_directory(). Nezapomeňte upravit cestu k souboru tak, aby odpovídala struktuře složek uvnitř tématu:

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

Na druhé straně takto vypadá načtení souboru do zásuvného modulu pomocí funkce plugin_dir_url(). Opět upravte cestu k souboru tak, aby odpovídala struktuře složek vašeho zásuvného modulu:

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

V tomto okamžiku je vaše funkce k dispozici k použití! Zbývá už jen aktivně zaregistrovat zkrácený kód v rámci WordPressu.

Registrace zkráceného kódu

Posledním krokem je registrace vašeho nového zkráceného kódu v rozhraní Shortcode API. To se provádí pomocí funkce add_shortcode. Ta vyžaduje dva argumenty:

  1. Tag zkratky, který má být použit v textovém editoru
  2. Název funkce obsluhující spuštění zkratky

Pod funkci zkratky vložte tento řádek kódu a aktualizujte jej tak, aby odpovídal vašim vlastním hodnotám:

add_shortcode( 'helloworld', 'torque_hello_world_shortcode' );

První hodnota bude v textovém editoru v hranatých závorkách. Druhá bude odpovídat názvu funkce, který jste napsali v předchozích dvou krocích. Obě hodnoty by měly být dostatečně unikátní, aby nepřekážely jiným zkráceným kódům obsaženým v jádře WordPressu, tématech nebo pluginech.

Po dokončení zbývá už jen otestovat. Přihlaste se do administrace WordPressu a zkuste přidat svůj zkrácený kód do příspěvku:

To je vše! Váš zkrácený kód může být tak složitý nebo jednoduchý, jak chcete – co se rozhodnete pomocí této schopnosti vytvořit, je jen na vás! Pro pokročilé situace, kdy byste chtěli výstup upravit pro různé situace, by možná stálo za to napsat jedinečnou třídu PHP, která bude váš nový zkrácený kód obsluhovat.

Závěr

Přidávání složitých funkcí do příspěvků a stránek WordPressu je pomocí zkrácených kódů snadné. Jsou jednoduché na programování a přidávají hodnotu vašemu stávajícímu projektu tím, že dynamizují přímočarý obsah.

V tomto článku jste se dozvěděli, že k vytvoření zkratky stačí tři jednoduché kroky:

  1. Napsat běžnou funkci, která provede požadovaný vlastní kód.
  2. Uložit kód do pluginu nebo tématu WordPressu.
  3. Zaregistrovat zkratku ve WordPressu.

Napsat komentář