Kodierungsstandards für WordPress [Guide]

Der Grund, warum wir überhaupt Kodierungsstandards haben (nicht nur für WordPress), ist , eine vertraute Umgebung für Programmierer zu schaffen, die an einem Projekt arbeiten. WordPress umfasst insbesondere eine Vielzahl von Produkten. Vom Kern selbst bis hin zu Themen und Plugins gibt es viel zu sehen - und vieles, worüber man sich irritieren lässt.

Wenn jeder seinen Code auf die gleiche Weise formatiert, Kommentare verwendet, die gleiche Art von Dokumentation und so weiter, wird die Zusammenarbeit so viel einfacher und die Lernkurve beim Beitritt zu einem neuen Projekt wird nicht so steil sein.

Die Notwendigkeit der Kohäsion in WordPress wird durch den Zustand, in dem die Codebasis ist, vergrößert. WordPress folgt keinem strikten objektorientierten Ansatz und verwendet kein MVC-Muster. Projekte, die ausnahmslos einer OOP- und MVC-Richtlinie folgen (wie Laravel), haben aufgrund ihrer Struktur Konsistenz und Best Practices "eingebürgert".

WordPress ist leider reif für Spaghetti-Coding, aka , was immer du willst . Best Practices lassen sich nur schwer durchsetzen, weil Produkte, die mit schlechtem Code arbeiten, genauso gut funktionieren (oberflächlich).

Indem Sie den WordPress Coding Standards folgen, können Sie ein wenig über das Coding-Ethos von WordPress lernen und mehr WordPress-kompatible Produkte erstellen. Zeigen Sie der Gemeinschaft, die Sie interessieren, und Sie streiten sich um qualitativ hochwertigen Code.

Mehr auf Hongkiat.com:

• 10 schlimmsten Albträume für Web-Entwickler
• 5 Gründe, warum CSS die härteste Sprache von allen sein könnte
• 30 Häufige Reaktionen, die Programmierer haben, wenn etwas schief geht

Einige Anmerkungen zu den Standards

Die Standards definieren nicht richtig und falsch. Sie können einer Regel nicht zustimmen, zum Beispiel sollten geschweifte Klammern immer verwendet werden, auch wenn sie nicht benötigt werden. Der Zweck der WordPress-Codierungsstandards ist nicht zu entscheiden, ob Sie richtig oder falsch sind, es ist zu entscheiden, wie es in WordPress gemacht werden soll.

Die Standards stehen nicht zur Debatte. Die Verwendung der Standards ist nicht der richtige Ort, um gegen einen Eindruckstil, den Sie nicht mögen, Stellung zu beziehen. Wenn etwas in den Codierungsstandards ist, dann tue es so. WordPress-Entwickler werden Sie dafür lieben! Das heißt, wenn Sie mit etwas darin nicht einverstanden sind, heben Sie Ihre Stimme und lassen Sie die Leute wissen. Es ist immer möglich, Dinge besser zu machen, aber Sie sollten nur Ihren Codierungsstil ändern, wenn die Standards dies zulassen.

Konsistenz gegenüber analer Retention . Wenn Sie in den letzten 10% Ihres Projekts sind und gerade festgestellt haben, dass Sie die falsche Namenskonvention für Klassen verwendet haben, wechseln Sie nicht in der Mitte. Meiner persönlichen Meinung nach würde ich eher etwas konsistent falsches lesen als etwas, das manchmal richtig ist und manchmal nicht. Sie können immer ein Skript schreiben, um Dinge auf einmal zu ändern, oder Ihren Code am Ende durchlesen.

Folgende Standards sind schwierig ! Platzieren Sie eine Klammer in der gleichen Zeile wie die Funktion, stattdessen ist eine Zeile darunter ziemlich einfach, selbst wenn Sie es gewohnt sind, vorher die Eingabe zu treffen. Wenn Sie jedoch über 100 kleine Regeln nachdenken müssen, wird der gesamte Prozess ein wenig fehleranfällig. Trotz meiner harten Haltung zu den folgenden Standards bin ich genauso schuldig wie jeder andere auch, Fehler zu machen. Am Ende des Tages ist eine falsche Einrückung keine unwiderrufliche Sünde. Versuchen Sie Ihr Bestes, um alle Regeln zu befolgen, Sie werden alles rechtzeitig lernen.

WordPress-Codierstandards

Im Moment hat WordPress vier Anleitungen, eine für jede der wichtigsten Sprachen: PHP, HTML, Javascript und CSS. Sie bilden einen Teil einer größeren Wissensmenge, dem Core Contributor Handbook. Es würde eine Weile dauern, alles durchzugehen, also habe ich einige Ausschnitte aus den vier Sprachen hervorgehoben, in denen ich oft sehe, dass Leute falsch liegen.

PHP

PHP ist die Hauptsprache von WordPress und ist eine ziemlich locker getippte Sprache, die es reif für die Regulierung macht.

Klammer-Stile

