Wordpress

Bližší pohled na standardy kódování WordPress

Podle W3tech funguje na WordPressu 65.1 % webů, které využívají redakční systém. Je to renomovaný open-source CMS napsaný v jazyce PHP. Díky rozmanité řadě vlastních témat a pluginů mnoho poskytovatelů SaaS a agentur digitálního marketingu využívá WordPress k vytváření webových stránek.

Proč WordPress zavedl kódovací standardy?

Vzhledem k tomu, že WordPress je masivní software s otevřeným zdrojovým kódem, skládá se z velkého zdrojového kódu, který lze spustit. To je způsobeno přispěním několika vývojářů k tomuto datu. Vzhledem k tomu, že kódování lze provádět v několika stylech, mohou vývojáři na platformu WordPress přidat jakýkoli druh kódu, který znají. To může mít za následek komplikace pro WordPress.

Pokud by bylo do zdrojového kódu WordPress implementováno více stylů kódování, bylo by pro různé vývojáře softwaru složité číst a rozšiřovat softwarové aplikace. Zaměstnanci DevOps, kteří prohledávají různé styly kódu, by jen těžko identifikovali chyby. To může způsobit zhroucení webových stránek v době spuštění, což způsobí škody ve smyslu ztráty zákazníků pro podniky.

Aby se takovým okolnostem předešlo, zavedl WordPress standardy kódování. Jednalo se o soubor předpisů, které musí vývojáři povinně dodržovat při rozšiřování funkčnosti WordPressu.

Kódovací standardy zjednodušují proces manipulace a posuzování objemů vzorků kódu. Je to proto, že se řídí stejnými styly formátování, což usnadňuje různým vývojářům pochopit, co se děje ve zdrojovém kódu. Celkově kódovací standardy pomáhají udržovat kvalitu zdrojových kódů přidaných jinými vývojáři.

Jaké standardy kódování používá WordPress?

WordPress nezávisí pouze na jazyce PHP. Využívá také HTML, CSS a JavaScript. Jeho kódovací standardy se tedy liší v závislosti na těchto programovacích jazycích. Pokud se těšíte na vytvoření vlastního pluginu WordPress a vylepšení platformy WordPress, zde jsou kódovací standardy, které musíte při vytváření kódu dodržovat.

1. Kódování pomocí PHP

Pro příspěvek jednotného, ​​čistého a srozumitelného kódování zavedl WordPress standardy kódování pro značkování PHP. Pokud vytváříte nějaké projekty WordPress prostřednictvím značek PHP, dodržujte následující pravidla kódování.

  • Použití nabídek

WordPress doporučuje za vhodných podmínek používat dvojité a jednoduché uvozovky. Jednoduché uvozovky lze použít uvnitř řetězce, když se nic nevyhodnocuje. Při použití uvozovek vyhraďte jeden styl uvozovek pro použití uvnitř řetězce a druhý pro uzavření celého řetězce.

Escapování uvozovek v řetězci se nedoporučuje.

  • Odsazení

Při použití odsazení zdůrazňuje WordPress použití kláves tabulátoru namísto kláves mezerníku pro označení odsazených řádků kódu. Výhodou je, že se váš kód stane kompatibilním s různými editory, které jej používají na různých platformách.

Odsazení pomáhá logickým oblastem vašeho kódu vyniknout, takže jsou jasné a srozumitelné

Pokud používáte asociativní pole a obsahuje více položek, každá položka tohoto pole by měla mít svůj vlastní nový řádek. Na konec poslední položky pole přidejte čárku. To usnadňuje přidávání nových prvků do pole nebo změnu jeho pořadí.

  • PHP tagy

Při použití fragmentů kódu PHP v blocích HTML by měly být značky otevření a zavření PHP na samostatném řádku.

WordPress zakazuje používat zkrácené značky PHP, protože mohou způsobit problémy při spouštění vašeho kódu.

  • šle

