Der ultimative Leitfaden zu WordPress-Codierungsstandards: Unverzichtbar für Entwickler

Die WordPress -Codierungsstandards gewährleisten Konsistenz und Wartbarkeit im gesamten umfangreichen Quellcode der Plattform. Diese sorgfältig ausgearbeiteten Richtlinien fassen die wichtigsten Tipps für die WordPress-Entwicklung und fördern so Klarheit und Effizienz.

Durch die Einhaltung dieser WordPress- Wartungsleitfäden tragen Entwickler weltweit harmonisch zusammen und verstehen die Arbeit der anderen nahtlos. Sorgen Sie dafür, dass Ihr WordPress-Entwicklungsteam die WordPress-Codierungsstandards gewissenhaft befolgt, um langfristig hochwertige, skalierbare und wartungsfreundliche Lösungen zu gewährleisten.

Warum sollte man sich an die WordPress-Codierungsstandards halten?

Die WordPress-Codierungsstandards zielen darauf ab, die Codekonsistenz über Projekte und Mitwirkende hinweg zu gewährleisten. Sie verbessern die Lesbarkeit und Wartbarkeit für die kollaborative Entwicklung und erleichtern Code-Reviews sowie die Einhaltung bewährter Verfahren im gesamten WordPress-Ökosystem.

Was sind die WordPress-Codierungsstandards?

Die WordPress-Codierungsstandards bilden die Grundlage für Zusammenarbeit und Einheitlichkeit im gesamten WordPress-Projekt und der Community – vom Quellcode bis hin zu Themes und Plugins. Diese Standards, die von der WordPress-Community in Abstimmung mit den WordPress-Supportforen dienen als Best Practices, die WordPress-Entwickler und -Mitwirkende befolgen sollten.

Mehr erfahren : Wie lässt sich der Einfluss von Drittanbietercode reduzieren?

Bedeutung von Codierungsstandards

Programmierrichtlinien helfen, häufige Fehler zu vermeiden, die Lesbarkeit des Codes zu verbessern und Änderungen zu vereinfachen. Durch deren Einhaltung wirkt der Code, als sei er von einer einzigen Person geschrieben worden, wodurch er für jeden leichter verständlich und änderbar wird.

Beitrag zum WordPress-Kern

Wenn Sie zum WordPress-Kern beitragen möchten, ist es unerlässlich, sich mit diesen Standards vertraut zu machen, da der eingereichte Code diesen entsprechen muss.

Bestandteile der WordPress-Codierungsstandards

Die Standards umfassen sprachspezifische Richtlinien für CSS, HTML, JavaScript und PHP sowie an WCAG AA ausgerichtete Richtlinien zur Barrierefreiheit.

Lesen Sie auch: Wie konvertiert man HTML in ein WordPress-Theme?

Ausnahme für Drittanbieterbibliotheken

Von diesen Standards ausgenommen sind jedoch Drittanbieterbibliotheken, die in WordPress integriert sind.

Beispiele für WordPress-Codierungsstandards

Lassen Sie uns die WordPress-Codierungsstandards anhand verschiedener Beispiele erkunden, um ihre Anwendung in realen Szenarien zu verstehen. Diese Beispiele veranschaulichen die empfohlenen Best Practices für das Schreiben von klarem und wartbarem WordPress-Code.

PHP IN WORDPRESS

WordPress verwendet PHP als Kernprogrammiersprache. Die Einhaltung der PHP-Codierungsstandards ist entscheidend für wartbaren und konsistenten Code in WordPress. Hier erfahren Sie, warum PHP-Codierungsstandards wichtig sind:

Zeilenumbrüche

WordPress gibt keine genauen Vorgaben zu Zeilenumbrüchen, es ist aber üblich, nach den meisten Anweisungen einen einzufügen. Außerdem empfiehlt es sich, Variablendefinitionen, if-Anweisungen und Array-Elemente in separate Zeilen zu schreiben.

Vertiefung

