Plugin Header

Définition : Le Plugin Header est un commentaire structuré placé dans le fichier PHP principal d’une extension WordPress. Il fournit au Core les métadonnées nécessaires pour identifier, afficher et gérer cette extension dans l’administration.

Terminologie

Terme officiel : Plugin Header

Autres appellations : Métadonnées de plugin, En-tête d’extension

À quoi cela sert

Il sert de carte d’identité du plugin. WordPress y reconnaît au minimum le champ Plugin Name ; les autres champs précisent version, compatibilité PHP et WordPress, auteur, licence, domaine de traduction ou dépendances. Un en-tête fiable améliore la maintenance et l’information des administrateurs.

Comment cela fonctionne

Lorsqu’il parcourt les extensions, WordPress lit des champs prédéfinis dans le fichier principal. Ces lignes sont des commentaires PHP, non des instructions exécutées. L’en-tête ne charge pas automatiquement les fonctionnalités ni ne garantit à lui seul la compatibilité annoncée.

Dans quel contexte l’utiliser

Créer un nouveau plugin autonome ; vérifier aussi l’en-tête avant une distribution ou une mise à jour. Le fichier principal se trouve généralement dans un dossier dédié sous wp-content/plugins.

Exemple concret

Un développeur prépare un petit module ATOOLPHA pédagogique et veut qu’il apparaisse sous un nom intelligible dans Extensions.

Exemple de code commenté

<?php
/**
 * Plugin Name: ATOOLPHA Démonstration
 * Description: Exemple pédagogique sans action sur le site.
 * Version: 1.0.0
 * Requires at least: 6.5
 * Requires PHP: 8.0
 * Author: ATOOLPHA
 * Text Domain: atoolpha-demo
 * License: GPL-2.0-or-later
 */
// Aucun traitement exécuté : uniquement un en-tête.

Explication pas à pas de l’exemple

1. WordPress lit Plugin Name et affiche le module dans la liste. 2. Version fournit le numéro de livraison. 3. Requires at least et Requires PHP déclarent les minimums annoncés. 4. Le domaine de traduction permet d’associer les chaînes traduisibles au plugin.

Résultat attendu

Une entrée « ATOOLPHA Démonstration » apparaît dans l’administration après mise en place du fichier ; le code ne crée aucune page ni fonctionnalité.

Précautions et limites

Ne pas annoncer une compatibilité non testée. Utiliser un nom de plugin et un Text Domain cohérents ; vérifier les licences des fichiers distribués.

À ne pas confondre

Ne pas confondre l’en-tête avec un fichier readme.txt de distribution ni avec la classe PHP qui initialise effectivement les fonctions.

Termes associés

  • Plugin Dependencies
  • Plugin Lifecycle

Références officielles

Bouton retour en haut de la page