OpenByt - Votre source ultime de connaissances gratuites sur WordPress

Comprendre l'importance des normes de codage

openbyt

Les normes de codage sont comme les règles de grammaire de la programmation. Tout comme une grammaire correcte rend le langage écrit clair et compréhensible, les normes de codage rendent votre code cohérent et lisible.

Application concrète des normes de codage dans le travail d'équipe

Imagine you’re working on a WordPress project as part of a large team. Everyone contributes different parts of the code—some focus on the backend, others on styling, and others on accessibility. Without consistent standards, the project can become chaotic quickly. Coding standards ensure that:

Imaginez qu'un développeur quitte le projet et qu'un nouveau membre de l'équipe doive le remplacer. Si le développeur précédent a respecté les normes de codage appropriées, le nouveau membre peut intervenir rapidement, maintenir le code et y apporter des améliorations sans avoir besoin de beaucoup de temps pour le comprendre.

WordPress Normes de codage PHP

PHP is WordPress’s core language. Following the PHP coding standards ensures that your code integrates smoothly with WordPress and is easy for others to understand.

1. balises PHP : Utilisez toujours les balises PHP complètes <?php ?>. Évitez les balises courtes comme <? ?> car ils peuvent ne pas fonctionner sur tous les serveurs.

<?php
// Your PHP code here
?>

2. encodage des fichiers : Enregistrez vos fichiers PHP en UTF-8 sans marque d'ordre des octets (BOM).

3. fin de ligne : Utilisez des fins de ligne de style Unix (\n).

4. indentation : Utilisez les tabulations pour l'indentation (et non les espaces). Cela permet d'assurer la cohérence du code entre les différents éditeurs.

Conventions d'appellation

1. fonctions et méthodes : Utilisez des lettres minuscules et des caractères de soulignement.

function get_user_data( $user_id ) {
    // Code de la fonction
}

2. les variables : Identiques aux fonctions - minuscules et caractères de soulignement.

$user_name = 'John Doe' ;

3.Classes : Utilisez des mots en majuscules (StudlyCaps).

class UserProfile {
// Code de la classe
}

4. constantes : Toutes les lettres majuscules et les caractères de soulignement.

define('MAX_UPLOAD_SIZE', 1048576 ) ;

Espaces blancs et indentation

1) Espaces après les virgules : Lorsque vous énumérez des paramètres ou des éléments de tableau, ajoutez un espace après chaque virgule.

$colors = array('red', 'green', 'blue' ) ;

2. structures de contrôle : Placez un espace entre les mots-clés de contrôle et la parenthèse ouvrante.

if ( $condition ) {
    // Code
}

3. opérateurs : Incluez des espaces autour des opérateurs d'affectation, de comparaison et logiques.

$total = $price + $ax ;
if ( $total > 100 ) {
    // Code
}

Structures de contrôle

1) Placement des accolades : Utilisez le style Allman, où l'accolade d'ouverture se trouve sur une nouvelle ligne.

if ( $condition )
{
    // Code
}
else
{
    // Code
}

2.elseif** Mot clé** : Utilisation elseif au lieu de sinon si.

if ( $condition )
{
    // Code
}
elseif ( $other_condition )
{
    // Code
}

3. les conditions Yoda : Placez la constante ou le littéral à gauche des comparaisons.

if ( true === $is_active )
{
    // Code
}

Cela permet d'éviter une affectation accidentelle (= au lieu de ==).

Meilleures pratiques

1. évitez les balises PHP abrégées : Utilisez toujours les balises complètes pour une meilleure compatibilité.

2.Arguments de fonction : Utilisez des noms de variables clairs et descriptifs.

function calculate_total( $subtotal, $ax_rate ) {
    // Code
}

3. assainir les entrées : Vérifiez toujours les entrées des utilisateurs et validez-les.

$user_id = intval( $_GET['user_id'] );

4) Échapper aux sorties : Avant de sortir des données, échappez-les pour éviter les problèmes de sécurité.

echo esc_html( $user_name ) ;

5.Commentaires : Utilisez les commentaires pour expliquer une logique complexe ou des remarques importantes.

// Calculer le prix total avec les taxes

Normes de documentation en ligne

Une documentation appropriée facilite la compréhension et la maintenance de votre code.

1. commentaires sur les fonctions : Chaque fonction est précédée d'un bloc de commentaires.

/**
 * Calcule le prix total TTC.
 *
 * @param float $subtotal Le montant du sous-total.
 * @param float $tax_rate Le taux d'imposition sous forme décimale.
 * @return float Le prix total.
 */
function calculate_total( $subtotal, $tax_rate ) {
    // Code de la fonction
}

2. les types de paramètres et de valeurs de retour : Indiquez le type de chaque paramètre et la valeur de retour.

3. les commentaires en ligne : Utilisez-les avec parcimonie pour expliquer les parties complexes de votre code.

$discount = 0.0 ; // Initialisation de la variable discount

Normes de codage HTML dans WordPress

Le langage HTML est l'épine dorsale du contenu web. L'écriture d'un code HTML propre et sémantique est cruciale pour l'accessibilité et le référencement.

Lignes directrices générales

1. Doctype : Commencez toujours par le doctype HTML5.

<!DOCTYPE html>

2. l'attribut Language : Spécifiez la langue dans l'attribut <html> étiquette.

<html lang="en">

3. codage des caractères : Utilisez le codage UTF-8.

<meta charset="UTF-8">

Structurer votre HTML

1. éléments sémantiques : Utilisez les éléments sémantiques HTML5 tels que En-tête>,

Quitter la version mobile