Um Ihren Code lesbarer zu gestalten, verwenden Sie Einrückungen, um seine logische Struktur zu verdeutlichen. Verwenden Sie Tabulatoren am Zeilenanfang und Leerzeichen zur Einrückung innerhalb einer Zeile.

Raumnutzung

Verbessern Sie die Lesbarkeit Ihres Codes, indem Sie überflüssige Leerzeichen am Zeilenende entfernen. Vermeiden Sie außerdem leere Zeilen mit Tabulatoren oder geschützten Leerzeichen. Verwenden Sie Leerzeichen innerhalb von Klammern, um die Lesbarkeit zu verbessern. Fügen Sie nach einer öffnenden und vor einer schließenden geschweiften Klammer einen Zeilenumbruch ein, außer bei Typumwandlungen.

Zitate

In WordPress gilt die Grundregel, Zeichenketten in einfache Anführungszeichen zu setzen, es sei denn, sie werden innerhalb einer Zeichenkette ausgewertet. Benötigen Sie Anführungszeichen innerhalb einer Zeichenkette, wechseln Sie zwischen einfachen und doppelten Anführungszeichen. Das Maskieren von Anführungszeichen ist zwar erlaubt, aber selten notwendig.

Zahnspange

Am einfachsten ist es, immer geschweifte Klammern zu verwenden. Zwar erlauben die Standards, bei einzeiligen „if“-Anweisungen ohne mehrzeilige Blöcke innerhalb derselben Struktur auf geschweifte Klammern zu verzichten, dies ist jedoch bei einzeiligen Schleifen nicht zulässig. Ich bevorzuge aus Gründen der Übersichtlichkeit die Verwendung von geschweiften Klammern. Darüber hinaus schreiben die Standards vor, dass die öffnende geschweifte Klammer in derselben Zeile wie die erste Anweisung stehen muss, nicht darunter, wie in der PHP-Dokumentation angegeben.

Formatieren von SQL-Abfragen

Denken Sie beim Schreiben von SQL-Abfragen daran, die Schlüsselwörter großzuschreiben. Komplexe Abfragen sollten auf mehrere Zeilen aufgeteilt werden. Es ist wichtig, Abfragen gut zu verstehen, insbesondere ihre Sicherheitsaspekte, die wir später besprechen werden. SQL-Injection-Angriffe entstehen durch Sicherheitslücken in WordPress und ermöglichen es Hackern, direkt auf die Datenbank einer WordPress-Website zuzugreifen und diese zu manipulieren.

Namenskonventionen

In WordPress-Code sollte CamelCase für Namen vermieden werden. Funktionen sollten Kleinbuchstaben verwenden, gegebenenfalls mit Unterstrichen. Klassennamen sollten jeweils mit einem Großbuchstaben beginnen und durch Unterstriche getrennt werden.

Dateinamen sollten ausschließlich aus Kleinbuchstaben bestehen und durch Bindestriche getrennt sein. Enthält eine Datei nur eine Klasse, benennen Sie sie nach der Klasse und stellen Sie „Klasse-“ davor.

Verwenden Sie zur besseren Lesbarkeit Zeichenketten anstelle von booleschen Werten für Funktionsargumente. Die wichtigste Regel ist, aussagekräftige Namen zu wählen. In einem kollaborativen Umfeld sollten Sie darauf achten, dass Ihr Code für alle verständlich ist.

Vergleichsaussagen

Es empfiehlt sich, nicht nur für WordPress, die Variable immer rechts in einem Vergleich zu platzieren. So führt ein fehlendes Gleichheitszeichen zu einem Fehler, anstatt dass die Bedingung als wahr ausgewertet wird. Die Verwendung ternärer Operatoren ist zwar möglich, es wird jedoch empfohlen, auf Wahrheit zu prüfen, um die Lesbarkeit zu verbessern. Eine Ausnahme bildet die Prüfung auf nicht leere Variablen mit `!empty()`.

HTML formatieren

