Introduction aux normes de codage de WordPress - Photon Flux | Service professionnel de réparation de WordPress, portée mondiale, réponse rapide

Les normes de codage dans le développement de WordPress sont essentielles pour une base de code solide et durable. Il s'agit de directives et de conventions que les développeurs suivent lorsqu'ils écrivent du code, ce qui permet d'améliorer la collaboration, de simplifier la maintenance et d'assurer la fiabilité générale.

En outre, les normes de codage permettent d'éviter les pièges et les erreurs courantes et d'améliorer la qualité du code. Dans le cadre du développement de WordPress, de nombreux contributeurs collaborent souvent sur un même projet, de sorte que les normes de codage constituent la base d'un travail d'équipe efficace. Elles facilitent la communication, atténuent les conflits potentiels et contribuent à rendre le processus de développement plus efficace.

Le respect des normes de codage favorise la cohérence entre les projets et permet aux développeurs de passer plus facilement d'une base de code à l'autre. Cette cohérence s'étend à la lisibilité et à la maintenabilité du code et favorise une compréhension commune parmi les membres de l'équipe.

Les normes officielles de codage de WordPress couvrent cinq domaines clés d'un processus de développement cohérent et efficace :

PHP assure la cohérence du code côté serveur
HTML pour promouvoir le balisage structuré et sémantique
JavaScript pour une fonctionnalité efficace côté client
CSS pour des méthodes de stylisation cohérentes
Veiller à ce que le produit final soit inclusif et convivial, accessible aux personnes ayant des besoins divers.

Normes PHP dans le développement de WordPress

Spécifique à WordPressNormes de codage PHPAssurant la cohérence et la lisibilité du code WordPress, ces normes sont obligatoires pour le noyau de WordPress et fortement recommandées pour les thèmes et les plugins. Ces normes couvrent tout, des conventions de dénomination à l'indentation et à la structure du code, afin d'améliorer la lisibilité et de faciliter la collaboration.

Les normes PHP de WordPress couvrent les catégories suivantes :

de manière générale- Ces normes comprennent : le placement des balises PHP d'ouverture et de fermeture sur une ligne séparée lors de l'intégration d'extraits PHP sur plusieurs lignes dans des blocs de code HTML ; l'évitement des balises PHP abrégées lors de l'utilisation de guillemets simples et doubles ; et des lignes directrices pour l'écriture des instructions include et require :

// Ouverture et fermeture des balises PHP dans le code HTML.
// Placer les balises d'ouverture/fermeture sur leurs propres lignes.

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

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

// Éviter les balises PHP abrégées

## DO



## NE LE FAIT PAS
Je ne sais pas quoi dire.

// Rédaction d'instructions include/require.
// Évitez include_once, car il poursuit l'exécution
// même si le fichier n'est pas trouvé.
// Ne pas utiliser de parenthèses autour du chemin d'accès au fichier.

## DO
require_once ABSPATH . 'nom-de-fichier.php'

## NE FAIT PAS
require_once __DIR__ . '/nom-de-fichier.php'
include_once ( ABSPATH . 'nom-de-fichier.php' ) ;

christen-Les normes de dénomination comprennent les conventions de dénomination et l'interpolation des crochets dynamiques de dénomination :

## DO
// Utilisez des lettres minuscules pour les noms de fonctions et de variables.
function ma_fonction( $some_variable ) {}

// Utilisez des lettres majuscules pour les noms de constantes.
Define('MAX_AGE', 60) ;

## NE PAS FAIRE
// Utiliser la camelCase.
function myFunction( $someVariable ) {}

vide- La norme sur les espaces blancs établit des lignes directrices pour l'utilisation des espaces, l'indentation et la suppression des espaces de fin. (Pour lancer une discussion animée entre développeurs, il suffit de leur demander s'ils préfèrent les tabulations ou les espaces lors de l'indentation du code. Quelle que soit leur préférence, les développeurs de WordPress recommandent officiellement d'utiliser les tabulations, et cela vaut non seulement pour le PHP, mais aussi pour le JavaScript et le CSS. (Gardez donc cela à l'esprit lorsque vous travaillez sur des projets collaboratifs).

## DO
// Mettez des espaces après les virgules.
$colors = ['red', 'green', 'blue']

