Eine Anleitung zur Verbesserung der WordPress-Codierungsstandards

Wenn Sie ein Entwickler sind, dann suchen Sie auf jeden Fall nach einer Verbesserung Ihrer Codierungsstandards. Jede Programmiersprache und ihre CMS/Frameworks haben ihre eigenen Standards für die Codierung aufgestellt. In diesem Artikel untersuchen wir, wie die WordPress-Codierungsstandards verbessert werden können.

Wir haben einen Artikel über die Verbesserung der PHP-Codierungsstandards geschrieben. Sie sollten zuerst diesen Artikel lesen, bevor Sie mit den Codierungsstandards für die WordPress-Entwicklung fortfahren.

Fehler, die wir bei der WordPress-Programmierung machen

Jede Entwicklungsarbeit hat andere Lösungen. Wahrscheinlich implementiert jeder Entwickler eine andere Methode/Logik, um dieselbe Ausgabe zu erzielen. Das ist in der Welt des Programmierens selbstverständlich.

Nehmen wir zum Beispiel an, wir haben Nonce in unserem Anmeldeformular hinzugefügt, um CSRF-Angriffe zu vermeiden.

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

Beim Absenden eines Formulars müssen wir überprüfen, ob die Nonce korrekt ist oder nicht. Normalerweise macht es ein Entwickler, der die Codierungsstandards nicht kennt, auf folgende Weise.

<?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
}
?>

An dem obigen Code ist nichts falsch. Aber es ist keine gute Praxis. Beim Abrufen von Textfeldwerten sollten wir sanitize_text_field()und wp_unslash()Funktionen für die Eingabefeldwerte verwenden.

Die Methode sanitize_text_field führt den folgenden Prozess im Hintergrund aus.

• Prüft auf ungültiges UTF-8
• Wandelt einzelne < Zeichen in Entität um
• Entfernt alle Tags
• Entfernen Sie Zeilenumbrüche, Tabulatoren und zusätzlichen Leerraum
• Strip-Oktette

wp_unsplash- Methode entfernt Schrägstriche aus einer Zeichenfolge oder einem Array von Zeichenfolgen.

Trotzdem sollte unser vorheriger Code wie folgt aussehen.

<?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
}
?>

Dies ist ein Beispiel. Es gibt mehrere andere Fehler, die wir in unserer WordPress-Programmierung machen.

Installieren Sie die WordPress Coding Standards Library

Diese Bibliothek wird uns helfen, unsere Codierungsstandards in der WordPress-Entwicklung zu verbessern und uns als besseren WordPress-Entwickler zu etablieren.

Um diese Bibliothek zu installieren, öffnen Sie Ihre Eingabeaufforderung im Stammverzeichnis eines Projekts und führen Sie den folgenden Befehl aus.

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

Hinweis: Sie sollten Composer auf Ihrem System installiert haben, um den obigen Befehl auszuführen.

Nach dem Ausführen des Befehls wird ein Ordner namens ‘wpcs’ in Ihrem Stammverzeichnis eines Projekts erstellt.

Wir gehen davon aus, dass Sie unseren Artikel zur Verbesserung der PHP-Codierungsstandards gelesen und die PHP_CodeSniffer-Bibliothek im Ordner „php_codesniffer” im Projektstammverzeichnis installiert haben.

Als nächstes müssen wir WordPress-Standards in der PHP_CodeSniffer-Konfiguration registrieren. Öffnen Sie die Eingabeaufforderung unter ‘php_codesniffer/vendor/bin’ und führen Sie den folgenden Befehl aus.

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

Ersetzen Sie ‘/path/to/wpcs’ durch Ihren Pfad. In unserem Fall schreiben wir auf der Windows-Plattform den Befehl wie folgt.

phpcs --config-set installed_paths D:wampwwwwp1wpcs

Lassen Sie uns unsere Fehler herausfinden und die WordPress-Codierungsstandards verbessern

Wir haben mit unserer Bibliothek eingestellt. Jetzt ist es an der Zeit, unsere Fehler zu finden und das nächste Mal zu vermeiden.

Nehmen wir an, wir haben ein Plugin ‘test-plugin’ erstellt und müssen eine Datei namens ‘core.php’ validieren.

Öffnen Sie die Eingabeaufforderung im Verzeichnis ‘wpcs/vendor/bin’ und führen Sie den folgenden Befehl aus.

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

Nachdem Sie den Befehl ausgeführt haben, werden Sie mit den Fehlern und Warnungen aufgefordert. All diese Fehler und Warnungen werden angezeigt, weil wir die Standard-Codierungspraktiken für die WordPress-Entwicklung nicht befolgt haben.

Ein guter Teil ist, dass wir den detaillierten Bericht über die Zeilennummern und die Korrektur dieses spezifischen Fehlers erhalten. Wir müssen uns nur die Richtlinien ansehen und die Fehler nacheinander korrigieren.

phpcbf Der Befehl kann auch einige kleinere Fehler wie Einrückungen, Leerzeichen usw. korrigieren.

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

Wir hoffen, dass Sie verstehen, wie Sie die WordPress-Codierungsstandards-Bibliothek verwenden, um die WordPress-Codierungsstandards zu verbessern. Wenn Sie Fragen oder Anregungen haben, hinterlassen Sie bitte unten einen Kommentar.