Laut WordPress Codex ist es wichtig, den gesamten HTML-Code mit dem W3C-Validator zu überprüfen. Gültiger Code ist jedoch nicht immer gleichbedeutend mit gutem Code, obwohl ein klarer Zusammenhang zwischen beidem besteht.

Dokumenttyp

WordPress folgt der XHTML-1.0-Spezifikation, die vom W3C im Jahr 2000 empfohlen wurde. Trotzdem verwendet das Standard-Theme „Twenty Eleven“ in WordPress HTML5. Es besteht kein wirklicher Konflikt, da HTML5 die XML-Serialisierung beinhaltet und somit die Verwendung von „XHTML5“ ermöglicht

Verwendung von Zitaten

In HTML werden Anführungszeichen hauptsächlich für Attribute und deren Werte verwendet. Sie können einfache oder doppelte Anführungszeichen verwenden, sollten aber konsequent bei einem Typ bleiben. Ich persönlich verwende, wie auch in PHP, nach Möglichkeit einfache Anführungszeichen, um eine einheitliche Vorgehensweise zu gewährleisten. Dadurch kann ich Sonderfälle in einer Zeile schnell erkennen, indem ich einfach auf die Anführungszeichen schaue.

Schluss-Tags

Die XHTML-Spezifikation schreibt vor, dass alle Tags geschlossen werden müssen. Leere Elemente müssen mit einem Schrägstrich direkt vor der letzten spitzen Klammer geschlossen werden. Achten Sie darauf, dass vor dem Schrägstrich, wie vorgeschrieben, ein Leerzeichen steht.

Vertiefung

Richten Sie beim Einrücken Ihres HTML-Codes dieselben Regeln wie beim PHP-Code aus. Achten Sie dabei auf eine logische Struktur. Wenn Sie PHP und HTML kombinieren, rücken Sie die PHP-Blöcke entsprechend dem üblichen Einrückungsablauf ein.

CSS-Formatierung 

Die CSS-Formatierung umfasst die Organisation und Gestaltung der Darstellung von Webinhalten und gewährleistet Konsistenz und Lesbarkeit auf verschiedenen Geräten und Browsern. Korrekt formatiertes CSS verbessert die Struktur und das visuelle Erscheinungsbild von Websites und trägt so zu einer besseren Benutzererfahrung bei.

Weiterlesen: Wie entfernt man ungenutztes CSS in WordPress?

Eindringung und Struktur

Ihr CSS sollte diesem Schema folgen: Schreiben Sie jeden Selektor in eine separate Zeile, auch wenn Sie mehrere Selektoren für ein Regelset auflisten. Jedes Eigenschaft-Wert-Paar sollte ebenfalls in einer eigenen Zeile stehen. Setzen Sie die öffnende geschweifte Klammer in die Zeile des Selektors und die schließende Klammer in eine separate Zeile mit demselben Einzug wie die öffnende geschweifte Klammer des Selektors.

Namenskonventionen

Verwenden Sie ausschließlich Kleinbuchstaben. Trennen Sie Wörter innerhalb eines Selektors durch einen Bindestrich. Geben Sie Ihren Selektoren aussagekräftige Namen.

Eigenschaften und Werte

Es gibt einige Regeln für die Schreibweise von Eigenschaften und Werten. Verwenden Sie nach Möglichkeit Kurzformen von Eigenschaften, außer beim Überschreiben einer bereits definierten Eigenschaft. Verwenden Sie nach Möglichkeit Kleinbuchstaben im Hexadezimalcode für Farben. Verwenden Sie gegebenenfalls die Kurzform. Fügen Sie nach dem Doppelpunkt am Ende einer Eigenschaft ein Leerzeichen ein. Verwenden Sie immer Kleinbuchstaben, außer wenn Großbuchstaben erforderlich sind, z. B. bei Schriftartnamen und herstellerspezifischen Eigenschaften. Ordnen Sie CSS-Eigenschaften alphabetisch an, mit Ausnahme von herstellerspezifischen Eigenschaften, die immer vor ihren allgemeinen Pendants stehen sollten, und Dimensions-Eigenschaften, die zusammen gruppiert werden sollten. Wenn Breite und Höhe angegeben sind, schreiben Sie die Breite zuerst.