// Mettre des espaces de part et d'autre des parenthèses ouvrante et fermante.
// Mettre des espaces de part et d'autre des parenthèses ouvrantes et fermantes des structures de contrôle.
foreach( $foo as $bar ) { ...

// Définition d'une fonction : function my_function() { ...
function my_function() { ...

// Comparaisons logiques : if ( !
if ( ! $foo ) { ...

// Accès aux éléments d'un tableau : $a = $foo['bar'] { ...
$a = $foo['bar']
$a = $foo[ $bar ]

## DON'T
$colors = ['red', 'green', 'blue']
foreach($foo as $bar){ ...
function my_function(){ ...
if (!$foo) { ...
$a = $foo[ 'bar']
$a = $foo[$bar]

mise en forme- Les normes de formatage pour le développement WordPress PHP comprennent les styles de crochets, les déclarations de tableaux, les directives pour les appels de fonctions sur plusieurs lignes, les déclarations de types, les constantes magiques et les opérateurs d'expansion :

// DO
// Utilisez le style d'accolade suivant.
if ( condition ) {
    action() ; } elseif ( condition2 ) {
} elseif ( condition2 ) {
    action2() ; } elseif ( condition2 ) { action2()
} else {
    default_action() ; } elseif ( condition2 ) { action2() ; } else { default_action()
}

// Déclarez des tableaux en utilisant la syntaxe long.
$numbers_long = array(1, 2, 3, 4, 5) ; // Dans les appels de fonctions multilignes, chaque paramètre ne doit occuper qu'une ligne.
/* Dans les appels de fonctions multilignes, chaque paramètre ne doit occuper qu'une seule ligne.
Les valeurs des paramètres sur plusieurs lignes doivent être affectées à une variable, et la variable doit être transmise à l'appel de fonction. */
$data = array(
    
    
    
).
$greeting_message = sprintf(
    /* fonction de traduction. %s correspond au nom de l'utilisateur */
    __('Hello, %s!', 'yourtextdomain' ),
    $data['user_name']
) ;
$result = some_function (
    $data,
    $greeting_message, $data('user_name') ) ; $result = some_function (
    /* la fonction de traduction %s correspond au nom de la ville*/
    sprintf( __('User resides in %s.' ), 'Cityville' )
) ;

// Les constantes magiques doivent être en majuscules.
// La constante ::class doit être en minuscules, sans espace autour de l'opérateur de résolution de portée (: :).
add_action( my_action, array( __CLASS__, my_method ) ) ; // La constante ::class doit être en minuscules, sans espace autour de l'opérateur de résolution de portée (: :).
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 ) ).

/* Ajouter un espace ou une nouvelle ligne avec l'indentation
   indentation appropriée avant un opérateur d'étalement.

   Il devrait y avoir.

   /* Ajouter un espace ou une nouvelle ligne avec une indentation appropriée avant un opérateur d'étalement.
     Pas d'espace entre l'opérateur d'étalement et la variable/fonction à laquelle il s'applique.

   * Pas d'espace entre l'opérateur d'étalement et la référence
     Pas d'espace entre l'opérateur d'étalement et l'opérateur de référence lorsqu'ils sont combinés.
*/Pas d'espace entre l'opérateur d'étalement et l'opérateur de référence lorsqu'ils sont combinés.

//DO
function 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 )
    ) ;
}

Déclarations, espaces de noms et déclarations d'importation- Ces normes de codage couvrent les déclarations de l'espace de noms et l'utilisation de la technologie de l'information.utiliserDéclarations :

// Chaque déclaration d'espace de noms doit contenir
// des mots en majuscules séparés par des traits de soulignement.
namespace My_CompanyProjectKinsta_ProjectUtilities ; namespace My_CompanyProjectKinsta_ProjectUtilities.

// Les déclarations d'utilisation d'importation peuvent utiliser des alias // pour éviter les collisions de noms.
Les déclarations d'importation peuvent utiliser des alias // pour éviter les collisions de noms.
use Project_NameFeatureClass_C as Aliased_Class_C ; // Les déclarations d'importation peuvent utiliser des alias // pour éviter les collisions de noms.

la programmation orientée objet (POO) - Ces normes comprennent l'utilisation d'une seule structure d'objet par document, la fourniture d'un accès aux caractéristiques et l'utilisation des caractéristiques "C" et "D".utiliserun guide pour s'assurer que la visibilité est toujours déclarée, une vue d'ensemble de l'ordre de la visibilité et des modificateurs, et une vue d'ensemble des règles d'instanciation des objets :

// Les déclarations d'utilisation des traits doivent figurer au début de la classe.
// L'utilisation d'un trait doit être précédée et suivie d'au moins une ligne avant et après // la première et la dernière déclaration.
// la première et la dernière déclaration.
// Déclarez toujours la visibilité.
class Foo {
    use Bar_Trait ; public $baz = Bar_Trait
    public $baz = true ; ...
    ...
}

// Utilisez toujours des parenthèses lors de l'instanciation d'une nouvelle instance d'objet.
// nouvelle instance d'objet.
// N'ajoutez pas d'espace entre le nom de la classe et la parenthèse ouvrante.
$foo = new Foo() ; // N'ajoutez pas d'espace entre un nom de classe et la parenthèse ouvrante.

structure de contrôle- La structure de contrôle comprend l'utilisation elseifpassinon siet les critères conditionnels de Yoda. Déclaration de Yoda : Lorsque vous mélangez des variables avec des constantes, des littéraux ou des appels de fonction dans des comparaisons logiques, placez les variables du côté droit pour éviter des affectations involontaires, comme indiqué ci-dessous :

// Une comparaison "légale" : if ( true === $result ) {
if ( true === $result ) {
    // Faire quelque chose avec $result
}

// Mais une faute de frappe comme celle-ci pourrait vous échapper : if ( $result = true ) { // Faites quelque chose avec $result }
if ( $result = true ) { // Faites quelque chose avec $result } // Mais une faute de frappe comme celle-ci pourrait vous échapper.
    // Nous finirons toujours par arriver ici

opérateur (informatique)- Ces normes couvrent les opérateurs ternaires, les opérateurs de contrôle d'erreur ( @) et les opérateurs d'incrémentation/décrémentation :

// Il y a toujours des opérateurs ternaires
// tester si l'affirmation est vraie et non fausse.
$programming_language = ('PHP' === $language ) ? 'cool' : 'meh' ;

// Favoriser le pré-incrément/décrément par rapport au post-incrément/décrément.
// pour les déclarations autonomes.

// DO
--$a.

// DON'T
$a-- ; // NE PAS FAIRE

base de données complète- La norme de codage des bases de données fournit des instructions pour l'exécution des requêtes de base de données et le formatage des instructions SQL.
Autres recommandations- D'autres suggestions portent sur des normes telles que l'utilisation de valeurs de drapeaux explicites pour les arguments des fonctions, le code intelligent, les fermetures (fonctions anonymes), les expressions régulières, les commandes shell, et les instructions pour éviter de se retrouver dans une situation de conflit d'intérêts.extraire().

Standard de documentation en ligne de WordPress pour le code PHP

En plus des directives ci-dessus, WordPress fournit également un code PHP pour la fonctionNorme de documentation en ligne. WordPress utilise une architecture de documents personnalisés qui s'inspire de la syntaxe PHPDoc, une norme évolutive permettant de créer des documents personnalisés pour les applications suivantesphpDocumentorLa documentation est fournie pour le code PHP qui est maintenu. Ces standards simplifient la génération de documentation externe et contribuent à la communauté des développeurs WordPress en favorisant une compréhension commune de la structure de la base de code.

La documentation PHP dans WordPress est principalement affichée sous forme de blocs formatés ou de commentaires en ligne. Documentez les éléments suivants dans vos fichiers WordPress :

Fonctions et méthodes de classe
Classes
Les membres de la classe, y compris les propriétés et les constantes
Exige et contient
Crochets (de fonctionnement et de filtrage)
Commentaires en ligne
en-tête
une constante (math.)

Normes HTML et CSS dans WordPress

Les thèmes et les plugins WordPress suivent des règles strictesNormes de codage HTML.afin de garantir la cohérence, l'accessibilité et la facilité de maintenance. Les lignes directrices mettent l'accent sur le balisage sémantique, encourageant les développeurs à utiliser les éléments HTML dans le but pour lequel ils ont été conçus. Cette approche améliore la structure du contenu et les performances en matière d'optimisation des moteurs de recherche (SEO).

La norme du code HTML fournit des indications sur les points suivants :

Validation - devrait être basée sur laValidateur W3CValider toutes les pages HTML pour s'assurer que le balisage est formaté correctement.
Élément auto-fermant- Une barre oblique dans un élément à fermeture automatique doit être précédée d'un espace.

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

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

Attributs et balises -Tous les attributs et balises doivent être en minuscules. En outre, les valeurs des attributs ne doivent être en minuscules que lorsqu'elles sont interprétées par une machine. S'ils sont écrits pour des humains, les titres doivent être mis en majuscules.

<!-- DO -->
<a href="http://example.com/" title="Lien Description">Texte descriptif</a>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />

<!-- DON'T -->
<a href="http://example.com/" title="description du lien">Cliquez ici</a>

virgule inversée (ponct.)- Tous les attributs doivent avoir une valeur et utiliser des guillemets simples ou doubles. Le fait de ne pas mettre ces valeurs entre guillemets peut entraîner une violation de la sécurité.

< !

tirets- L'indentation HTML doit toujours refléter la structure logique. Lorsque l'on mélange PHP et HTML, l'indentation des blocs PHP doit correspondre à celle du code HTML environnant.

<!-- DO -->
<?php if ( ! have_articles() ) : ?>
<div class="article">
    <h1 class="article-title">Non trouvé</h1>
    <div class="article-content">
        <p>Aucun résultat n'a été trouvé.</p>
        <?php get_error_msg(); ?>
    </div>
</div>
<?php endif; ?>

<!-- DON'T -->
<?php if ( ! have_articles() ) : ?>
<div class="article">
<h1 class="article-title">Non trouvé</h1>
<div class="article-content">
<p>Aucun résultat n'a été trouvé.</p>
<?php get_error_msg(); ?>
</div>
</div>
<?php endif; ?>

En plus de ces normes HTMLLa norme CSS de WordPress prévoit égalementpeuvent aider à créer des feuilles de style propres, modulaires et réactives. Elles établissent une base de collaboration et d'examen du code principal, des thèmes et des plugins. Ces lignes directrices permettent de s'assurer que le code est lisible, cohérent et logique.

Les normes du code CSS de WordPress mettent l'accent sur l'utilisation de classes spécifiques pour positionner les éléments, favorisant ainsi une structure cohérente et organisée. Plus précisément, elles définissent les normes suivantes :

cadre: :

/* DO
Chaque sélecteur doit être sur sa propre ligne et se terminer par une virgule ou une accolade.
Chaque sélecteur doit être sur sa propre ligne et se terminer par une virgule ou une accolade.
L'accolade fermante doit occuper le même niveau d'indentation que le sélecteur d'ouverture.
L'accolade fermante doit occuper le même niveau d'indentation que le sélecteur d'ouverture.
#selector-2 {
    propriété : valeur ; }
}

cueilleur: :

/* DO
Utilisez des minuscules et séparez les mots par des traits d'union.
Utiliser des guillemets doubles autour des valeurs des sélecteurs d'attributs.
Éviter les sélecteurs surqualifiés, tels que div. container */
#contact-form {
    propriété : valeur ; }
}
input[type="text"] {
    propriété : valeur ; }
}

