Die WordPress-Codierungsstandards Eine Einführung

Beim Erstellen von WordPress-basierten Produkten sind wir mit einem zweischneidigen Schwert etwas verflucht (oder gesegnet, je nachdem, wie Sie es sehen): Da WordPress in PHP geschrieben ist, ist es relativ einfach, WordPress - oder das Projekt selbst - um zu tun, was immer es ist, wollen wir all das tun und gleichzeitig Best Practices vermeiden.

Dies wirft jedoch die Frage auf: Was ist der Sinn von API- oder formalen Codierungsstandards, wenn wir sie einfach ignorieren?

Wir haben in den vorangegangenen Artikeln viel über die WordPress-APIs geschrieben und die WordPress-Codierungsstandards angesprochen, aber wir haben uns nie wirklich mit den Codierungsstandards beschäftigt, jeden Aspekt davon verstehen und warum Angelegenheit.

In dieser Serie werden wir genau das tun.


Warum sich mit Codierungsstandards beschäftigen?

Bevor wir uns alles ansehen, was wir behandeln werden, denke ich, ist es wichtig zu verstehen, warum Kodierungsstandards überhaupt eine Rolle spielen.

WordPress wird häufig von verwendet viel von Menschen mit viel von Standorten. Es wird viel Code eingesetzt, der alle auf der Kernanwendung basiert. Dies bedeutet, dass es Entwickler und Designer gibt, die an der Pflege dieser Codebasis arbeiten.

Die Herausforderung besteht darin, dass die Person, die den Code ursprünglich nicht geschrieben hat, mit der Verbesserung, Verwaltung und Behebung von Fehlern für das Projekt beschäftigt ist. Nehmen wir an, die erste Person hat sich nicht an die Kodierungsstandards gehalten, aber die Person, die jetzt den Code verwaltet, ist es gewohnt, Best Practices zu befolgen.

Sie müssen sich jetzt mit Code befassen, der nicht so aussieht, wie WordPress-Code aussehen sollte.

Und das ist wirklich der entscheidende Punkt: Der Code, aus dem unsere Themes, unsere Plugins und in unseren Anwendungen bestehen, sollte idealerweise so aussehen, als würde ein einzelner Entwickler den Code geschrieben haben.

Das ist welche Kodierungsstandards durchsetzen.

Leider werden Standards entweder ignoriert oder nicht ausreichend evangelisiert, obwohl sie gut dokumentiert sind. An dieser Stelle kommt diese Artikelserie ins Spiel: Wir werden uns eingehend mit den Standards befassen, um zu evangelisieren, zu verstehen und einander zu ermutigen, eine bessere Arbeit zu beginnen.


Ein Blick auf die Kodierungsstandards

Diese Serie wird zusätzlich zu diesem einleitenden Stück sieben Artikel enthalten.

Hier sind wir mit dieser speziellen Serie unterwegs:

  1. Namenskonventionen und Funktionsargumente - Wir werden einen Blick darauf werfen, wie wir unsere Variablen, Methoden und Klassen so benennen sollten, dass sie klar und leicht verständlich sind und für uns und andere Entwickler folgen.
  2. Die Verwendung von einfachen Anführungszeichen und doppelten Anführungszeichen - Einfache Anführungszeichen und doppelte Anführungszeichen führen zu unterschiedlichem Verhalten in PHP, und es gibt eine Zeit und einen Ort, an dem wann welche in WordPress verwendet werden sollen. In diesem Artikel werfen wir einen Blick auf Beispiele und die Gründe dafür, was wir tun.
  3. Einrückung, Speicherplatznutzung und nachfolgende Leerzeichen - Leerzeichen spielen beim Schreiben von WordPress-Code eine große Rolle. In diesem Artikel werden die Gründe erläutert, warum Einrückung und Leerzeichen von Bedeutung sind, wann Registerkarten verwendet werden und wann Leerzeichen verwendet werden.
  4. Klammerstil, reguläre Ausdrücke und PHP-Tags - Verschiedene Sprachen im C-Stil verwenden unterschiedliche Syntax. In diesem Artikel wird untersucht, wie Sie in WordPress-basierten Code Klammern einfügen. Wir werden auch prüfen, wie reguläre Ausdrücke richtig eingebunden werden können, sowie einige der bewährten Vorgehensweisen und bewährten Methoden für die Verwendung von PHP-Tags.
  5. Die ternären Betreiber- und Yoda-Bedingungen - Bedingte Anweisungen sind ein Eckpfeiler der Programmierung und werden in WordPress großzügig verwendet. PHP bietet eine Abkürzung für if / else-Anweisungen und WordPress entscheidet sich dafür, Bedingungen anders zu bewerten als andere Sprachen, die häufig unterstützt werden. Hier werfen wir einen Blick auf all das.
  6. Datenbankabfragen und Formatieren von SQL-Abfragen - Es gibt eine vollständige API zum Ausführen von Abfragen für die WordPress-Datenbank. Es gibt jedoch auch Möglichkeiten, Raw-SQL auszuführen. Wenn Sie diesen Weg jemals gehen müssen, gibt es einen richtigen Weg. In diesem Artikel wird genau das betrachtet.
  7. Alles zusammenbringen - Abschließend wollen wir alles, was wir in der gesamten Serie besprochen haben, zusammenfassen, um sicherzustellen, dass wir alle auf derselben Seite sind, und um uns dazu zu drängen, die Standards besser einzuhalten.

Fazit

Wenn es ums Bloggen geht, wird oft davon ausgegangen, dass der Autor ein Experte für das vorliegende Thema ist. Die Wahrheit ist jedoch, obwohl ich fest davon überzeugt bin, dass wir die Kodierungsstandards einhalten sollten und dass ich versuche, sie nach besten Kräften einzuhalten Ich lerne jede Woche.

Ich habe viele Male gegen die Kodierungsstandards verstoßen, und ich bin sicher, dass einige von Ihnen dies auch getan haben.

Der Sinn dieser Serie besteht darin, die Standards gemeinsam durchzugehen, damit wir alle zu besseren Entwicklern werden können, wenn wir fertig sind.