Kommentar

CSS unterstützt nur einen Kommentartyp – den Blockkommentar; es gibt keine separate Notation für Inline-Kommentare. Kurze Kommentare schreiben Sie in einer Zeile ohne Zeilenumbruch. Bei Kommentaren, die sich über mehrere Zeilen erstrecken, fügen Sie einen Zeilenumbruch direkt nach dem öffnenden und einen vor dem schließenden </code> ein. Wenn Sie Kommentare verwenden, um Codeabschnitte abzugrenzen, verwenden Sie die folgende Notation:

Verwendung von CSS-Präprozessoren

Die Verwendung von CSS-Präprozessoren wie SASS und Less erleichtert uns Entwicklern die Arbeit erheblich, hat aber auch Nachteile. Der von diesen Tools erzeugte Code ist zwar meist gültig, aber nicht unbedingt sauber. Ein manuell (und sorgfältig) erstelltes Stylesheet ist deutlich lesbarer als eines, das automatisch von Less generiert wird. Es kommt darauf an, was Sie vorhaben. Bei kommerziellen Produkten steht eine gute Benutzererfahrung mit gültigem und optimiertem Code an erster Stelle. In diesem Fall verwenden Sie die Ausgabe des Präprozessors als Haupt-CSS, stellen den Entwicklern aber zusätzlich die Originaldatei zur Verfügung. Auch wenn Ihr CSS dann nicht den WordPress-Standards entspricht, überbrückt die Bereitstellung der Originaldatei die Lücke, bis WordPress eine offizielle Position bezieht. CSS-Codierungsstandards zugunsten einer einfacheren Entwicklung (und einer besseren Benutzererfahrung) zu vernachlässigen, ist in Ordnung. Die Gültigkeit des Codes zu opfern, ist jedoch nicht akzeptabel.

Wie können Sie zu den WordPress-Codierungsstandards beitragen?

Programmieren ist wie Schreiben – jeder hat seinen eigenen Stil. Dein HTML sieht vielleicht anders aus als meines, mein JavaScript ist womöglich grauenhaft, und dein CSS ist vielleicht atemberaubend schön. Doch gerade bei der Zusammenarbeit an einem Projekt wie WordPress sind einheitliche Codierungsstandards unerlässlich.

Die WordPress-Codierungsstandards sollen sicherstellen, dass jeder, der zum Quellcode beiträgt, die Arbeit anderer leicht lesen, verstehen und darauf aufbauen kann. Indem Sie diese Standards einhalten, sprechen Sie im Grunde dieselbe Sprache wie alle anderen Mitwirkenden. Es ist, als würden Sie sich auf einheitliche Grammatik- und Formatierungsregeln einigen, damit alle reibungslos an demselben Buch zusammenarbeiten können.

Wer zu WordPress beitragen möchte, sollte sich unbedingt mit den Codierungsstandards vertraut machen und diese befolgen. So lässt sich der eigene Programmierstil optimal in die bestehende WordPress-Quellcodebasis integrieren.

Schlussfolgerungen

Die Einhaltung der WordPress-Codierungsstandards ist unerlässlich für eine einheitliche und kollaborative Codebasis. Diese von der WordPress-Community entwickelten Richtlinien dienen als gemeinsame Sprache für Mitwirkende weltweit. Durch die Befolgung der Standards für PHP, HTML, CSS, JavaScript und Barrierefreiheit stellen Entwickler sicher, dass ihr Code konsistent, lesbar und wartbar ist.

Da sich WordPress ständig weiterentwickelt, werden diese Codierungsstandards eine entscheidende Rolle bei der Förderung einer harmonischen und effizienten Entwicklungsumgebung für die gesamte Community spielen.