WordPress tip: snadné pojmenování akcí a filtrů

Když se pořádně naučíte programovat ve WordPressu, zamilujete si nepochybně akce a filtry stejně jako já a budete jich aplikovat ve vašem kódu desítky či stovky.

To má ale několik nevýhod

  1. furt musíte vymýšlet, jak je pojmenovávat, a to tak, abyste je pak zas nějak našli
  2. přitom se ale nesmí funkce se stejným názvem opakovat, jinak dojde ke konfliktu
  3. mám pak někdy tunu funkcí, které se aplikují na stejnou akci/filtr a různě se kříží či dělají to samé
  4. nesmí se tyto funkce jmenovat stejně, jako funkce, které definovali autoři WP či pluginů.
  5. optimálně by měly být funkce a filtry snadno přenosné i na další weby

Za těch 10 let co s WP dělám jsem si vymyslel systém, který všechny tyto problémy řeší – pojmenovávám své akce a filtry vždy přesně podle názvu dané akce či filtru a před to používám jednotný prefix.

Např. si řeknu, že budu jako prefix vždy používat své jmého, tedy „kapler_“. Takže když chci vytvořit funkci k filtru sanitize_tile, prostě ji pojmenuji kapler_sanitize_title. Tedy funkce z minulého příspěvku by vypadala takto

function kapler_sanitize_title($title) {
    return str_replace('+', '-', $title); // sanitize plus with dash
}
add_filter('sanitize_title', 'kapler_sanitize_title');

Pointa je, že:

  1. nemusím přemýšlet ani vteřinu nad názvem a přitom se nikdy nebude jmenovat jako funkce někoho jiného (mé jméno je celkem unikátní)
  2. každý filtr či akce má vždy jednu mou funkci, tedy nemůže dojít ke konfliktu, resp. když dojde, tak vím, že už jsem tuto funkci aplikoval jinde a můžu je tak sloučit
  3. Tím že mám všechny filtry vztahující se k jedné proměnné u sebe, nehrozí, mnohem snadněji zkontroluji, jestli se nějak nekříží
  4. Takové funkce snadno přenesu i na jiné weby, protože mají prostě vždy stejnou strukturu

Teoretickou nevýhodou je snad jen ztráta té informace o tom, co daná funkce dělá z názvu funkce. Ale to jen na první pohled. Ve skutečnosti ta funkce už svým názvem prostě jasně říká, že se něco provádí s filtrem sanitize_title. A co konkrétně se provádí, to je pak definováno komentáři u těch jednotlivých úprav.

Klíčové je, že pakliže změním/rozšířím funkcionalitu, nemusím měnit název funkce, aby přesně vyjadřoval její funkčnost. Tedy když budu chtít nahrazovat nejen + ale i = za pomlčku, tak nemusím funkci přejmenovávat z „plus_to_dash“ na „plus_and_equals_to_dash“, ani nemusím vytvářet druhou funkci „equals_to_dash“ aplikovanou na stejný filtr, ani nemusím mít neodpovídající chování funkce „plus_to_dash“, kdyby dělala něco jiného, než jen „plus to dash“.

Prostě bych jen změnil nahrazování za

str_replace(array('+','='), '-', $title)

WordPress – filtry a akce pro začátečníky

Na všechny weby své a svých klientů už asi 10 let používám nejpoužívanější CMS na světě – WordPress. Miluji na něm jeho snadnou modifikaci, díky které můžete snadno ze základního systému pro správu blogů udělat pokročilý systém na správu téměř jakéhokoliv obsahu, a přitom geniální zachování aktualizovatelnosti.

Základem této snadné modifikace jsou dva skvělé prvky – akce a filtry. Prakticky na každou zabudovanou funkci WP jsou aplikované nějaké akce a/nebo filtry.

Řekněme, že potřebujete upravit chování WP při tvorbě slugů – hezkých URL – z titulku příspěvku – např. chcete, aby se + symbol převáděl na pomlčku. Zjistíte (nejsnadněji vhodným dotazem na Google), že toto provádí interně funkce sanitize_title.

A teď – mohli byste jí upravit, ale pak by jste o tuto úpravu přišli při příští aktualizaci WP. Nebo kdyby WP byl plně objektový systém, byste mohli tuto funkci přepsat vlastní funkcí, ale to by často znamenalo, že byste museli zkopírovat celou větší funkci, jen kvůli malé změně, a když by se tato funkce ve wordpressu měnila, museli byste si dávat pozor, aby ta vaše držela krok.

Místo toho má WP právě filtry a akce:

  • filtry mají na vstupu nějakou hodnotu (typicky text) a vy navázáním vaší funkce na tento filtr můžete tuto hodnotu změnit.
  • akce mají jen své místo a prioritu a vy navázáním své funkce na danou akci můžete na daném místě provést vlastní akci – typicky něco vypsat.

Takže zpět k našemu příkladu. Funkce sanitize_title má před výstupem na sebe nevázán filter, který se jmenuje také sanitize_title (není vždy pravidlem, že se shodují, záleží s čím pracují).

Vy tak můžete do svého tématu (např. do svého souboru s funkcemi functions.php) napsat následující volání tohoto filtru:

function plush_to_dash($title) {
    return str_replace('+', '-', $title);
}
add_filter('sanitize_title', 'plus_to_dash');

Řádek add_filter aplikuje váš filtr definovaní funkcí „plus_to_dash“ na filtr, který se jmenuje sanitize_title a který je aplikovaný v kódu u funkce sanitize_title na proměnou $title. Vaše funkce plus_to_dash tak bere na vstupu tuto jednu proměnou a nahradí v ní plus za pomlčku a výsledek vrátí.

Podobně fungují akce, které však nepracují s hodnotou, ale jen s místem, kde jsou umístěné. Tedy např. akce wp_head:https://codex.wordpress.org/Plugin_API/Action_Reference/wp_head je zodpovědná za vypsání veškerého obsahu do hlavičky vašeho webu. Když tedy budete chtít do hlavičky třeba vlastní styl, uděláte to nějak takto:

add_action('wp_head','hook_css');

function hook_css()
{

$output="<style> .wp_head_example { background-color : #f1f1f1; } </style>";

echo $output;

}

A pointa je, že akce i filtry je možné nejen přidávat, ale i odstraňovat a tím můžete snadno změnit i výchozí chování WordPressu. Toho docílíte snadno funkcemi remove_action resp. remove_filter.

Např. řekněme, že se vám nelíbí, že WordPress na výstupu automaticky převádí pevné odřádkování v obsahu příspěvku na odstavce. Dělá to tak, že aplikuje funkci wpautop na filter the_content.  Tedy není nic snazšího, než tento filtr odstranit:

remove_filter( 'the_content', 'wpautop' );