Starting Braces sollte immer am Ende der Linien platziert werden. Verwandte Anweisungen sollten in derselben Zeile wie die vorherige schließende Klammer platziert werden. Dies wird am besten anhand eines Codebeispiels demonstriert:

 if (Bedingung) {// Etwas tun} elseif (Bedingung) {// Etwas tun} else {// Etwas tun} 

Großzügige Raumnutzung

Ich bin kein Fan von zerquetschtem Code (ich habe schlechte Sehkraft), also möchte ich dies besonders durchsetzen. Setzen Sie Leerzeichen nach Kommas und auf beiden Seiten von logischen, Vergleichs-, String- und Zuweisungsoperatoren, nach if, elseif, for, foreach und switch- Anweisungen und so weiter.

Es ist einfacher zu sagen, wo keine Leerzeichen hinzugefügt werden sollen! Nur beim Typisieren oder Referenzieren von Arrays dürfen keine Leerzeichen hinzugefügt werden.

Eine ziemlich verwirrende Ausnahme von der Ausnahme sind Arrays, bei denen der Array-Schlüssel eine Variable ist, in diesem Fall ein Leerzeichen. Dieses Beispiel sollte dies verdeutlichen:

 Funktion my_function ($ complete_array = null, $ key_1 = 4, $ key_2 = 'bar') {if (null == $ complete_array) {$ final_array = $ complete_array; } else {$ key_1 = (ganze Zahl) $ key_1; $ final_array [0] = 'dies'; $ final_array [$ key_1] = 'ist'; $ final_array [$ key_2] = 'an'; $ final_array ['last'] = 'Beispiel'; } Rückgabe $ final_array; } 

Regeln der Namensgebung

Man kann sich schwer daran gewöhnen, besonders wenn man aus verschiedenen Umgebungen kommt. In einer Nussschale:

• Variablennamen sollten Kleinbuchstaben sein, Wörter getrennt durch Unterstriche
• Klassennamen sollten Großbuchstaben verwenden, die durch Unterstriche getrennt sind. Akronyme sollten nur Großbuchstaben enthalten
• Konstanten sollten ausschließlich aus Großbuchstaben bestehen, die durch Unterstriche hervorgehoben sind
• Dateinamen sollten kleingeschrieben und durch Bindestriche getrennt sein

Yoda Bedingungen

Das Schreiben von Bedingungen anders herum, als Sie es gewohnt sind, wird Parsing-Fehler verhindern. Es sieht ein bisschen komisch aus, aber es ist besser Code.

 if ('Daniel' === $ name) {echo 'Artikel schreiben, den du willst'; } 

HTML

HTML hat nicht so viele Regeln, ich könnte mir einiges einfallen lassen, um die Dinge modularer zu gestalten. Es gibt nur fünf Regeln, die Sie beim Schreiben von HTML beachten müssen:

1. Ihr Code muss gegen den W3C-Validator validiert werden.
2. Selbstschließende HTML-Tags müssen genau einen Platz vor dem Schrägstrich haben (das ist einer, den ich persönlich hasse, aber es ist eine W3C-Spezifikation, nicht nur ein WordPress-Ärgernis)
3. Attribute und Tags müssen alle Kleinbuchstaben sein. Die einzige Ausnahme ist, wenn Attributwerte für den menschlichen Verzehr bestimmt sind. In diesem Fall sollten sie natürlich eingegeben werden.
4. Alle Attribute müssen einen Wert haben und müssen in Anführungszeichen gesetzt werden das ist nicht richtig)
5. Die Einrückung sollte über Registerkarten erfolgen und der logischen Struktur folgen.

CSS

CSS ist eine andere Sprache, die locker geschrieben ist, also gibt es hier auch viel zu tun. Trotzdem sind die Standards für Coder ziemlich einfach.

Selektoren

