WordPress -Codierungsstandards gewährleisten Konsistenz und Wartbarkeit in der umfangreichen Codebasis der Plattform. Diese sorgfältig ausgearbeiteten Richtlinien destillieren WordPress-Entwicklungstipps und fördern Klarheit und Effizienz.
Durch die Befolgung dieser WordPress- Wartungsleitfäden leisten Entwickler weltweit einen harmonischen Beitrag und verstehen die Arbeit des anderen nahtlos. Lassen Sie Ihr WordPress-Entwicklungsteam die WordPress-Codierungsstandards sorgfältig befolgen, um langfristig qualitativ hochwertige, skalierbare und wartbare Lösungen sicherzustellen.
Warum sollten Sie sich an die Codierungsstandards von WordPress halten?
WordPress-Codierungsstandards zielen darauf ab, die Codekonsistenz über Projekte und Mitwirkende hinweg sicherzustellen. Es verbessert die Lesbarkeit und Wartbarkeit für die gemeinsame Entwicklung und erleichtert Codeüberprüfungen 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 im gesamten WordPress-Projekt und in der Community, vom Kerncode bis hin zu Themes und Plugins. Diese von der WordPress-Community in Absprache mit WordPress-Supportforen dienen als Best Practices, die WordPress-Entwickler und Mitwirkende befolgen sollten.
Erfahren Sie mehr : Wie kann die Auswirkung von Code Dritter reduziert werden?
Bedeutung von Codierungsstandards
Codierungsstandards tragen dazu bei, häufige Fehler zu vermeiden, die Lesbarkeit des Codes zu verbessern und Änderungen zu vereinfachen. Durch deren Einhaltung erscheint der Code so, als ob er von einer einzelnen Person geschrieben worden wäre, sodass er für jedermann leichter zu verstehen und zu ändern ist.
Beitrag zum WordPress Core
Wenn Sie zum WordPress-Kern beitragen, ist es wichtig, sich mit diesen Standards vertraut zu machen, da der eingereichte Code diesen Standards entsprechen muss.
Haben Sie Schwierigkeiten, die Codierungsstandards für Ihre einzigartige WordPress-Site einzuhalten?
Lassen Sie unsere erfahrenen WordPress-Entwickler die Kopfschmerzen in den Griff bekommen!
Komponenten der WordPress-Codierungsstandards
Die Standards umfassen sprachspezifische Richtlinien für CSS, HTML, JavaScript und PHP sowie Richtlinien zur Barrierefreiheit, die an WCAG AA ausgerichtet sind.
Lesen Sie auch: Wie konvertiert man HTML in ein WordPress-Theme?
Ausnahme für Drittbibliotheken
Allerdings sind in WordPress integrierte Bibliotheken von Drittanbietern 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 zum Schreiben von klarem und wartbarem Code in WordPress.
PHP IN WORDPRESS
WordPress verwendet PHP-Updates als Kernprogrammiersprache. Die Einhaltung der PHP-Codierungsstandards ist entscheidend für wartbaren und konsistenten Code in WordPress. Aus diesem Grund sind PHP-Codierungsstandards wichtig:
Zeilenumbrüche
WordPress macht nicht viele Angaben zu Zeilenumbrüchen, aber es ist üblich, nach den meisten Anweisungen einen 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, verwenden Sie Einrückungen, um seine logische Struktur anzuzeigen. Tabulatoren sollten am Zeilenanfang verwendet werden, während Leerzeichen zum Einrücken in der Mitte der Zeile verwendet werden.
Raumnutzung
Machen Sie Ihren Code leichter lesbar, indem Sie alle zusätzlichen Leerzeichen am Zeilenende entfernen. Vermeiden Sie außerdem Leerzeilen mit Tabulatoren oder geschützten Leerzeichen. Verwenden Sie zur besseren Übersichtlichkeit Leerzeichen in Klammern. Fügen Sie nach einer öffnenden Klammer und vor einer schließenden Klammer einen Zeilenumbruch ein, außer zur Typumwandlung.
Zitate
In WordPress besteht die Hauptregel darin, einfache Anführungszeichen für Zeichenfolgen 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. Das Escapen von Anführungszeichen ist erlaubt, aber selten notwendig.
Zahnspange
Am einfachsten ist es, immer eine Zahnspange zu verwenden. Während Standards das Überspringen von geschweiften Klammern für einzeilige „Wenn“-Anweisungen ohne mehrzeilige Blöcke in derselben Struktur erlauben, ist dies für einzeilige Schleifen nicht zulässig. Aus Gründen der Übersichtlichkeit bevorzuge ich immer die Verwendung von Zahnspangen. Darüber hinaus legen Standards fest, dass die öffnende geschweifte Klammer in derselben Zeile wie die ursprüngliche Anweisung platziert wird und nicht darunter, wie in der PHP-Dokumentation.
Formatieren von SQL-Abfragen
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-Site zuzugreifen und diese zu manipulieren.
Namenskonventionen
Vermeiden Sie im WordPress-Code CamelCase für Namen. Funktionen sollten Kleinbuchstaben verwenden, bei Bedarf mit Unterstrichen. Klassennamen sollten den ersten Buchstaben jedes Wortes großschreiben, getrennt durch Unterstriche.
Dateinamen sollten ausschließlich in Kleinbuchstaben geschrieben sein, 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 Zeichenfolgenwerte für Funktionsargumente anstelle von booleschen Werten. Die wichtigste Regel besteht darin, Namen beschreibend zu gestalten. Versuchen Sie in einer kollaborativen Umgebung, allen zu helfen, Ihren Code zu verstehen.
Vergleichsaussagen
Eine gute Praxis, nicht nur für WordPress, besteht darin, die Variable immer auf der rechten Seite eines Vergleichs zu platzieren. Wenn Sie auf diese Weise ein Gleichheitszeichen vergessen, führt dies zu einem Fehler und nicht zu einer echten Auswertung. Wenn Sie gerne ternäre Operatoren verwenden, ist dies erlaubt, es wird jedoch empfohlen, die Wahrheit zu überprüfen, um die Sache klarer zu machen. Eine Ausnahme bildet die Suche nach nichtleeren Variablen mithilfe von ! leer().
HTML formatieren
Laut 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 zwischen beiden ein klarer Zusammenhang besteht.
Dokumenttyp
WordPress folgt der vom W3C im Jahr 2000 empfohlenen XHTML 1.0-Spezifikation. Trotzdem verwendet das Twenty Eleven-Theme, ein Standardthema in WordPress, HTML5. Es gibt keinen wirklichen Konflikt, da HTML5 XML-Serialisierung beinhaltet und die Verwendung von „XHTML5“ ermöglicht.
Anführungszeichen verwenden
In HTML werden Anführungszeichen hauptsächlich für Attribute und deren Werte verwendet. Sie können einfache oder doppelte Anführungszeichen wählen, aber bleiben Sie konsequent bei einem Typ. Persönlich verwende ich aus Gründen der Konsistenz nach Möglichkeit einfache Anführungszeichen, wie ich es in PHP tue. Dies hilft mir, Sonderfälle in einer Zeile schnell zu erkennen, indem ich mir nur die Anführungszeichen ansehe.
Schluss-Tags
Die XHTML-Spezifikation schreibt das Schließen aller Tags vor. Leere Elemente müssen mit einem Schrägstrich kurz vor der letzten spitzen Klammer geschlossen werden. Stellen Sie sicher, dass wie angegeben ein Leerzeichen vor dem Schrägstrich steht.
Vertiefung
Einrücken Sie Ihren HTML-Code nach den gleichen Regeln wie für PHP. Achten Sie bei Ihrer Einrückung auf eine logische Struktur. Wenn Sie PHP und HTML kombinieren, rücken Sie die PHP-Blöcke entsprechend dem üblichen Einrückungsablauf ein.
CSS formatieren
Beim Formatieren von CSS geht es darum, die Präsentation von Webinhalten zu organisieren und zu gestalten und so Konsistenz und Lesbarkeit auf verschiedenen Geräten und Browsern sicherzustellen. Richtig formatiertes CSS verbessert die Struktur und visuelle Attraktivität von Websites und trägt so zu einem besseren Benutzererlebnis bei.
Weiterlesen: Wie entferne ich nicht verwendetes CSS in WordPress?
Einrückung und Struktur
Ihr CSS sollte diesem groben Schema folgen: Schreiben Sie jeden Selektor in eine separate Zeile, auch wenn Sie mehrere Selektoren für einen Regelsatz auflisten. Außerdem sollte jedes Eigenschafts-Wert-Paar in einer eigenen Zeile stehen. Setzen Sie die öffnende geschweifte Klammer auf die Zeile des Selektors und die schließende geschweifte Klammer auf eine separate Zeile mit derselben Einrückung wie die des öffnenden Selektors.
Namenskonventionen
Verwenden Sie nur Kleinbuchstaben. Trennen Sie Wörter innerhalb eines Selektors durch einen Bindestrich. Geben Sie Ihren Selektoren für Menschen lesbare Namen.
Eigenschaften und Werte
Es gibt einige Regeln zum Schreiben von Eigenschaften und Werten. Verwenden Sie nach Möglichkeit Kurzversionen von Eigenschaften, außer wenn Sie eine zuvor definierte Eigenschaft überschreiben. Verwenden Sie nach Möglichkeit HEX-Code in Kleinbuchstaben für Farben. Verwenden Sie ggf. die kürzere Version. Fügen Sie nach dem Doppelpunkt nach einer Eigenschaft ein Leerzeichen ein. Verwenden Sie immer Kleinbuchstaben, außer wenn ein Großbuchstabe erforderlich ist, z. B. bei Schriftartnamen und herstellerspezifischen Eigenschaften. Ordnen Sie CSS-Eigenschaften alphabetisch an, mit Ausnahme herstellerspezifischer Eigenschaften, die immer vor ihrem allgemeinen Gegenstück stehen sollten, und dimensionaler Eigenschaften, die in Gruppen zusammengefasst werden sollten. Wenn Breite und Höhe angegeben sind, schreiben Sie zuerst die Breite.
Kommentieren
CSS unterstützt nur eine Art von Kommentaren – Blockstil; Es gibt keine separate Notation für Inline-Kommentare. Schreiben Sie kurze Kommentare in eine Zeile ohne Zeilenumbruch darunter. Fügen Sie bei Kommentaren, die sich über mehrere Zeilen erstrecken, einen Zeilenumbruch direkt nach der Eröffnungssyntax und einen Zeilenumbruch direkt vor der Schlusssyntax ein. Wenn Sie Kommentare verwenden, um Abschnitte des Codes abzugrenzen, verwenden Sie die folgende Notation:
Verwendung von CSS-Präprozessoren
Die Verwendung von CSS-Präprozessoren wie SASS und Less erleichtert unser Leben als Entwickler erheblich, ist jedoch nicht ohne Nachteile. Der von diesen Tools erzeugte Code ist normalerweise gültig, kann aber nicht als sehr sauber bezeichnet werden. Ein manuell (und sorgfältig) erstelltes Stylesheet ist viel besser lesbar als eines, das automatisch von Less erstellt wurde. Es hängt davon ab, was Sie tun. Wenn Ihr Produkt kommerziell ist, ist das ultimative Ziel eine gute Benutzererfahrung mit gültigem und optimiertem Code. Verwenden Sie in diesem Fall die Ausgabe des Präprozessors als Haupt-CSS, schließen Sie jedoch die Originaldatei für Entwickler ein. Auch wenn Ihr CSS nicht den WordPress-Standards entspricht, kann die Einbeziehung der Originaldatei die Lücke etwas schließen, bis WordPress eine offizielle Position einnimmt. Es ist in Ordnung, CSS-Codierungsstandards zu opfern, um den Entwicklungsprozess zu vereinfachen (mit dem Ziel einer besseren Benutzererfahrung). Die Gültigkeit des Codes zu opfern ist nicht der Fall.
Wie können Sie zu WordPress-Codierungsstandards beitragen?
Code ist wie Schreiben – jeder hat seinen eigenen einzigartigen Stil. Ihr HTML-Code könnte anders aussehen als meiner, mein JavaScript könnte Ihre Augen bluten lassen und Ihr CSS könnte lebensverändernd schön sein. Wenn es jedoch 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 leicht lesen, verstehen und darauf aufbauen kann. Wenn Sie sich an diese Standards halten, sprechen Sie im Wesentlichen dieselbe Sprache wie andere Mitwirkende. Es ist, als würde man sich darauf einigen, einheitliche Grammatik- und Formatierungsregeln zu verwenden, damit alle nahtlos an demselben Buch zusammenarbeiten können.
Wenn Sie zu WordPress beitragen möchten, ist es wichtig, sich mit den Codierungsstandards vertraut zu machen und diese zu befolgen. Dadurch kann Ihr individueller Codierungsstil perfekt mit der größeren WordPress-Codebasis harmonieren.
Schlussfolgerungen
Die Einhaltung der WordPress-Coding-Standards ist für die Aufrechterhaltung einer kohärenten und kollaborativen Codebasis unerlässlich. Diese von der WordPress-Community entwickelten Richtlinien dienen als gemeinsame Sprache für Mitwirkende weltweit. 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.
Während sich WordPress weiterentwickelt, werden diese Codierungsstandards eine entscheidende Rolle bei der Förderung einer harmonischen und effizienten Entwicklungsumgebung für die gesamte Community spielen.
