Dokumentace Best Practice pro WordPress

WordPress dlouho postrádal aktivitu podobnou příručce PHP The Right Way, kterou má k dispozici komunita PHP vývojářů. Ještě nedávno platilo, a obávám se, že stále ještě platí a nějakou dobu platit bude, že kdo se chtěl ponořit do WordPressu, musel začít studiem kodexu, prokousávat se zdrojovým kódem (vedle tradičního trac je tento již nějakou dobu také na GitHubu, což potěší určitě ty, kteří SVN opovrhují) a studovat řadu tutoriálů, mezi kterými navíc musel vybírat ty, které jsou kvalitní, správné a aktuální. Situace se ovšem, a hodí se říci i naštěstí, pomalu mění k lepšímu.

Chybějící ucelená dokumentace správných postupů

Důležitost zdokumentované best practice spočívá v ustálení používaných postupů s ohledem na jejich správnost, efektivitu, bezpečnost a také zajištění kompatibility s budoucím vývojem. WordPress nikterak nevynucuje řešení “tím jediným a správným způsobem”, a vlastně ani nemá páky či ambice tak činit. Veškerá tíha proto spočívá právě na řádné dokumentaci a osvětě mezi vývojáři navzájem.

Závažnost roztříštěné, a v oblasti best practice zcela nedostatečné, dokumentace a vůbec důležitost celého tématu je zřejmá i lidem kolem vývoje WordPressu samého. A tak se i na tomto poli se již nějakou dobu věci pomalu hýbou.

Codex a Developer Resources na WordPress.org

V roce 2013 na WordCampu v San Franciscu oznámil Matt Mulenweg projekt developer.wordpress.org , který by měl obsahovat návody, ukázky a best practice pro vývoj WordPressu. V současnosti je téměř kompletní část zaměřená na vývoj pluginů. Část věnující se šablononám je stále ještě v přípravě.

Documentation Team se tvorbě nového projektu aktivně věnuje. Vývoj lze sledovat, či se do něj dokonce zapojit, na blogu Make WordPress Documentation, kde lze také již nalézt plány na budoucí uspořádání a roli stávajícího kodexu. Ten by se mohl zůžit na témata zaměřená spíše na administrátory a uživatele WordPressu, přičemž vývojáři by se přesunuli právě do nové sekce Developer Resources.

Tomu odpovídá také další část tohoto projektu, která spatřila světlo světa v dubnu 2014. A sice Code Reference, umožňující rychlé vyhledávání funkcí, tříd, metod a tzv. hooks (aplikování filtrů a akcí).

WordPress The Right Way

Za pozornost v této oblasti stojí také projekt, za kterým stojí Tom J Nowell – WordPress The Right Way, a který má být právě analogií projektu zmíněného v úvodu. Do projektu, který se zrodil na WordCamp Sheffield v roce 2014, se na GitHubu zapojilo již 15, ve světě WordPressu ne zcela neznámých, tvůrců.

Projekt je stále ještě v aktivním vývoji a vzhledem ke své povaze je nutné, aby vývoj probíhal kontinuálně i nadále. Nejedná se o příručku z rodiny “for dummies“, ale spíše o referenční příručku pro všechny WordPress vývojáře, kteří tápou v otázce, jak věci dělat správně.

Ano, mnoho témat zde zatím ještě chybí – za všechny uveďme třeba téma child-themes či zásady správného používání třídy wpdb (ani jedno mimochodem není zatím zpracováno ani v Plugin Handbook na developer.wordpress.org).

Tříštění sil po tisící prvé

Nebyl by to WordPress, kdyby jeden problém neřešilo najednou více skupin a kdyby se síly netříštily do několika překrývajícíh se projektů. Nejen open source svět nám ukazuje, že ke stejnému cíly vede bezpočet cest, a že se vždy najde skupina lidí, která zvolí cestu alternativní.

Příkladem budiž vývoj konkurenčních projektů na vyhledávání filtrů a akcí v jádře WordPressu. Vedle Code Reference tu je například hooker.io, který se od začátku snažil, a stále ještě snaží, o lepší uživatelskou přívětivost. Nicméně v současnosti pracuje s kódem WordPressu jen do verze 3.9.1 (projekt je ovšem stále ještě v alpha fázi) a podobně je na tom s aktuálností i mnohem starší projekt Adama Browna. Naopak WPSeek zůstává i nadále aktuální.

WordPress je o lidech a je to v lidské nátuře dělat věci jinak, lépe. Oba projekty dokumentace best practice mají ušlechtilý cíl, nicméně nedostatek dobrovolníků v oblasti dokumentace je notoricky známý. Nezbývá než doufat, že konkurence zapracuje tak, jak by tomu v ideálním světě mělo být. Tedy že pomůže dalšímu rozvoji, a ne že bude konzumovat omezené lidské zdroje v oblasti dokumentace.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s