Share
Wenn es darum geht, eine Reihe von Blog-Posts zu verfassen, ist einer der herausforderndsten Aspekte eines Lesers eigentlich, mit jedem veröffentlichten Beitrag Schritt zu halten.
Selbst wenn Sie es schaffen und versuchen, mitzuhalten, können Posts mit mehr als 1.000 Wörtern - insbesondere solche, die Code enthalten - einige Zeit in Anspruch nehmen, die viele von uns nicht haben, insbesondere wenn es darum geht, unser Arbeitsleben, das Leben im Haushalt, Hobbys und andere Dinge.
Um sicherzugehen, dass die Informationen, die in dieser Serie präsentiert werden, immer noch auf leicht verdauliche Weise präsentiert werden, dachte ich, ich würde mit einer Zusammenfassung der gesamten Serie experimentieren. Auf diese Weise können diejenigen von Ihnen, die einen Artikel verpasst haben oder nicht die Zeit hatten, sich hinzusetzen und jeden Artikel durchzugehen, den Kernpunkt jedes Punktes, der in den Artikeln erwähnt wird, erhalten.
Nachdem dies gesagt wurde, werfen wir einen Blick auf alles, was wir bei der Überprüfung der WordPress-Codierungsstandards behandelt haben.
Im Allgemeinen soll die gesamte Serie dazu beitragen, die WordPress-Codierungsstandards zu beleuchten, sodass diejenigen, die noch nichts von ihnen gehört haben, diejenigen, die sie nicht kennen oder diejenigen, die sie nicht befolgt haben, besser zum Schreiben gerüstet sind WordPress-Themes, Plugins und Anwendungen.
Um dies zu erreichen, haben wir in sechs verschiedenen Artikeln einen tiefen Einblick in eine Reihe verschiedener Aspekte der Kodierungsstandards gegeben, in denen Grundsätze, bewährte Verfahren und zu vermeidende Dinge hervorgehoben werden.
Im Folgenden haben wir die einzelnen Artikel sowie die Aufzählungspunkte zusammengefasst, die für das betreffende Thema besonders wichtig und bemerkenswert sind. Wenn Sie weitere Informationen wünschen, können Sie natürlich zu dem Artikel der Serie (oben in diesem Beitrag verlinkt) zurückkehren, um die Informationen vollständig zu lesen.
Wenn Sie mit Klassen, Funktionen, Variablen, Attributen oder Argumenten arbeiten, sollten Namenskonventionen dazu beitragen, den Zweck zu erläutern, dem sie dienen.
Zum Beispiel sind Klassen im Allgemeinen Nomen und Funktionsnamen normalerweise Verben. Letztendlich geht es darum sicherzustellen, dass der Code lesbar und wartbar ist.
Direkt von den Kodierungsstandards:
Abkürzen Sie Variablennamen nicht unbedingt ab. Lassen Sie den Code eindeutig und selbstdokumentierend sein.
Aber dieses spezielle Prinzip ist es wert, gefolgt zu werden ungeachtet wo im Code Sie arbeiten.
Denken Sie daran, dass es beim Übergeben von Funktionsargumenten wichtig ist zu bedenken, dass wenn ein Funktionsname die Aktion beschreibt, die er im Kontext der Klasse ausführt, das Argument die Funktion der Funktion darstellen soll.
String-Werte gegenüber einfach vorziehen
wahrundfalschbeim Aufruf von Funktionen.
Dies bedeutet, dass Funktionsargumente eindeutige Werte sein müssen - Zeichenfolgen oder Zahlen -, da boolesche Werte oft unklar sind und nicht unbedingt angeben, welche Aktion die Funktion ausführt.
Wenn Sie mit Strings in WordPress arbeiten, müssen Sie normalerweise innerhalb der Feinheiten der PHP-String-Manipulation arbeiten. Daher haben wir in diesem Artikel überprüft, wie PHP (sowohl einfache als auch doppelte) Zitate behandelt und wie sich dies auf unsere WordPress-Entwicklung auswirkt.
Die einfachste Möglichkeit, einen String in PHP zu definieren, besteht darin, ihn in einfache Anführungszeichen (dh das '' - Zeichen) einzugeben..
Wie bei den meisten Programmiersprachen sind Möglichkeiten, Zeichen zu umgehen, damit Sie ein String-Literal schreiben können. Wenn Sie beispielsweise Folgendes schreiben wollten: "Zeichenfolgen in PHP sind einfach" als Zeichenfolge, können Sie Folgendes tun:
"Zeichenfolgen in PHP sind einfach."
Die Backslashes weisen PHP an, das einfache Anführungszeichen auszugeben, anstatt den eigentlichen String zu beenden. Die zweite Sache, die Sie beachten sollten, ist, dass es eine Variable gibt, wenn Sie eine Variable haben nicht ersetzt, wenn in einfachen Anführungszeichen zitiert.
Doppelte Anführungszeichen funktionieren in PHP etwas anders. Speziell:
Wenn die Zeichenfolge in doppelte Anführungszeichen (") eingeschlossen ist, interpretiert PHP weitere Escape-Sequenzen für Sonderzeichen.
Das bedeutet, wenn Sie eine Variable in einen PHP-String mit doppelten Anführungszeichen einbetten, wird die Variable interpretiert und deren Wert an Stelle der Variablen eingefügt, bevor sie auf dem Bildschirm angezeigt wird.
Zu den in WordPress geleisteten Arbeiten gehört auch das Ausschreiben von Markup innerhalb Als PHP-Zeichenfolge sollten Sie diese Zeichenfolgen in einfache Anführungszeichen setzen, damit die Attribute des HTML-Elements in doppelte Anführungszeichen eingeschlossen werden können.
In manchen Fällen empfiehlt es sich jedoch, doppelte Anführungszeichen zu verwenden insbesondere wenn Sie eine Variable auswerten müssen.
Der beste Rat, der hier angeboten werden kann, ist zu wissen, wie einfache Anführungszeichen und doppelte Anführungszeichen innerhalb von PHP funktionieren, und sie entsprechend ihrem Anwendungsfall entsprechend zu verwenden.
Denken Sie daran: Leerzeichen verbessern die Lesbarkeit von Code. Als Entwickler sollte eines unserer Hauptziele sein, sicherzustellen, dass der von uns geschriebene Code nicht nur einem vordefinierten Standard entspricht, sondern auch für andere Entwickler geeignet ist, um die Lesbarkeit zu erleichtern Wartbarkeit.
In Bezug auf die Einrückung gibt es nichts wirklich Neues, insbesondere wenn Sie mit Sprachen im C-Stil vertraut sind. Meistens werden Sie jedes Mal einrücken, wenn Sie einen neuen Block beginnen.
Beachten Sie die Codierungsstandards tun habe Regeln für Tabs und Leerzeichen:
Ihre Einrückung sollte immer die logische Struktur widerspiegeln. Benutzen echte tabs und keine Leerzeichen, da dies die größte Flexibilität für Kunden ermöglicht.
Dies ist besonders nützlich in der Open Source Community.
Leerzeichen sollten an folgenden Stellen platziert werden:
Accentsconagua
||, &&, und !)<, >, ==, ===, usw.)=)Dies ist eine der einfachsten Konventionen. Ehrlich gesagt sind die Chancen gut, dass Ihre IDE oder der Editor Ihrer Wahl diese Funktion integriert hat, oder es gibt ein Plugin, mit dem Sie dies automatisch tun können.
Wenn nicht, sollten Sie die Möglichkeit aktivieren, Registerkarten, Leerzeichen, Wagenrückläufe usw. anzuzeigen, damit Sie sie leicht erkennen können woher die nachgestellten Leerzeichen sind. Und wenn Sie sie sehen, beseitigen Sie sie.
In diesem Abschnitt haben wir uns angesehen, warum der Stil so wichtig ist. Wir haben auch genau definiert, wie Kodierungsstandards und Konventionen definiert werden Wie Wir gestalten unseren Code.
Im Allgemeinen sind die Regeln einfach:
Diese sind besonders häufig, wenn Sie aus anderen Sprachen im C-Stil kommen. So wie WordPress subtile Nuancen hat, die andere Sprachen nicht haben, lohnt es sich, sie hier hervorzuheben.
PHP bietet verschiedene Möglichkeiten, um mit regulären Ausdrücken zu arbeiten. WordPress empfiehlt jedoch, nur eine Handvoll der verfügbaren Funktionen zu verwenden.
Die Regeln für das Arbeiten mit regulären Ausdrücken in PHP in WordPress lauten wie folgt:
preg Funktionen, die PHP bietet\ e Schalter, der von PHP - use angeboten wird preg_replace_callback stattdessen.Ich empfehle insbesondere, mit den folgenden Funktionen vertraut zu sein:
preg_replacepreg_matchpreg_match_allBeachten Sie außerdem, dass mit preg_replace_callback eine Funktion aufgerufen werden kann, wenn ein regulärer Ausdruck eine Übereinstimmung gefunden hat.
Es gibt eine sehr einfache Faustregel für die Verwendung von PHP-Tags in der WordPress-Entwicklung:
Das bedeutet, dass Sie niemals eine Datei oder eine Inline-PHP-Anweisung mit öffnen sollten oder mit . Natürlich sollten alle Inline-PHP-Anweisungen mit der ?> schließendes Tag.
Zusätzlich zu dem oben definierten Codierungsstandard würde ich Folgendes hinzufügen:
Der Grund dafür wurde wörtlich im zugehörigen Artikel erwähnt:
Wenn Sie jedoch ein Plugin oder eine Anwendungsdatei schreiben, die zu 100% aus PHP besteht, müssen Sie am Ende der Datei kein abschließendes Tag hinzufügen. Der Parser wird es selbst erkennen können tun Fügen Sie ein Beendigungs-Tag ein. Dann können Sie möglicherweise Whitespace am Ende der Datei hinterlassen, das alle möglichen Probleme aufruft, wenn das Plugin aktiviert wird.
Wenn es darum geht, auf WordPress basierenden Code zu schreiben, sagen die Coding Standards, dass wir uns die Lesbarkeit anstreben sollten:
Im Allgemeinen ist Lesbarkeit wichtiger als Klugheit oder Kürze.
Einige Entwickler halten den ternären Operator für ein wenig im Widerspruch zu diesem bestimmten Prinzip, insbesondere weil er noch eine andere Art des Schreibens ist ansonsten Aussage. Sogar noch der ternäre Operator ist Eine praktikable Option für das Schreiben einfacher Bedingungen und wird in den WordPress-Codierungsstandards angegeben.
Erstens, für diejenigen, die nicht vertraut sind, ist der ternäre Operator eine vereinfachte Schreibweise ansonsten Bedingungsanweisung. Es wird normalerweise verwendet nur wenn die Bedingung die einfachste Form ist und nur wenn es eine einzige gibt ob und eine einzige sonst Block.
$ uses_gasoline = 'hybrid' == $ car_type? Falsch Richtig; echo $ use_gasoline;
Eine wichtige Sache zu beachten: Der ternäre Operator prüft auf wahr (statt falsch)..
Yoda-Bedingungen beziehen sich auf die Umkehrung von Variablen-zu-Wert-Vergleichen, die wir beim Schreiben von WordPress-Code ausführen. Wir dies gemäß den Kodierungsstandards, weil:
Wenn Sie im obigen Beispiel ein Gleichheitszeichen weglassen (geben Sie zu, es passiert sogar den erfahrensten von uns), erhalten Sie einen Parser-Fehler, da Sie keine Konstante wie zuweisen können
wahr. Wenn die Aussage umgekehrt wäre($ the_force = true), der Auftrag wäre vollkommen gültig und würde zurückkehren1, Veranlassen, dass die if-Anweisung ausgewertet wirdwahr, und Sie könnten diesen Fehler für eine Weile verfolgen.
Sicher, es ist fraglich, aber es ist ist Teil des Standards und Sie sind Dies wird durch den Kern von WordPress, Themes, Plugins, Artikel und mehr angezeigt.
Kurz gesagt, wenn die API hinter dem fehlt, was Sie brauchen, dann $ wpdb mag die beste Option sein, aber ich empfehle, sie nur zu verwenden, wenn Sie den Rest Ihrer Optionen ausgeschöpft haben.
In WordPress gibt es eine Reihe von APIs, die es uns ermöglichen, eigene Abfragen zu erstellen, ohne SQL schreiben zu müssen. Einige dieser APIs umfassen:
WP_QueryWP_User_Queryget_post_metaget_comment_metaget_user_metaEs ist wichtig, sich mit den API-Angeboten vertraut zu machen, damit Sie wissen können, ob eine Funktion oder ein Objekt verfügbar ist, bevor Sie mit dem Schreiben Ihrer eigenen Abfragen beginnen können.
APIs können nicht vorhersagen alles Fälle, in denen wir unsere Datenbankabfragen schreiben müssen. In diesen Situationen bietet WordPress ein Objekt, mit dem wir direkt mit der Datenbank interagieren können: $ wpdb.
Es erlaubt uns:
WÄHLEN Variablen, Zeilen, Spalten und generische ErgebnisseEINFÜGEN ReihenAKTUALISIEREN vorhandene ZeilenUnd erlauben Sie uns, die Daten in einem Format abzurufen, mit dem wir am liebsten arbeiten würden: einem Array, einem Objekt oder einem einzelnen Wert (in einigen Fällen), und wir können uns sogar durch SQL-Injection schützen.
Aber erinnere dich:
Wenn Sie die Datenbank berühren müssen, wenden Sie sich an einige Entwickler, indem Sie eine Nachricht an die Mailingliste wp-hackers senden. Sie möchten möglicherweise eine Funktion für die nächste WordPress-Version erstellen, um die gewünschte Funktionalität abzudecken.
Wie ich bereits erwähnt habe, kann es schwierig sein, mit einer Reihe von Artikeln Schritt zu halten, insbesondere diejenigen, die Code beinhalten. Zu diesem Zweck wollte ich mit einer Zusammenfassung der Serie experimentieren, die immer noch genug Informationen für diejenigen bietet, die noch keine Chance hatten, mit der gesamten Serie Schritt zu halten, sich aber dennoch für die anstehenden Themen interessieren.
Wenn Sie also an dieser bestimmten Strategie oder Art von Artikel Freude haben, lassen Sie es mich wissen und vielleicht können wir dies auch für andere Serien tun. Ansonsten kein Schaden, kein Foul - mir geht es gut oder so.
Trotzdem hoffe ich, dass die Serie dazu beigetragen hat, eine Reihe verschiedener Bereiche der WordPress-Codierungsstandards zu erläutern, die Sie zuvor übersehen, missverstanden haben oder bis zum Lesen dieser Artikel noch nicht vollständig verstanden haben.