WordPress vyžaduje, aby bylo používání složených závorek ve vašem kódu povinné. V řádku počátečního příkazu musí být umístěna otevírací složená závorka. Složené závorky jsou vynechány pouze u jednořádkových příkazů. Příkazy smyčky musí také obsahovat složené závorky. Pokud se používají příkazy s více bloky, jsou nutné složené závorky.

  • Využití prostoru

Mezera musí být umístěna na obou stranách operátorů přiřazení, logických operátorů, operátorů porovnání a řetězců a za čárkami. Mezera musí být umístěna také za otevřením a před uzavřením závorek, s výjimkou typových odlitků. Koncové mezery na konci každého řádku kódu musí být odstraněny.

  • Příkazy SQL

Standardy kódování WordPress podporují psaní příkazů SQL velkými písmeny. Tyto příkazy lze napsat na jeden řádek, pokud jsou krátké a snadno čitelné. U složitých SQL dotazů se doporučuje rozdělit je na více řádků a každý příkaz SQL odsadit.

  • Zásady pojmenování

Vývojáři jsou povinni dodržovat předpisy WordPress při pojmenovávání funkcí, tříd a souborů, aby se předešlo nepřehledným chybám. Při vytváření funkcí nebo proměnných musí být jména psána malými písmeny a camelCase je přísně zakázáno. Pokud je při pojmenování použito více slov, oddělte je podtržítkem.

Podobné je to s názvy souborů s tím rozdílem, že pokud je použito více slov, musí být oddělena pomlčkou. Pokud se váš soubor skládá z třídy, musí být název souboru napsán ve formátu název třídy–třídy malými písmeny, přičemž každé podtržítko bude nahrazeno pomlčkou.

Pokud se do složky wp-includes načítají nebo přidávají soubory sestávající ze značek šablon, musí být k tomuto názvu souboru připojeno -template.

Při vytváření tříd musí být názvy tříd velká. Pokud je použito více slov, měla by být oddělena podtržítkem a každé slovo musí být velké.

2. Kódování pomocí HTML

Předpisy o kódování uvádějí, že fragmenty kódu HTML musí být před ruční kontrolou kódu spuštěny validátorem W3C. To pomáhá odhalit a opravit případné chyby značení ve vašem kódu. Při přidávání HTML kódování je třeba dodržovat následující standardy.

  • Samozavírací štítky

Se samouzavíracími značkami v HTML je třeba zacházet opatrně, zejména s mezerami. W3C dává pokyn, že při použití samouzavíracích značek musí před samouzavíracím lomítkem předcházet mezera.

  • Tagy a atributy

Tagy pomáhají navrhnout strukturu stránky HTML. Obklopují web a umožňují prohlížeči určit, o jaký druh obsahu se jedná. Atributy poskytují další podrobnosti o prvcích HTML.

Předpisy pro kódování WordPressu radí, že všechny HTML tagy a atributy musí být psány malými písmeny. Hodnoty atributů musí být také zapsány malými písmeny pro strojovou interpretaci. V případě, že data jsou čitelná pro lidi, lze použít správné psaní velkých písmen.

  • Citace

Při psaní hodnot atributů v XHTML je nutné používat dvojité nebo jednoduché uvozovky. Kódovací standardy WordPressu pro HTML doporučují stejný formát pro předcházení jakýmkoli bezpečnostním problémům v kódu HTML.

3. Kódování pomocí CSS

CSS je dalším nezbytným programovacím jazykem pro navrhování rozvržení a tématu vašich webových stránek. WordPress zavedl kódovací standardy pro kódování CSS, aby vývojáři mohli vytvářet konzistentní, čistý a čitelný kód pro projekty. Zde jsou doporučené pokyny.

  • Struktura

 CSS poskytuje mnoho možností pro návrh šablony stylů. WordPress však poskytuje základní pokyny v CSS pro vytváření jasného a zřetelného kódu. To pomáhá ostatním vývojářům spolupracovat s vámi, aby pochopili tok vašeho dokumentu.