Selektoren sollten so qualifiziert wie nötig sein, für Menschen lesbar sein, Kleinbuchstaben mit durch Bindestriche getrennten Wörtern sein, und Attributselektoren sollten doppelte Anführungszeichen verwenden. Hier ein kurzes Beispiel:

 Eingabe [Typ = "Text"], Eingabe [Typ = "Passwort"], .name-Feld {Hintergrund: # f1f1f1; } 

Immobilienauftrag

Die Standards erkennen hier die Notwendigkeit von persönlichem Raum an, da sie keine spezifische Reihenfolge für CSS-Regeln vorschreiben. Was sie sagen ist, dass Sie einer semantischen Struktur folgen sollten, die Sinn macht . Gruppieren Sie Eigenschaften nach ihren Beziehungen oder gruppieren Sie sie alphabetisch, schreiben Sie sie nicht einfach nach dem Zufallsprinzip aus .

Der größte Grund für die Zufälligkeit ist das "Oh, ich muss auch einen Rand hinzufügen" und dann fortfahren, es nach unten hinzuzufügen. Nehmen Sie die zusätzlichen 0, 3 Sekunden und fügen Sie die Regel an der logischen Stelle hinzu.

• Anzeige
• Positionierung
• Box-Modell
• Farben und Typografie
• Andere

 .profile-modal {Anzeige: Block; Position: absolut; links: 100px; oben: 90px; Hintergrund: # ff9900; Farbe: #fff; } 

Wertformatierung

Dies ist ein Ort, an dem ich es besonders hasse, Unstimmigkeiten zu sehen. Wenn Sie den Richtlinien nicht folgen, ist das immer noch besser, als manchmal ein Leerzeichen vor dem Wert zu sehen; manchmal mit Kurzschrift, manchmal nicht; manchmal mit Einheiten auf 0 Werte, manchmal nicht, usw.

Die Formatierung von Werten ist ziemlich komplex, aber es kommt natürlich mit etwas Übung . Werfen Sie einen Blick auf die genaue Anleitung im Codex zum Formatieren Ihrer Werte.

Javascript

Nach meiner Erfahrung ist Javascript am anfälligsten dafür, überall hinzugehen. Während viele Entwickler eine beträchtliche Menge an Javascript kennen, wurde es nach und nach als HTML, CSS und PHP gelernt. Wenn Sie gerade mit einer neuen Sprache anfangen, machen Sie viel mehr Fehler und wenn diese Fehler keine fatalen Fehler verursachen, können sie sich in Ihnen verfangen.

In vielen Fällen beziehen sich die Standards auf ein Linienlimit oder den Zustand "wenn eine Linie nicht zu lang ist". Dies bezieht sich auf den jQuery-Styleguide, der Zeilen eine Begrenzung von 100 Zeichen auferlegt. Der WordPress-Leitfaden basiert auf dem jQuery-Leitfaden, daher ist es eine gute Idee, diesen auch zu lesen.

Semikolons

Dies ist eine der einfachsten Regeln, wird aber häufig übersehen. Verlassen Sie niemals ein Semikolon, nur weil Ihr Code ohne es funktioniert. Es ist nur schlampig.

Einrücken

Tabs sollten immer zum Einrücken verwendet werden. Sie sollten den Inhalt eines Abschlusses auch dann einrücken, wenn der Inhalt einer ganzen Datei in einem enthalten ist. Ich bin mir nicht sicher warum, aber eine nicht abgeschlossene Schließung der obersten Ebene hat mich schon vor dem Lesen der Standards gestört.

Linien brechen

Wenn Sie lange Strings brechen, brechen Sie immer die Linie nach einem Operator, lassen Sie keine Variable hängen . Dies macht auf den ersten Blick deutlich, dass die Linie gebrochen ist und Sie nicht einfach ein Semikolon vergessen haben.

Wenn eine Bedingung lang ist, brechen Sie sie in mehrere Zeilen auf und fügen Sie eine zusätzliche Registerkarte hinzu. Dieser sieht für meine Augen sehr seltsam aus, aber die Trennung, die er zwischen dem Zustand und dem Körper hinzufügt, ist sehr sichtbar.

 if (firstCondition () && secondCondition () && thirdCondition ()) {var html = 'Diese Zeile besteht aus' + n + 'Wörtern, daher sollte sie nach' + 'eines Operators zerlegt werden; } 

jQuery Iteration

Gemäß den Standards sollte jQuery iteration (jQuery.each()) nur für jQuery-Objekte verwendet werden. Sie sollten basic for, while- Schleifen in Javascript verwenden, um über andere Sammlungen zu iterieren.

Fazit

Es gibt eine Menge zu beachten und zu verfolgen und es gibt keine Möglichkeit, das alles auf einmal anzuwenden. Sie sollten Ihren Code so nah wie möglich an die Standards herantragen und daran arbeiten, sie genau zu befolgen.

Konsistenz ist meiner Meinung nach die wichtigste Regel . Es ist besser, etwas konsequent falsch zu machen als halb zu wechseln. Dies gilt insbesondere für Formatierungspraktiken, da diese die Funktionalität Ihres Codes nicht beeinträchtigen und - größtenteils - zu einem späteren Zeitpunkt problemlos im Stapel geändert werden können .

Hassen Sie ein Element der Codierungsstandards, denken Sie, dass etwas hinzugefügt werden sollte? Lass es uns in den Kommentaren wissen!

Ein Blick in: Premium WordPress Plugins

Mit der Veröffentlichung von WordPress, der dritten (dritten) großen Iteration zur Open-Source-Plattform, haben wir mehr Entwickler gesehen, die sich der Masse anschlossen, um Plugins in Massen zu veröffentlichen . Obwohl die kostenlosen Optionen für Plugins endlos scheinen, gibt es Software-Firmen, die konkrete Premium-Plugins zu sehr erschwinglichen Preisen anbieten. Di

(Tech- und Design-Tipps)

CSS - margin: auto - Wie es funktioniert

Verwenden von margin:auto um ein Blockelement horizontal zu zentrieren, ist eine wohlbekannte Technik. Aber haben Sie sich jemals gefragt, warum oder wie es funktioniert? Um dies zu beantworten, müssen wir uns zuerst ansehen, wie margin: auto funktioniert. In der Mischung ist auch, was auto in den Rändern möglicherweise tun kann, wenn es für vertikales Zentrieren und einige andere Probleme arbeitet.Abe

(Tech- und Design-Tipps)