Coding-Standards in der WordPress-Entwicklung sind für eine starke und nachhaltige Code-Basis unerlässlich. Es handelt sich dabei um Richtlinien und Konventionen, die von den Entwicklern beim Schreiben von Code befolgt werden und dazu beitragen, die Zusammenarbeit zu verbessern, die Wartung zu vereinfachen und die allgemeine Zuverlässigkeit zu gewährleisten.

Darüber hinaus verhindern Codierungsstandards häufige Fallstricke und Fehler und verbessern die Codequalität. Bei der WordPress-Entwicklung arbeiten oft mehrere Personen an einem Projekt mit, sodass Kodierungsstandards die Grundlage für eine effektive Teamarbeit bilden. Sie erleichtern die Kommunikation, entschärfen potenzielle Konflikte und helfen, den Entwicklungsprozess effizienter zu gestalten.

Die Einhaltung von Kodierungsstandards fördert die Konsistenz zwischen Projekten und erleichtert den Entwicklern den nahtlosen Wechsel zwischen verschiedenen Codebasen. Diese Konsistenz wirkt sich auch auf die Lesbarkeit und Wartbarkeit des Codes aus und fördert ein gemeinsames Verständnis der Teammitglieder.

Die offiziellen WordPress-Codierungsstandards umfassen fünf Schlüsselbereiche für einen kohärenten und effizienten Entwicklungsprozess:

• PHP gewährleistet serverseitige Code-Konsistenz
• HTML zur Förderung von strukturierten und semantischen Auszeichnungen
• JavaScript für effektive clientseitige Funktionen
• CSS für einheitliche Stylingmethoden
• Sicherstellen, dass das Endprodukt integrativ und benutzerfreundlich ist und für Menschen mit unterschiedlichen Bedürfnissen zugänglich ist

PHP-Standards in der WordPress-Entwicklung

WordPress-spezifischPHP-CodierungsstandardsDiese Standards, die die Konsistenz und Lesbarkeit des WordPress-Codes gewährleisten, sind für den WordPress-Kern obligatorisch und werden für Themes und Plugins dringend empfohlen. Diese Standards decken alles ab, von Namenskonventionen über Einrückungen bis hin zur Codestruktur, um die Lesbarkeit zu verbessern und die Zusammenarbeit zu erleichtern.

Die WordPress-PHP-Standards umfassen die folgenden Kategorien:

• in allgemeinen Worten- Zu diesen Standards gehören: Platzierung der öffnenden und schließenden PHP-Tags in einer separaten Zeile, wenn mehrzeilige PHP-Snippets in HTML-Codeblöcke eingebettet werden; Vermeidung von Kurzschrift-PHP-Tags bei der Verwendung von einfachen und doppelten Anführungszeichen; und Richtlinien für das Schreiben von include- und require-Anweisungen:

// Öffnen und Schließen von PHP-Tags in HTML.
// Öffnen/Schließen von Tags in eigene Zeilen setzen.

