Share
Was sind die WordPress-PHP-Codierungsstandards? In diesem Video aus meinem Kurs Learn PHP for WordPress erfahren Sie alles über die Kodierungsstandards und warum sie so wichtig sind.
Die vollständigen WordPress-PHP-Codierungsstandards finden Sie im offiziellen WordPress-Handbuch.
Sie sind im Wesentlichen eine Reihe von Best Practices für die Verwendung von PHP in WordPress. Nachfolgend werden einige Beispiele beschrieben, was dies im Rest dieses Tutorials in der Praxis bedeutet.
Wie Sie sehen, gibt es nicht nur Standards für PHP, sondern auch für die Zugänglichkeit und für die anderen Sprachen, die Sie in WordPress verwenden würden.
Warum ist es wichtig, dass wir uns alle an diese Standards halten??
Nun, es gibt zwei Gründe. Bei einem davon geht es um die Qualität des Codes, bei dem anderen um Konsistenz.
Zunächst einmal ist Qualität wichtig, denn jeder Code, der in WordPress codiert, erstellt Code, der funktioniert, der seine Aufgabe erfüllt und auf aktuelle und hochwertige Weise geschrieben wird.
Die zweite, bei der es um Konsistenz geht, ist ebenso wichtig. Es ist sehr wahrscheinlich, dass Sie von Zeit zu Zeit mit dem Code anderer Personen arbeiten werden. Wenn Sie beispielsweise ein untergeordnetes Design erstellen, müssen Sie möglicherweise etwas Code aus dem übergeordneten Design kopieren. Wenn Sie ein Plugin erstellen, könnte dieses Plugin eine Verzweigung eines vorhandenen Plugins von Drittanbietern sein, das Sie kopieren und mit zusätzlichen Funktionen versehen. Es ist wirklich wichtig, dass die Art und Weise, wie Sie kodieren, mit der Art und Weise übereinstimmt, auf die jeder, der PHP für WordPress kodiert, Code selbst schreibt.
Schauen wir uns einige der PHP-Codierungsstandards an. Ich werde Ihnen Beispiele in einigen Dateien in meinem Thema zeigen.
Beginnen wir mit der Benennung von Konventionen und Fällen. Wenn Sie über Namenskonventionen nachdenken, sollten Sie vier Dinge beachten:
Fangen wir also mit Funktionen an. Hier ist die Datei functions.php in meinem Theme als Beispiel.
Sie können sehen, dass ich eine Funktion benannt habe, die ich definiert habe rachelmcc_register_widgets. Das ist alles in Kleinbuchstaben geschrieben, und ich verwende Unterstriche zwischen den Wörtern. Daher sollten Sie immer eine Funktion in WordPress schreiben.
Wie Sie auch sehen werden, habe ich ein Präfix verwendet. Dies stellt sicher, dass diese Funktion nicht mit anderen Funktionen kollidiert, die möglicherweise von meinem Theme oder einem anderen Plugin bereitgestellt werden. Also, wenn ich eine Funktion geschrieben habe, die gerade aufgerufen wurde register_widgets und eines meiner Plugins hatte auch eine Funktion namens register_widgets, die beiden könnten zusammenstoßen. Möglicherweise stellen Sie fest, dass eines davon das andere überschreibt oder dass das Plugin nicht funktioniert.
Stattdessen verwende ich eine einzigartige Funktion, die für mein Thema relevant ist. Mein Thema heißt rachelmccollin, so haben meine Funktionen rachelmcc als Präfix. Es ist auch wichtig, Unterstriche für Ihre Funktionen zu verwenden und keine Bindestriche zu verwenden.
Sie tun Verwenden Sie an zwei Stellen Bindestriche. Erstens verwenden Sie bei der Definition von CSS-Klassen Bindestriche. Sie können also sehen, dass ich in meinen Widgets CSS-Klassen für meine definiere h3 Element und auch für die Ich würde dieses Widget-Bereichs. Und hier benutzt du Bindestriche.
Die andere Stelle, an der Sie Bindestriche verwenden, befindet sich in Ihren Dateinamen. Das ist also front-page.php.
Sie sollten immer Bindestriche in Ihren Dateinamen innerhalb Ihrer Designs und Plugins verwenden. Verwenden Sie keine Unterstriche. Also hier ist ein Anruf mit locate_template. Und loop-frontpage.php ist eine Datei, eine Vorlage, die ich anrufe, und Sie können sehen, dass diese einen Bindestrich und keinen Unterstrich hat.
Andererseits verwendet meine Beitragstyp-ID, bei der es sich um einen benutzerdefinierten Beitragstyp handelt, den ich registriert habe, einen Unterstrich: rmcc_blurb.
Jetzt müssen Sie möglicherweise auch über Variablen in Ihrem Thema nachdenken. Schauen wir uns loop-frontpage.php an:
In dieser speziellen Datei, die ich aus dieser vorherigen Datei aufgerufen habe, habe ich einige Variablen definiert, eine aufgerufen Anzahl und einer rief an Titel. Und Sie können sehen, dass ich für beide eine Kleinschreibung verwende.
Der andere Ort, an dem Sie über Unterstriche und Kapitalisierung nachdenken müssen, ist die Verwendung einer Klasse. Gehen wir zurück zu front-page.php:
Und Sie können hier sehen, ich benutze die WP_Query Klasse. Eine Klasse hat also nach dem Unterstrich sowie zu Beginn einen Großbuchstaben. An dieser Stelle verwenden Sie die Großschreibung, wenn Sie eine Klasse definieren. Damit können Personen, die mit Ihrem Code arbeiten, sofort erkennen, dass es sich um eine Klasse und nicht um eine Funktion handelt.
Schauen wir uns nun an, wie Sie einfache und doppelte Anführungszeichen in PHP für WordPress verwenden würden.
Sie können entweder einfache Anführungszeichen oder doppelte Anführungszeichen verwenden, je nachdem, welcher am besten für den bestimmten Code geeignet ist, mit dem Sie arbeiten.
Doppelte Anführungszeichen können manchmal hilfreicher sein, da sie die Arbeit mit Sonderzeichen erleichtern. Hier ist ein Beispiel:
Angenommen, Sie schreiben eine Suchvorlagendatei, search.php. Und wenn nichts gefunden wurde, würden Sie einen Absatz einfügen, der sagt: "Es tut mir leid, Ihre Suche hat nichts gefunden. Warum versuchen Sie es nicht noch einmal?"
Ich habe das in Anführungszeichen gesetzt, weil der Text Apostrophe enthält. Lassen Sie mich Ihnen zeigen, wie das funktionieren würde, wenn wir es in einfachen Anführungszeichen machen würden.
Sie müssen einen Backslash vor den Apostrophen setzen, damit sie korrekt im HTML-Code ausgegeben werden. Andernfalls erhalten Sie Fehler. Nun, ich weiß nicht, wie es Ihnen geht, aber ich schreibe es normalerweise in Anführungszeichen und nicht in Anführungszeichen.
Die andere Sache, die Sie beachten müssen, ist, dass, wenn Sie Anführungszeichen in Anführungszeichen setzen müssen, entweder einfache Anführungszeichen in doppelte Anführungszeichen gesetzt werden oder umgekehrt. Es ist egal, in welche Richtung es geht, aber Sie können keine einfachen Anführungszeichen in doppelte Anführungszeichen oder doppelte Anführungszeichen setzen.
Hier ist ein Beispiel, das auf meine functions.php-Datei zurückgeht.
Hier habe ich einfache Anführungszeichen für den Wert von before_widget, und dann habe ich doppelte Anführungszeichen für die ID und die Klasse davon. Ich konnte hier keine doppelten Anführungszeichen verwenden und dann doppelte Anführungszeichen verwenden. Aus diesem Grund verwende ich dort einfache Anführungszeichen, da es besser ist, doppelte Anführungszeichen mit CSS zu verwenden.
Nun sehen wir uns die Einrückung an. Schauen wir uns die Datei "functions.php" an. Dies ist ein gutes Beispiel, weil ich mehrere Codezeilen darin eingerückt habe.
Sie können sehen, dass sich der Funktionsname auf der linken Seite befindet und dann der register_sidebar Funktion ist auf einer Ebene eingerückt. Und der Inhalt davon wird wieder eingerückt.
Jedes Mal, wenn Sie Inhalte in geschweifte Klammern oder geschweifte Klammern setzen, sollte alles darin eingerückt sein. Und auch für die Einrückung sollten Sie Zeilenumbrüche verwenden.
Schauen wir uns also eine andere Datei an, in der es sowohl einzelne als auch doppelte Zeilen gibt.
Hier kann man sehen, dass ich eine habe ob Anweisung, die zwei Zeilen Code enthält. Ich habe also einen Zeilenumbruch oberhalb und unterhalb dieser beiden Codezeilen eingefügt.
Wenn es nur eine Codezeile darin gibt, müsste ich diese Zeilenräume nicht einfügen - ich würde das einfach direkt in meine Zahnspange setzen.
Die Verwendung eines solchen Abstands macht deutlich, wo sich Ihre Codeblöcke befinden. Und Sie können auch sehen, dass Einrückung verwendet wurde. Es gibt also mehrere Einrückschichten.
Die andere Sache, die Sie beachten müssen, ist, wo Sie Ihr PHP-Tag öffnen und schließen und ob sich dies in derselben Zeile wie Ihr Code oder in einer anderen Zeile befindet. Und das hängt auch davon ab, ob Sie einen Codeblock oder eine einzelne Zeile codieren.
Wo Sie einen Codeblock haben, setzen Sie Ihr Start-Tag in eine Zeile und Ihr Schluss-Tag in eine andere Zeile. Dies macht deutlich, dass es sich um einen PHP-Block handelt und dass alles in diesen Tags PHP ist.
Die andere Sache, die Sie sicherstellen müssen, ist ein vollständig öffnendes PHP-Tag. Verwenden Sie also nicht nur ein Fragezeichen, wie Sie es vielleicht in anderen Systemen getan haben, die PHP verwenden. In WordPress müssen Sie das vollständige PHP-Tag verwenden.
Wenn ich PHP geschrieben habe, das nur in einer Zeile stand, würde ich die PHP-Tags zum Öffnen und Schließen in dieselbe Zeile setzen.
Sie können sehen, dass wir PHP haben, das alles in einer Zeile ist, und dann habe ich HTML. Die öffnenden und schließenden Tags stehen also in der gleichen Zeile wie mein Code.
Dies ist eine Einführung in einige der Elemente der WordPress-PHP-Codierungsstandards. Ich habe Ihnen einige Beispiele in meinen Dateien gezeigt und einige geändert, während ich Ihnen gezeigt habe, wie alles richtig gemacht wird.
Wenn Sie mehr über die Codierungsstandards erfahren möchten, finden Sie eine Dokumentation auf der WordPress-Website. Sie können sich auch die Envato Tuts + -Serie ansehen, in der alle Elemente der Codierungsstandards detailliert beschrieben werden.
Im vollständigen Kurs Learn PHP for WordPress lernen Sie alles über PHP, die Programmiersprache, in die WordPress integriert ist.
Ich gebe Ihnen einen Überblick darüber, was PHP ist und wie es für WordPress-Themes und Plugins verwendet wird, mit Beispielen. Sie erfahren dann, wie Sie eine PHP-Datei erstellen und HTML-Inhalte ausgeben können. Dann lernen Sie, wie Sie mit Funktionen, Schleifen und if-Anweisungen benutzerdefinierte WordPress-Designs und -Plugins codieren.
Sie können diesen Kurs mit einem Abonnement von Envato Elements sofort absolvieren. Für eine einmalige geringe monatliche Gebühr erhalten Sie nicht nur Zugriff auf diesen Kurs, sondern auch auf unsere wachsende Bibliothek mit über 1.000 Videokursen und branchenführenden eBooks für Envato Tuts+.
Außerdem erhalten Sie jetzt unbegrenzte Downloads aus der riesigen Envato Elements-Bibliothek mit mehr als 580.000 kreativen Elementen. Erstellen Sie mit einzigartigen Schriftarten, Fotos, Grafiken und Vorlagen und sorgen Sie schneller für bessere Projekte.
Accentsconagua