Pokyny doporučují používat karty pro odsazení každé vlastnosti použité ve vašem kódu. Kódovací bloky patřící do stejné části musí mít mezi každým blokem jeden prázdný řádek. Pro rozlišení kódovacích kusů je třeba přidat 2 prázdné řádky mezi každý kódovací díl.

Pokud uvádíte více selektorů pro jednu sadu pravidel, každý selektor musí být zapsán na samostatném řádku. U párů vlastnost-hodnota by měl mít každý svůj vlastní řádek, používat jeden tabulátor odsazení a končit středníkem. Při použití pouze jednoho voliče musí být na linii tohoto voliče umístěna otevírací vzpěra.

V opačném případě by měla být otevírací závorka přidána na poslední řádek voliče a uzavírací závorka by měla být umístěna na samostatném řádku ve stejném odsazení jako otevírací volič.

  • Voliči

Standard kódování pro selektory je podobný standardům kódování PHP pro názvy souborů. Při pojmenovávání selektorů je třeba je psát malými písmeny a pro oddělení více slov je nutné použít pomlčky. Použití camelCase a podtržítek je zakázáno.

Názvy selektorů by měly být schopny poskytnout stručný popis toho, jaké prvky stylizují. Tyto názvy by měly být čitelné pro člověka. U selektorů atributů musí být kolem jejich hodnot umístěny dvojité uvozovky.

  • Nemovitosti

WordPress nedoporučuje používat specifické vlastnosti, které mohou způsobit snížení flexibility návrhu. Jeho standard kódování radí, že za každou vlastností musí následovat dvojtečka a mezera.

Vlastnosti a hodnoty musí být psány malými písmeny, kromě názvů písem. Pro přidávání barev se upřednostňují hexadecimální kódy nebo rgba() a musí se používat malá písmena. Pro hodnoty pozadí, ohraničení, písma, stylu seznamu, okrajů a odsazení se doporučuje použít zkrácené vlastnosti.

4. Kódování pomocí JavaScriptu

JavaScript je nezbytný programovací jazyk pro vytváření aplikací WordPress. WordPress formuloval pravidla kódování tak, aby vývojáři mohli přinést konzistenci při stylování kódu JavaScript. Několik z těchto standardů kódování je uvedeno níže.

  • Refaktorování zdrojového kódu

Kvůli nesrovnalostem přítomným ve struktuře kódu WordPress pro JavaScript bylo refaktorování zdrojových kódů důležité pro jeho aktualizaci. WordPress tento problém postupně řeší. Doporučuje, aby vývojáři, kteří pracují na kódu JavaScript, postupovali podle aktuálních nezbytných pokynů. Zatímco u starších souborů JavaScript není refaktorování nutné.

  • Použití mezer

WordPress doporučuje vhodně používat mezery pro zlepšení čitelnosti vašeho zdrojového kódu, aby byl optimalizován pro prohlížeče, aby jej zpracovaly.

Předpisy o kódování potvrzují, že pro odsazení se musí použít tabulátor. Na prázdných řádcích a na konci řádků musí být odstraněny mezery. Každý řádek kódu by neměl přesáhnout 80 znaků. Složené závorky musí být použity pro bloky if/for/try a měly by být zadány na více řádcích.

závěr

Cílem standardů kódování je pomoci vývojářům vytvořit čitelný kód. Čím čistší kód vypadá, tím snazší je pro ostatní pochopit a implementovat. WordPress je open-source aplikace, která je podporována prostřednictvím příspěvků rostoucí komunity příznivců.

Takže při vytváření vašeho projektu WordPress nezapomeňte dodržovat pravidla kódování, abyste mohli přispět kvalitním kódováním.   

Související články

0 Komentáře
Vložené zpětné vazby
Zobrazit všechny komentáře
Tlačítko Nahoru