## DO
Funktion foo() {
  foo() { >DO function foo() { ?
  <div>
    <?php
    echo esc_html (
      bar (
        $param1,
        $param2
      )
    );
    ?>
  </div>
  <?php
}

## DON'T
if ( $x === $y ) { ?>
  <div>
    <!-- HTML content -->
  <?php }

// Vermeiden Sie abgekürzte PHP-Tags

## DO



## NICHT
Ich weiß nicht, was ich sagen soll.

// Schreiben von include/require-Anweisungen.
// Vermeiden Sie include_once, da es die Ausführung fortsetzt
// auch wenn die Datei nicht gefunden wird.
// Verwenden Sie keine Klammern um den Dateipfad.

## DO
require_once ABSPATH . 'datei-name.php'

## DON'T
require_once __DIR__ . '/Datei-Name.php'
include_once ( ABSPATH . 'daten-name.php' );

christen-Zu den Benennungsstandards gehören Namenskonventionen und die Interpolation von dynamischen Namenshaken:

## DO
// Verwenden Sie Kleinbuchstaben für Funktions- und Variablennamen.
function meine_funktion( $some_variable ) {}

// Verwenden Sie Großbuchstaben für Konstantennamen.
Define('MAX_AGE', 60);

## DON'T
// CamelCase verwenden.
function meineFunktion( $someVariable ) {}

void- Der Whitespace-Standard legt Richtlinien für die Verwendung von Leerzeichen, die Einrückung und die Entfernung von Leerzeichen am Ende fest. (Um eine lebhafte Diskussion unter Entwicklern anzustoßen, fragen Sie sie einfach, ob sie beim Einrücken von Code Tabulatoren oder Leerzeichen bevorzugen. Unabhängig von der Präferenz lautet die offizielle Empfehlung der WordPress-Entwickler, Tabulatoren zu verwenden, und dies gilt nicht nur für PHP, sondern auch für JavaScript und CSS. (Behalten Sie dies also im Hinterkopf, wenn Sie an gemeinsamen Projekten arbeiten).

## DO
// Fügen Sie Leerzeichen nach Kommas ein.
$colors = ['rot', 'grün', 'blau']

// Setzen Sie Leerzeichen auf beiden Seiten der öffnenden und
// Setzen Sie Leerzeichen auf beiden Seiten der öffnenden und schließenden Klammern von Kontrollstrukturen.
foreach( $foo as $bar ) { ...

// Definieren einer Funktion: function my_function() { .
function meine_funktion() { ...

// Logische Vergleiche: if ( !
wenn ( ! $foo ) { ...

// Zugriff auf Array-Elemente: $a = $foo['bar'] { ...
$a = $foo['bar']
$a = $foo[ $bar ]

## DON'T
$colors = ['rot','grün','blau']
foreach($foo as $bar){ ...
function meine_funktion(){ ...
if (!$foo) { ...
$a = $foo[ 'bar']
$a = $foo[$bar]

Formatierung- Zu den Formatierungsstandards für die WordPress-PHP-Entwicklung gehören Klammerstile, Array-Deklarationen, Richtlinien für mehrzeilige Funktionsaufrufe, Typdeklarationen, magische Konstanten und Erweiterungsoperatoren:

// DO
// Verwenden Sie den folgenden Klammerstil.
if ( Bedingung ) {
    action(); } elseif ( condition2 ) {
} elseif ( Bedingung2 ) {
    action2(); } elseif ( Bedingung2 ) { action2()
} else {
    default_action(); } elseif ( condition2 ) { action2(); } else { default_action()
}

// Deklarieren Sie Arrays mit der Long-Syntax.
$numbers_long = array(1, 2, 3, 4, 5); // Bei mehrzeiligen Funktionsaufrufen sollte jeder Parameter nur eine Zeile einnehmen.
/* Bei mehrzeiligen Funktionsaufrufen sollte jeder Parameter nur eine Zeile einnehmen.
Mehrzeilige Parameterwerte sollten einer Variablen zugewiesen werden, und die Variable sollte an den Funktionsaufruf übergeben werden. */
$data = array(
    
    
    
).
$greeting_message = sprintf(
    /* Übersetzungsfunktion. %s entspricht dem Namen des Benutzers */
    __( 'Hallo, %s!', 'yourtextdomain' ),
    $data['user_name']
);
$result = some_function (
    $data,
    $greeting_message, $data('user_name') ); $result = some_function (
    /* Übersetzungsfunktion, die %s auf den Städtenamen abbildet*/
    sprintf( __( 'Benutzer wohnt in %s.' ), 'Cityville' )
);

// Magische Konstanten sollten in Großbuchstaben geschrieben werden.
// Die ::class-Konstante sollte kleingeschrieben werden, ohne Leerzeichen um den Bereichsauflösungsoperator (::).
add_action( my_action, array( __CLASS__, my_method ) ); // Die ::class-Konstante sollte in Kleinbuchstaben geschrieben werden, ohne Leerzeichen um den Bereichsauflösungsoperator (::).
add_action( my_action, array( My_Class::class, my_method ) );; add_action( my_action, array( __CLASS__, my_method ); add_action( my_action, array( My_Class::class, my_method ) ).

/* Fügen Sie ein Leerzeichen oder eine neue Zeile mit entsprechender
   Einrückung vor einem Spread-Operator.

   Das sollte sein.

   /* Fügen Sie vor einem Spread-Operator ein Leerzeichen oder eine neue Zeile mit angemessener Einrückung ein.
     Kein Leerzeichen zwischen dem Spread-Operator und der Variablen/Funktion, auf die er sich bezieht.

   * Kein Leerzeichen zwischen dem Spread-Operator und der Referenz
     Kein Leerzeichen zwischen dem Spread- und dem Referenzoperator, wenn sie kombiniert werden.
*/Kein Leerzeichen zwischen dem Spread- und dem Referenzoperator, wenn sie kombiniert werden.

//DO
Funktion some_func( &. .$arg1 ) {
    bar( ... .$arg2 );
    bar(
        array( ... .$arg3 ), .
        ... .array_values( $array_vals )
    );
}

//DONT
function some_func( & ...  $arg1 ) {
    bar( ...
        $arg2 );
    bar(
        array( ... .$arg3 ),... .array_values( $array_vals )
    );
}

Deklarationsanweisungen, Namespaces und Importanweisungen- Diese Kodierungsstandards umfassen Namespace-Deklarationen undverwenden.Erklärungen:

// Jede Namespace-Deklaration sollte enthalten
// großgeschriebene Wörter, getrennt durch Unterstriche.
namespace My_CompanyProjectKinsta_ProjectUtilities; namespace My_CompanyProjectKinsta_ProjectUtilities.

// Importanweisungen können Aliase verwenden, // um Namenskollisionen zu vermeiden.
// um Namenskollisionen zu vermeiden.
use Project_NameFeatureClass_C as Aliased_Class_C; // Importverwendungsanweisungen können Aliase // verwenden, um Namenskollisionen zu vermeiden.

objektorientierte Programmierung (OOP) - Zu diesen Standards gehören die Verwendung von nur einer Objektstruktur pro Dokument, die Bereitstellung des Zugriffs auf Merkmale und die Verwendung der Merkmale "C" und "D".verwenden.Anweisungen, eine Anleitung, wie man sicherstellt, dass die Sichtbarkeit immer deklariert wird, eine Übersicht über die Reihenfolge von Sichtbarkeit und Modifikatoren und eine Übersicht über die Regeln für die Objektinstanziierung:

// Trait-Use-Anweisungen sollten am Anfang einer Klasse stehen.
// Trait-Use-Anweisungen sollten am Anfang einer Klasse stehen.
// die erste und die letzte Anweisung.
// Deklarieren Sie immer die Sichtbarkeit.
Klasse Foo {
    use Bar_Trait; public $baz = Bar_Trait
    public $baz = true; ...
    ...
}

// Verwenden Sie immer Klammern, wenn Sie eine neue Instanz eines
// Objektinstanz.
// Fügen Sie keine Leerzeichen zwischen einem Klassennamen und der öffnenden Klammer ein.
$foo = new Foo(); // Fügen Sie keine Leerzeichen zwischen einem Klassennamen und der öffnenden Klammer ein.

Kontrollstruktur- Die Kontrollstruktur umfasst die Verwendung von elseifnichtsonst wennYoda-Anweisung: Wenn Sie Variablen mit Konstanten, Literalen oder Funktionsaufrufen in logischen Vergleichen mischen, platzieren Sie die Variablen auf der rechten Seite, um versehentliche Zuweisungen zu vermeiden, wie unten gezeigt:

// Ein "legaler" Vergleich: if ( true === $result ) {
if ( true === $result ) {
    // Etwas mit $resultat machen
}

// Aber ein Tippfehler wie dieser könnte Ihnen entgehen: if ( $result = true ) { // Machen Sie etwas mit $result }
if ( $result = true ) { // Machen Sie etwas mit $result } // Aber ein Tippfehler wie dieser könnte Ihnen entgehen.
    // Wir werden immer hier enden

Operator (Rechnen)- Diese Normen umfassen ternäre Operatoren, Fehlerkontrolloperatoren ( @) und Inkrement/Dekrement-Operatoren:

// haben immer ternäre Operatoren
// Testen Sie, ob die Aussage wahr und nicht falsch ist.
$programming_language = ( 'PHP' === $language ) ? 'cool' : 'meh';

// Bevorzugen Sie "pre-increment/decrement" gegenüber "post-increment/decrement".
// für eigenständige Anweisungen.

// DO
--$a.

// DON'T
$a--; // DON'T

• umfassende Datenbank- Der Database Coding Standard enthält Anweisungen zur Ausführung von Datenbankabfragen und zur Formatierung von SQL-Anweisungen.
• Andere Empfehlungen- Andere Vorschläge umfassen Standards wie die Verwendung selbsterklärender Flag-Werte für Funktionsargumente, cleveren Code, Closures (anonyme Funktionen), reguläre Ausdrücke, Shell-Befehle und Anweisungen zur Vermeidung vonAuszug().

WordPress Inline-Dokumentation Standard für PHP-Code

Zusätzlich zu den oben genannten Richtlinien stellt WordPress auch PHP-Code für dieInline-Dokumentation Standard. WordPress verwendet eine benutzerdefinierte Dokumentenarchitektur, die sich an der PHPDoc-Syntax orientiert, einem sich entwickelnden Standard zur Erstellung benutzerdefinierter Dokumente fürphpDocumentorFür PHP-Code, der gewartet wird, wird eine Dokumentation bereitgestellt. Diese Standards vereinfachen die Erstellung von externer Dokumentation und tragen zur breiteren WordPress-Entwicklergemeinschaft bei, indem sie ein gemeinsames Verständnis der Struktur der Codebasis fördern.

Die PHP-Dokumentation in WordPress wird meist als formatierte Blöcke oder Inline-Kommentare angezeigt. Dokumentieren Sie das Folgende in Ihren WordPress-Dateien:

• Funktionen und Klassenmethoden
• Klassen
• Klassenmitglieder, einschließlich Eigenschaften und Konstanten
• Erfordert und enthält
• Haken (Betriebs- und Filterhaken)
• Inline-Kommentare
• Kopfzeile
• eine Konstante (math.)

HTML- und CSS-Standards in WordPress

WordPress Themes und Plugins folgen strengenHTML-Kodierungsstandards.um Konsistenz, Zugänglichkeit und Wartungsfreundlichkeit zu gewährleisten. Die Richtlinien legen den Schwerpunkt auf semantisches Markup und ermutigen Entwickler, HTML-Elemente für den vorgesehenen Zweck zu verwenden. Dieser Ansatz verbessert die Struktur der Inhalte und die Leistung der Suchmaschinenoptimierung (SEO).

Der HTML-Code-Standard bietet eine Anleitung zu den folgenden Punkten:

• Validierung - sollte sich auf dieW3C-ValidiererValidieren Sie alle HTML-Seiten, um sicherzustellen, dass das Markup korrekt formatiert ist.
• Selbstschließendes Element- Einem Schrägstrich in einem selbstschließenden Element sollte ein Leerzeichen vorangestellt werden.

<!-- DO -->
<br />

<!-- DON'T –>
<br/>

Attribute und Tags -Alle Attribute und Tags sollten klein geschrieben werden. Darüber hinaus sollten Attributwerte nur dann klein geschrieben werden, wenn sie von einer Maschine interpretiert werden. Wenn sie für Menschen geschrieben werden, sollte die korrekte Großschreibung von Überschriften verwendet werden.

<!-- DO -->
<a href="http://example.com/" title="Link Beschreibung">Beschreibender Text</a>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />

<!-- DON'T -->
<a href="http://example.com/" title="Linkbeschreibung">Klicken Sie hier</a>

Anführungszeichen (punct.)- Alle Attribute müssen einen Wert haben und entweder in einfache oder doppelte Anführungszeichen gesetzt werden. Werden diese Werte nicht in Anführungszeichen gesetzt, kann dies zu einer Sicherheitsverletzung führen.

<!

Einzüge- Die HTML-Einrückung sollte immer die logische Struktur widerspiegeln. Wenn Sie PHP und HTML mischen, rücken Sie PHP-Blöcke so ein, dass sie mit dem umgebenden HTML-Code übereinstimmen.

<!-- DO -->
<?php if ( ! have_articles() ) : ?>
<div class="article">
    <h1 class="article-title">Nicht gefunden</h1>
    <div class="article-content">
        <p>Es wurden keine Ergebnisse gefunden.</p>
        <?php get_error_msg(); ?>
    </div>
</div>
<?php endif; ?>

<!-- DON'T -->
<?php if ( ! have_articles() ) : ?>
<div class="article">
<h1 class="article-title">Nicht gefunden</h1>
<div class="article-content">
<p>Es wurden keine Ergebnisse gefunden.</p>
<?php get_error_msg(); ?>
</div>
</div>
<?php endif; ?>

Zusätzlich zu diesen HTML-StandardsDer WordPress-CSS-Standard enthält auchkönnen helfen, saubere, modulare und reaktionsfähige Stylesheets zu erstellen. Sie bilden eine Grundlage für die Zusammenarbeit und Überprüfung von Kerncode, Themes und Plugins. Diese Richtlinien stellen sicher, dass der Code lesbar und konsistent ist und einen Sinn ergibt.

Die WordPress-CSS-Code-Standards betonen die Verwendung spezifischer Klassen zur Positionierung von Elementen und fördern so eine konsistente und organisierte Struktur. Im Einzelnen werden die folgenden Standards umrissen:

Rahmenwerk::

/* DO
Jeder Selektor sollte in einer eigenen Zeile stehen und mit
Jeder Selektor sollte in einer eigenen Zeile stehen und mit einem Komma oder einer geschweiften Klammer abgeschlossen werden.
Die schließende Klammer sollte auf der gleichen Einrückungsebene stehen wie der öffnende Selektor.
Die schließende Klammer sollte dieselbe Einrückungsebene einnehmen wie der öffnende Selektor.
#selector-2 {
    Eigenschaft: value; }
}

Kommissionierer::

/* DO
Verwenden Sie Kleinbuchstaben und trennen Sie Wörter mit Bindestrichen.
Verwenden Sie doppelte Anführungszeichen um Werte für Attributselektoren.
Vermeiden Sie überqualifizierte Selektoren, wie z.B. div. container. */
#contact-form {
    Eigenschaft: value; }
}
input[type="text"] {
    Eigenschaft: value; }
}

Kausalität(Bestell- und Lieferantenpräfixe):

/* Eigenschaften werden mit einem Doppelpunkt und einem Leerzeichen angehängt.
Eigenschaften sollten in Kleinbuchstaben geschrieben werden - außer Schriftartennamen
und anbieterspezifische Eigenschaften - und verwenden Sie die Kurzschrift */
#selector {
    property: value; /* Eigenschaften mit einem Doppelpunkt und einem Leerzeichen anhängen.
}

Abb. Werte (ethische, kulturelle usw.)::

/* Fügen Sie ein Leerzeichen vor und ein Semikolon nach dem Wert ein.
Verwenden Sie doppelte Anführungszeichen.
0-Werte sollten keine Einheiten haben.
Verwenden Sie eine führende Null für dezimale Werte.
Mehrere kommagetrennte Werte für
Trennen Sie mehrere kommagetrennte Werte für eine einzelne Eigenschaft durch ein Leerzeichen oder eine neue Zeile.
#Kontakt-Formular {
    font-family: "Helvetica Neue", sans-serif; opacity: 0.9; }
    
    box-shadow.
        0 0 0 0 1px #5b9dd9,
        0 0 0 2px 1px rgba(20, 120, 170, 0.9);
}

Medien-Anfrage::

/* Regeln für Medienabfragen sollten um eine Ebene eingerückt werden.
Medienabfragen sollten nach Medien gruppiert am Ende des Stylesheets stehen. */
@media all and (max-width: 1024px) and (min-width: 780px) {
    $selector {
        Eigenschaft: value; }
    }
}

Die HTML- und CSS-Codierungsstandards von WordPress orientieren sich seit der Gründung im Jahr 2003 an den HTML- und CSS-Richtlinien des World Wide Web Consortium (W3C), die die Integration von responsiven Designprinzipien und semantischem Markup betonen und die Entwicklung von Themes und Plugins seit der Veröffentlichung von HTML5 und CSS3 beeinflussen.

Durch die Übernahme der W3C-Richtlinien wird sichergestellt, dass WordPress-Websites den globalen Webstandards entsprechen, die Interoperabilität und das Benutzererlebnis verbessert werden und ein Engagement für Aktualität, Sicherheit und Kompatibilität innerhalb des gesamten Web-Ökosystems zum Ausdruck kommt.

Die Einhaltung dieser Leitlinien in WordPress unterstreicht die Bedeutung einer gezielten Ausrichtung auf dieW3C HTML Markup ValidatorHTML-Qualitätsüberprüfung durchführen.

Diese HTML- und CSS-Standards sorgen dafür, dass WordPress-Websites optisch ansprechend und benutzerfreundlich sind und plattformübergreifend effizient dargestellt werden. Sie unterstützen ein nahtloses Benutzererlebnis und erleichtern die Zusammenarbeit zwischen Entwicklern aus verschiedenen Bereichen des WordPress-Ökosystems.