WordPress-Codierungsstandards sorgen für Konsistenz und Wartungsfreundlichkeit in der umfangreichen Codebasis der Plattform. Diese sorgfältig ausgearbeiteten Richtlinien destillieren WordPress-Entwicklungstipps und fördern Klarheit und Effizienz.
Wenn Sie diese WordPress-Wartungsleitfäden befolgen, können Entwickler weltweit harmonisch zusammenarbeiten und die Arbeit der anderen nahtlos verstehen. Bringen Sie Ihr WordPress-Entwicklungsteam dazu, die WordPress-Codierungsstandards gewissenhaft zu befolgen, um langfristig hochwertige, skalierbare und wartbare Lösungen zu gewährleisten.
Warum sollte man sich an die WordPress-Codierungsstandards halten?
WordPress-Codierungsstandards sollen die Konsistenz des Codes zwischen Projekten und Mitwirkenden sicherstellen. Sie verbessern die Lesbarkeit und Wartbarkeit für die gemeinsame Entwicklung und erleichtern die Codeüberprüfung und die Einhaltung von Best Practices im gesamten WordPress-Ökosystem.
Was sind WordPress-Codierungsstandards?
WordPress Coding Standards bieten eine Grundlage für die Zusammenarbeit und Konsistenz innerhalb des WordPress-Projekts und der Community, vom Kerncode bis zu Themes und Plugins. Diese von der WordPress-Community in Absprache mit dem WordPress-Support entwickelten Standards dienen als Best Practices, die WordPress-Entwickler und -Beitragende befolgen sollten.
Erfahren Sie mehr: Wie lassen sich die Auswirkungen von Drittanbieter-Code reduzieren?
Die Bedeutung von Kodierungsstandards
Kodierungsstandards helfen dabei, häufige Fehler zu vermeiden, die Lesbarkeit des Codes zu verbessern und Änderungen zu vereinfachen. Durch die Einhaltung dieser Standards erscheint der Code wie von einer einzigen Person geschrieben und ist somit für jeden leichter zu verstehen und zu ändern.
Beitrag zum WordPress-Kern
Wenn Sie zum WordPress-Kern beitragen, ist es wichtig, sich mit diesen Standards vertraut zu machen, da der eingereichte Code diesen entsprechen muss.
Kämpfen Sie mit der Einhaltung von Codierungsstandards für Ihre einzigartige WordPress-Website?
Überlassen Sie unseren erfahrenen WordPress-Entwicklern das Kopfzerbrechen!
Komponenten der WordPress-Codierungsstandards
Die Standards umfassen sprachspezifische Richtlinien für CSS, HTML, JavaScript und PHP sowie Zugänglichkeitsrichtlinien, die sich an WCAG AA orientieren.
Lesen Sie auch: Wie konvertiert man HTML in ein WordPress-Theme?
Ausnahme für Bibliotheken von Drittanbietern
In WordPress integrierte Bibliotheken von Drittanbietern sind jedoch von diesen Standards ausgenommen.
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 Code in WordPress.
PHP IN WORDPRESS
WordPress verwendet PHP-Updates als Kernprogrammiersprache. Die Einhaltung von PHP-Codierungsstandards ist entscheidend für wartbaren und konsistenten Code in WordPress. Hier erfahren Sie, warum PHP-Codierungsstandards wichtig sind:
Zeilenumbrüche
WordPress schreibt nicht viel über Zeilenumbrüche vor, aber es ist üblich, einen nach den meisten Anweisungen einzufügen. Außerdem wird empfohlen, Variablendefinitionen, if-Blöcke und Array-Elemente in separate Zeilen zu setzen.
Vertiefung
Um die Lesbarkeit Ihres Codes zu verbessern, sollten Sie ihn einrücken, um seine logische Struktur zu verdeutlichen. Tabulatoren sollten am Anfang von Zeilen verwendet werden, während Leerzeichen für die Einrückung in der Mitte von Zeilen verwendet werden.
Raumnutzung
Erleichtern Sie die Lesbarkeit Ihres Codes, indem Sie zusätzliche Leerzeichen am Ende der Zeilen entfernen. Eliminieren Sie außerdem Leerzeilen mit Tabulatoren oder nicht umbrechenden Leerzeichen. Verwenden Sie Leerzeichen innerhalb von Klammern, um die Übersichtlichkeit zu erhöhen. Fügen Sie nach einer öffnenden Klammer und vor einer schließenden Klammer einen Zeilenumbruch ein, es sei denn, es handelt sich um einen Tippfehler.
Zitate
In WordPress ist die wichtigste Regel, einfache Anführungszeichen für Zeichenketten zu verwenden, es sei denn, Sie werten etwas darin aus. Wenn Sie Anführungszeichen innerhalb einer Zeichenfolge benötigen, wechseln Sie zwischen einfachen und doppelten Anführungszeichen. Anführungszeichen zu umgehen ist erlaubt, aber selten notwendig.
Hosenträger
Der einfachste Weg ist, immer geschweifte Klammern zu verwenden. Während die Standards das Überspringen von geschweiften Klammern für einzeilige "if"-Anweisungen ohne mehrzeilige Blöcke in derselben Struktur erlauben, ist dies für einzeilige Schleifen nicht zulässig. Ich ziehe es vor, aus Gründen der Klarheit immer geschweifte Klammern zu verwenden. Außerdem schreiben die Standards vor, dass die öffnende geschweifte Klammer in der gleichen Zeile wie die erste Anweisung stehen muss, nicht wie in der PHP-Dokumentation darunter.
SQL-Abfragen formatieren
Denken Sie beim Schreiben von SQL-Abfragen daran, die Schlüsselwörter groß zu schreiben. Komplexe Abfragen sollten in mehrere Zeilen aufgeteilt werden. Es ist wichtig, Abfragen gut zu verstehen, insbesondere ihre Sicherheitsaspekte, auf die wir später noch eingehen werden. SQL-Injection-Angriffe erfolgen aufgrund von WordPress-Sicherheitsfehlern und ermöglichen es Hackern, direkt auf die Datenbank hinter einer WordPress-Website zuzugreifen und diese zu manipulieren.
Benennungskonventionen
Vermeiden Sie im WordPress-Code CamelCase für Namen. Funktionen sollten Kleinbuchstaben verwenden, ggf. mit Unterstrichen. Bei Klassennamen sollte der erste Buchstabe jedes Wortes groß geschrieben werden, getrennt durch Unterstriche.
Dateinamen sollten in Kleinbuchstaben geschrieben werden, mit Bindestrichen zwischen den Teilen. Wenn eine Datei eine einzelne Klasse enthält, benennen Sie sie nach der Klasse, mit dem Präfix "class-".
Verwenden Sie aus Gründen der Übersichtlichkeit Zeichenketten für Funktionsargumente anstelle von Booleschen Werten. Die wichtigste Regel ist, dass die Namen beschreibend sein sollten. In einer kollaborativen Umgebung sollten Sie darauf achten, dass jeder Ihren Code versteht.
Vergleichende Aussagen
Eine gute Praxis, nicht nur für WordPress, ist es, die Variable immer auf die rechte Seite eines Vergleichs zu setzen. Wenn Sie also ein Gleichheitszeichen vergessen, führt dies zu einem Fehler und nicht zu einem Ergebnis, das wahr ist. Wenn Sie ternäre Operatoren verwenden möchten, ist das erlaubt, aber es wird empfohlen, auf Wahrheit zu prüfen, um die Dinge klarer zu machen. Eine Ausnahme ist die Überprüfung auf nicht leere Variablen mit ! empty().
FORMATIERUNG HTML
Laut dem WordPress-Codex ist es wichtig, den gesamten HTML-Code mit dem W3C-Validator zu validieren. Gültiger Code bedeutet jedoch nicht immer, dass es sich um guten Code handelt, obwohl es einen klaren Zusammenhang zwischen beiden gibt.
Doctype
WordPress folgt der vom W3C im Jahr 2000 empfohlenen Spezifikation XHTML 1.0. Trotzdem verwendet das Twenty Eleven-Theme, ein Standardthema in WordPress, HTML5. Es gibt keinen wirklichen Konflikt, da HTML5 die XML-Serialisierung beinhaltet und die Verwendung von "XHTML5" ermöglicht.
Zitate verwenden
In HTML werden Anführungszeichen hauptsächlich für Attribute und deren Werte verwendet. Sie können zwischen einfachen und doppelten Anführungszeichen wählen, aber bleiben Sie konsequent bei einem Typ. Ich persönlich verwende, wenn möglich, einfache Anführungszeichen, wie ich es auch in PHP tue, um Konsistenz zu gewährleisten. So kann ich Sonderfälle in einer Zeile schnell erkennen, indem ich mir die Anführungszeichen ansehe.
Abschließende Tags
Die XHTML-Spezifikation schreibt das Schließen aller Tags vor. Void-Elemente müssen mit einem Schrägstrich kurz vor der letzten spitzen Klammer geschlossen werden. Achten Sie darauf, dass vor dem Schrägstrich ein Leerzeichen steht, wie angegeben.
Vertiefung
Richten Sie sich bei der Einrückung von HTML nach den gleichen Regeln wie bei PHP. Achten Sie bei der Einrückung auf eine logische Struktur. Wenn Sie PHP und HTML kombinieren, rücken Sie die PHP-Blöcke entsprechend dem üblichen Einrückungsfluss ein.
CSS FORMATIEREN
Bei der Formatierung von CSS geht es darum, die Darstellung von Webinhalten zu organisieren und zu gestalten, um Konsistenz und Lesbarkeit auf verschiedenen Geräten und Browsern zu gewährleisten. Richtig formatiertes CSS verbessert die Struktur und die visuelle Anziehungskraft von Websites und trägt so zu einem besseren Nutzererlebnis bei.
Lesen Sie mehr: Wie entfernt man unbenutzte CSS in WordPress?
Einrückung und Struktur
Ihr CSS sollte diesem groben Schema folgen: Schreiben Sie jeden Selektor in eine eigene Zeile, auch wenn Sie mehrere Selektoren für einen Regelsatz auflisten. Auch jedes Eigenschafts-Wert-Paar sollte in einer eigenen Zeile stehen. Setzen Sie die öffnende geschweifte Klammer in die Zeile des Selektors und die schließende geschweifte Klammer in eine separate Zeile mit der gleichen Einrückung wie die des öffnenden Selektors.
Benennungskonventionen
Verwenden Sie nur Kleinbuchstaben. Trennen Sie Wörter innerhalb eines Selektors mit einem Bindestrich. Geben Sie Ihren Selektoren von Menschen lesbare Namen.
Eigenschaften und Werte
Es gibt eine ganze Reihe von Regeln für das Schreiben von Eigenschaften und Werten. Verwenden Sie, wo immer möglich, Kurzversionen von Eigenschaften, es sei denn, Sie überschreiben eine zuvor definierte Eigenschaft. Verwenden Sie HEX-Kleinbuchstaben für Farben, wo immer dies möglich ist. Verwenden Sie gegebenenfalls die kürzere Version. Fügen Sie ein Leerzeichen nach dem Doppelpunkt ein, der einer Eigenschaft folgt. Verwenden Sie immer Kleinbuchstaben, es sei denn, ein Großbuchstabe ist erforderlich, wie z. B. bei Schriftartennamen und herstellerspezifischen Eigenschaften. Ordnen Sie CSS-Eigenschaften alphabetisch an, mit Ausnahme von anbieterspezifischen Eigenschaften, die immer vor ihrem allgemeinen Gegenstück stehen sollten, und dimensionellen Eigenschaften, die in Gruppen zusammengefasst werden sollten. Wenn Breite und Höhe angegeben sind, schreiben Sie die Breite zuerst.
Kommentar
CSS unterstützt nur eine Art der Kommentierung - den Blockstil; es gibt keine separate Notation für Inline-Kommentare. Schreiben Sie kurze Kommentare in eine Zeile, ohne einen Zeilenumbruch darunter. Bei Kommentaren, die sich über mehrere Zeilen erstrecken, fügen Sie einen Zeilenumbruch unmittelbar nach der einleitenden Syntax und einen Zeilenumbruch unmittelbar vor der abschließenden Syntax ein. Wenn Sie Kommentare verwenden, um Abschnitte des Codes abzugrenzen, dann verwenden Sie die folgende Notation:
Verwendung von CSS-Präprozessoren
Die Verwendung von CSS-Präprozessoren wie SASS und Less macht unser Leben als Entwickler sehr viel einfacher, aber sie sind nicht ohne Nachteile. Der von diesen Tools erzeugte Code ist in der Regel gültig, kann aber nicht als besonders sauber bezeichnet werden. Ein von Hand (und mit Bedacht) erstelltes Stylesheet wird viel lesbarer sein als ein automatisch von Less erzeugtes. Es hängt davon ab, was Sie tun. Wenn Ihr Produkt kommerziell ist, dann ist das ultimative Ziel eine gute Benutzererfahrung mit gültigem und optimiertem Code. In diesem Fall sollten Sie die Ausgabe des Präprozessors als Haupt-CSS verwenden, aber die Originaldatei für die Entwickler einbinden. Ihr CSS wird zwar nicht den WordPress-Standards entsprechen, aber die Einbeziehung der Originaldatei überbrückt die Zeit, bis WordPress eine offizielle Stellungnahme abgibt. Es ist in Ordnung, CSS-Codierungsstandards zu opfern, um den Entwicklungsprozess zu vereinfachen (mit dem Ziel einer besseren Benutzerfreundlichkeit). Die Gültigkeit des Codes zu opfern ist es nicht.
Wie können Sie zu den WordPress-Codierungsstandards beitragen?
Mit dem Code ist es wie mit dem Schreiben - jeder hat seinen eigenen, einzigartigen Stil. Ihr HTML könnte anders aussehen als meines, mein JavaScript könnte Ihnen die Augen bluten lassen, und Ihr CSS könnte lebensverändernd schön sein. Aber wenn es um die Zusammenarbeit an einem Projekt wie WordPress geht, sind einheitliche Codierungsstandards von entscheidender Bedeutung.
Die WordPress-Codierungsstandards sollen sicherstellen, dass jeder, der zur Codebasis beiträgt, die Arbeit anderer problemlos lesen, verstehen und darauf aufbauen kann. Wenn Sie sich an diese Standards halten, sprechen Sie im Grunde die gleiche Sprache wie andere Mitwirkende. Es ist so, als würde man sich darauf einigen, einheitliche Grammatik- und Formatierungsregeln zu verwenden, damit alle nahtlos an demselben Buch mitarbeiten können.
Wenn Sie zu WordPress beitragen möchten, ist es wichtig, sich mit den Codierungsstandards vertraut zu machen und diese zu befolgen. So kann Ihr individueller Codierungsstil perfekt in die größere WordPress-Codebasis integriert werden.
Schlussfolgerungen
Die Einhaltung der WordPress-Codierungsstandards ist für die Aufrechterhaltung einer kohärenten und kooperativen Codebasis unerlässlich. Diese Richtlinien, die von der WordPress-Community entwickelt wurden, dienen als gemeinsame Sprache für alle, die weltweit daran mitarbeiten. Durch die Einhaltung der Standards für PHP, HTML, CSS, JavaScript und Barrierefreiheit können Entwickler sicherstellen, dass ihr Code konsistent, lesbar und wartbar ist.
Bei der weiteren Entwicklung von WordPress werden diese Codierungsstandards eine entscheidende Rolle bei der Förderung einer harmonischen und effizienten Entwicklungsumgebung für die gesamte Community spielen.
