Opas WordPress-koodausstandardien parantamiseen

Jos olet kehittäjä, etsit varmasti parantamaan koodausstandardejasi. Jokainen ohjelmointikieli ja CMS / Framework ovat asettaneet omat standardinsa koodausta varten. Tässä artikkelissa tutkitaan, kuinka parantaa WordPress-koodausstandardeja.

Olemme kirjoittaneet artikkelin PHP-koodausstandardien parantamisesta. Tarkista ensin tämä artikkeli, ennen kuin etsit koodausstandardeja WordPress-kehitykseen.

Virheet, joita teemme WordPress-ohjelmoinnin aikana

Jokaisella kehitystyöllä on erilaisia ​​ratkaisuja. Todennäköisesti kukin kehittäjä toteuttaa eri tavan / logiikan saman tuotoksen tuottamiseksi. Se on luonnollista ohjelmointimaailmassa.

Oletetaan esimerkiksi, että olemme lisänneet rekisteröintilomakkeeseemme nonce välttääksemme CSRF-hyökkäykset.

<form method="post">
<?php wp_nonce_field( 'signup_nonce', 'signup_form_nonce' ); ?>
</form>

Lomaketta lähetettäessä meidän on tarkistettava, onko nonce oikea vai ei. Tavallisesti kehittäjä, joka ei tiedä koodausstandardeista, tekee sen seuraavalla tavalla.

<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( $_POST['signup_form_nonce'], 'signup_nonce')) {
 
   print 'Sorry, your nonce did not verify.';
   exit;
 
} else {
 
   // process form data
}
?>

Yllä olevassa koodissa ei ole mitään vikaa. Mutta se ei ole hyvä käytäntö. Kun haemme tekstikentän arvoja, meidän tulisi käyttää sanitize_text_field()ja wp_unslash()toimia syötekentän arvoissa.

sanitize_text_field- menetelmä tekee seuraavan prosessin taustalla.

• Tarkistaa virheellisen UTF-8: n
• Muuntaa yksittäiset <merkit kokonaisuudeksi
• Kaistaleet kaikki tunnisteet
• Poista rivinvaihdot, kielekkeet ja ylimääräinen välilyönti
• Nauhan oktetit

wp_unsplash- menetelmä poistaa kauttaviivat merkkijonosta tai merkkijonosta.

Tämän sanottuamme edellisen koodin pitäisi olla alla.

<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['signup_form_nonce']) ), 'signup_nonce')) {
 
   print 'Sorry, your nonce did not verify.';
   exit;
 
} else {
 
   // process form data
}
?>

Tämä on yksi esimerkki. WordPress-ohjelmoinnissamme on useita muita virheitä.

Asenna WordPress Coding Standards Library

Tämä kirjasto auttaa meitä parantamaan koodausstandardiamme WordPress-kehityksessä ja vakiinnuttamaan meidät paremmaksi WordPress-kehittäjäksi.

Asentaaksesi tämän kirjaston, avaa komentokehote projektin juurihakemistossa ja suorita alla oleva komento.

composer create-project wp-coding-standards/wpcs --no-dev

Huomaa: Järjestelmään tulisi olla asennettuna säveltäjä yllä olevan komennon suorittamiseksi.

Komennon suorittamisen jälkeen se luo kansion nimeltä wpcs projektin juurihakemistoon.

Oletamme, että olet lukenut artikkelimme PHP-koodausstandardien parantamisesta ja olet asentanut PHP_CodeSniffer-kirjaston php_codesniffer-kansioon projektin juurihakemistoon.

Seuraavaksi meidän on rekisteröitävä WordPress-standardit PHP_CodeSniffer-kokoonpanoon. Avaa komentokehote kohdassa ’php_codesniffer / vendor / bin’ ja suorita alla oleva komento.

phpcs --config-set installed_paths /path/to/wpcs

Korvaa ’/ path / to / wpcs’ polkusi kanssa. Meidän tapauksessamme Windows-alustalle kirjoitamme komennon seuraavasti.

phpcs --config-set installed_paths D:wampwwwwp1wpcs

Selvitetään virheemme ja parannetaan WordPress-koodausstandardeja

Olemme asettaneet kirjastomme kanssa. Nyt on aika löytää virheemme ja välttää se seuraavalla kerralla.

Oletetaan, että olemme luoneet laajennuksen ’test-plugin’ ja meidän on vahvistettava tiedosto nimeltä ’core.php’.

Avaa komentokehote hakemiston ’wpcs / vendor / bin’ alla ja suorita alla oleva komento.

phpcs --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php

Komennon suorittamisen jälkeen pyydät virheitä ja varoituksia. Kaikki nämä virheet ja varoitukset näkyvät, koska emme ole noudattaneet WordPress-kehityksen tavanomaisia ​​koodauskäytäntöjä.

Hyvä osa on, että saamme yksityiskohtaisen raportin rivinumeroista ja kuinka korjata kyseinen virhe. Meidän on vain tutkittava ohjeita ja korjattava virheet yksitellen.

phpcbf komento voi myös korjata pieniä virheitä, kuten sisennys, välilyönnit jne.

phpcbf --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php

Toivomme, että ymmärrät, kuinka voit käyttää WordPress-koodausstandardikirjastoa WordPress-koodausstandardien parantamiseen. Jos sinulla on kysyttävää tai ehdotuksia, jätä kommentti alla.