Una guida su come migliorare gli standard di codifica di WordPress
Se sei uno sviluppatore, sicuramente stai cercando di migliorare i tuoi standard di codifica. Ciascun linguaggio di programmazione e il relativo CMS/Framework ha stabilito i propri standard per la codifica. In questo articolo, studiamo come migliorare gli standard di codifica di WordPress.
Abbiamo scritto un articolo sul miglioramento degli standard di codifica PHP. Dovresti prima controllare questo articolo prima di procedere per gli standard di codifica per lo sviluppo di WordPress.
Errori che commettiamo durante la programmazione di WordPress
Ogni lavoro di sviluppo ha soluzioni diverse. Probabilmente ogni sviluppatore implementa modalità/logiche diverse per fornire lo stesso output. È naturale nel mondo della programmazione.
Ad esempio, supponiamo di aver aggiunto nonce nel nostro modulo di iscrizione per evitare attacchi CSRF.
<form method="post">
<?php wp_nonce_field( 'signup_nonce', 'signup_form_nonce' ); ?>
</form>
Durante l’invio di un modulo dobbiamo verificare se nonce è corretto o meno. Normalmente, uno sviluppatore che non conosce gli standard di codifica lo fa nel modo seguente.
<?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
}
?>
Non c’è niente di sbagliato nel codice sopra. Ma non è una buona pratica. Durante il recupero dei valori dei campi di testo, dovremmo usare sanitize_text_field()
e wp_unslash()
funzioni sui valori dei campi di input.
Il metodo sanitize_text_field esegue il seguente processo in background.
- Verifica la presenza di UTF-8 non valido
- Converte singoli < caratteri in entità
- Elimina tutti i tag
- Rimuovi interruzioni di riga, tabulazioni e spazi bianchi extra
- ottetti di striscia
Il metodo wp_unsplash rimuove le barre da una stringa o da un array di stringhe.
Detto questo, il nostro codice precedente dovrebbe essere come di seguito.
<?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
}
?>
Questo è un esempio. Ci sono molti altri errori che stiamo facendo nella nostra programmazione WordPress.
Installa la libreria degli standard di codifica di WordPress
Questa libreria ci aiuterà a migliorare i nostri standard di codifica nello sviluppo di WordPress e ad affermarci come sviluppatori WordPress migliori.
Per installare questa libreria, apri il prompt dei comandi nella directory principale di un progetto ed esegui il comando seguente.
composer create-project wp-coding-standards/wpcs --no-dev
Nota: dovresti avere il compositore installato nel tuo sistema per eseguire il comando sopra.
Dopo aver eseguito il comando, creerà una cartella chiamata "wpcs" nella directory principale di un progetto.
Supponiamo che tu abbia letto il nostro articolo sul miglioramento degli standard di codifica PHP e che tu abbia installato la libreria PHP_CodeSniffer all’interno della cartella ‘php_codesniffer’ nella directory principale del progetto.
Successivamente, dobbiamo registrare gli standard WordPress nella configurazione PHP_CodeSniffer. Apri il prompt dei comandi in "php_codesniffer/vendor/bin" ed esegui il comando seguente.
phpcs --config-set installed_paths /path/to/wpcs
Sostituisci ‘/path/to/wpcs’ con il tuo percorso. Nel nostro caso, su piattaforma Windows, scriviamo il comando come segue.
phpcs --config-set installed_paths D:wampwwwwp1wpcs
Scopriamo i nostri errori e miglioriamo gli standard di codifica di WordPress
Abbiamo impostato con la nostra libreria. Ora è il momento di trovare i nostri errori ed evitarli la prossima volta.
Diciamo che abbiamo creato un plugin ‘test-plugin’ e dobbiamo validare un file chiamato ‘core.php’.
Apri il prompt dei comandi nella directory "wpcs/vendor/bin" ed esegui il comando seguente.
phpcs --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Dopo aver eseguito il comando, verranno visualizzati gli errori e gli avvisi. Tutti questi errori e avvisi vengono visualizzati perché non abbiamo seguito le pratiche di codifica standard per lo sviluppo di WordPress.
Una buona parte è che otteniamo il rapporto dettagliato sui numeri di riga e su come correggere quell’errore specifico. Abbiamo solo bisogno di esaminare le linee guida e correggere gli errori uno per uno.
phpcbf
Il comando può anche correggere alcuni errori minori come rientri, spazi, ecc.
phpcbf --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Ci auguriamo che tu capisca come utilizzare la libreria degli standard di codifica di WordPress per migliorare gli standard di codifica di WordPress. Se hai domande o suggerimenti, lascia un commento qui sotto.