causalité(préfixes de commande et de fournisseur) :

/* Les propriétés sont précédées de deux points et d'un espace.
Les propriétés doivent être en minuscules - à l'exception des noms de polices
et les propriétés spécifiques au fournisseur - et utiliser la sténographie. */
#selector {
    property : value ; /* Ajouter les propriétés avec deux points et un espace.
}

fig. valeurs (éthiques, culturelles, etc.): :

/* Ajouter un espace avant la valeur et un point-virgule après.
Utilisez des guillemets doubles.
Les valeurs 0 ne doivent pas avoir d'unité.
Utiliser un zéro en tête pour les valeurs décimales.
Délimiter plusieurs valeurs séparées par des virgules pour une propriété unique.
Délimitez plusieurs valeurs séparées par des virgules pour une même propriété par un espace ou une nouvelle ligne.
#contact-form {
    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) ;
}

Demande de renseignements aux médias: :

/* Les règles définies pour les requêtes de média doivent être indentées d'un niveau.
Gardez les requêtes de média groupées par média au bas de la feuille de style. */
@media all and (max-width : 1024px) and (min-width : 780px) {
    $selector {
        property : value ; }
    }
}

Depuis sa création en 2003, les normes de codage HTML et CSS de WordPress ont été alignées sur les lignes directrices HTML et CSS du World Wide Web Consortium (W3C). Les normes W3C mettent l'accent sur l'intégration des principes de conception réactive et de balisage sémantique, et ont influencé le développement de thèmes et de plugins depuis la publication de HTML5 et CSS3.

L'adoption des lignes directrices du W3C garantit que les sites WordPress respectent les normes mondiales du web, améliore l'interopérabilité et l'expérience de l'utilisateur, et reflète un engagement à rester à jour, sécurisé et compatible au sein de l'écosystème web au sens large.

Le respect de ces lignes directrices dans WordPress souligne l'importance de cibler lesValidateur HTML du W3CEffectuer la validation de la qualité HTML.

Ces normes HTML et CSS garantissent que les sites web WordPress sont visuellement attrayants, conviviaux et présentés efficacement sur toutes les plateformes. Elles favorisent une expérience utilisateur transparente et facilitent la collaboration entre les développeurs des différents aspects de l'écosystème WordPress.

Contactez nous
Vous n'arrivez pas à lire le tutoriel ? Contactez-nous pour une réponse gratuite ! Aide gratuite pour les sites personnels et les sites de petites entreprises !	Service clientèle WeChat
① Tel : 020-2206-9892
② QQ咨询：1025174874
(iii) Courriel : info@361sale.com
④ Horaires de travail : du lundi au vendredi, de 9h30 à 18h30, jours fériés.