En guide om hur du förbättrar WordPress-kodningsstandarder
Om du är utvecklare letar du definitivt efter för att förbättra dina kodningsstandarder. Varje programmeringsspråk och deras CMS / Frameworks har satt upp sina egna standarder för kodning. I den här artikeln studerar vi hur vi kan förbättra WordPress-kodningsstandarder.
Vi har skrivit en artikel om att förbättra PHP-kodningsstandarder. Du bör först kontrollera den här artikeln innan du fortsätter för kodningsstandarder för WordPress-utveckling.
Fel vi gör under WordPress-programmering
Varje utvecklingsarbete har olika lösningar. Förmodligen implementerar varje utvecklare olika sätt / logik för att ge samma resultat. Det är naturligt i programmeringsvärlden.
Låt oss till exempel säga att vi har lagt till nonce i vårt registreringsformulär för att undvika CSRF-attacker.
<form method="post">
<?php wp_nonce_field( 'signup_nonce', 'signup_form_nonce' ); ?>
</form>När vi skickar in ett formulär måste vi verifiera om nonce är korrekt eller inte. Normalt gör en utvecklare som inte känner till kodningsstandarderna det på följande sätt.
<?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
}
?>Det finns inget fel i ovanstående kod. Men det är inte en bra praxis. När vi hämtar textfältvärden bör vi använda sanitize_text_field()och wp_unslash()fungera på inmatningsfältets värden.
sanitize_text_field- metoden gör följande i bakgrunden.
- Kontrollerar om ogiltig UTF-8
- Konverterar enstaka <tecken till enhet
- Stripar alla taggar
- Ta bort radbrytningar, flikar och extra vitt utrymme
- Strip oktetter
wp_unsplash- metoden tar bort snedstreck från en sträng eller en rad strängar.
Med detta sagt bör vår tidigare kod gilla nedan.
<?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
}
?>Detta är ett exempel. Det finns flera andra misstag vi gör i vår WordPress-programmering.
Installera WordPress Coding Standards Library
Detta bibliotek hjälper oss att förbättra våra kodningsstandarder i WordPress-utvecklingen och etablera oss som en bättre WordPress-utvecklare.
För att installera detta bibliotek öppnar du kommandotolken i root-katalogen för ett projekt och kör kommandot nedan.
composer create-project wp-coding-standards/wpcs --no-dev
Obs! Du bör ha en kompositör installerad i ditt system för att köra kommandot ovan.
Efter att ha kört kommandot kommer det att skapa en mapp som heter ‘wpcs’ i din projektkatalog.
Vi antar att du har läst vår artikel om förbättring av PHP-kodningsstandarder och att du har installerat PHP_CodeSniffer-biblioteket i mappen ‘php_codesniffer’ i projektets rotkatalog.
Därefter måste vi registrera WordPress-standarder i PHP_CodeSniffer-konfiguration. Öppna kommandotolken under ‘php_codesniffer / vendor / bin’ och kör kommandot nedan.
phpcs --config-set installed_paths /path/to/wpcs
Byt ut ‘/ path / to / wpcs’ med din sökväg. I vårt fall på Windows-plattformen skriver vi kommandot enligt följande.
phpcs --config-set installed_paths D:wampwwwwp1wpcs
Låt oss ta reda på våra misstag och förbättra WordPress-kodningsstandarder
Vi har bestämt oss för vårt bibliotek. Nu är det dags att hitta våra misstag och undvika det nästa gång.
Låt oss säga att vi har skapat ett plugin ‘test-plugin’ och vi måste validera en fil som heter ‘core.php’.
Öppna kommandotolken under katalogen ‘wpcs / vendor / bin’ och kör kommandot nedan.
phpcs --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
När du har kört kommandot kommer du att fråga med fel och varningar. Alla dessa fel och varningar visas eftersom vi inte har följt standardkodningsmetoderna för WordPress-utveckling.
En bra del är att vi får en detaljerad rapport om linjenumren och hur man rättar till det specifika felet. Vi behöver bara titta på riktlinjer och korrigera felen en efter en.
phpcbf kommandot kan också korrigera några mindre fel som indrag, mellanslag etc.
phpcbf --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Vi hoppas att du förstår hur du använder WordPress-kodningsstandardbiblioteket för att förbättra WordPress-kodningsstandarderna. Om du har några frågor eller förslag, vänligen lämna en kommentar nedan.