register_post_meta()

Définition : register_post_meta() déclare une clé de métadonnée pour un type de publication WordPress. Elle précise son type, sa cardinalité, sa valeur par défaut et les règles de validation ou d’accès.

Terminologie

Terme officiel : register_post_meta()

Autres appellations : Déclaration de métadonnée

À quoi cela sert

Elle formalise les champs personnalisés d’un plugin : types attendus, nettoyage, autorisation et éventuelle exposition dans l’API REST. La fiche peut ainsi devenir exploitable par un éditeur ou une intégration maîtrisée.

Comment cela fonctionne

La fonction enregistre une clé dans le registre WordPress. Cette déclaration ne crée pas forcément une ligne de métadonnée ; elle décrit comment la plateforme doit gérer cette clé lorsqu’elle est utilisée.

Dans quel contexte l’utiliser

À déclarer pendant init, avant utilisation des métadonnées dans des interfaces ou via l’API REST.

Exemple concret

Un plugin déclare une couleur documentaire contrôlée, limitée à une chaîne, qui doit rester non exposée publiquement dans sa première version.

Exemple de code commenté

Extrait pédagogique PHP pour extension WordPress : adapter au contexte et tester sur un environnement de développement avant tout usage.

<?php
add_action( 'init', function () {
    register_post_meta( 'post', 'atoolpha_couleur', array(
        'single'            => true,
        'type'              => 'string',
        'default'           => 'bleu',
        'sanitize_callback' => 'sanitize_text_field',
        'show_in_rest'      => false,
    ) );
} );

Explication pas à pas de l’exemple

1. La déclaration se déroule à init. 2. Elle s’applique aux articles post. 3. single et type encadrent la valeur. 4. Le callback nettoie les textes. 5. show_in_rest reste désactivé dans cet exemple.

Résultat attendu

La clé est connue du registre et dispose de règles ; aucun formulaire ni enregistrement de valeur utilisateur n’apparaît automatiquement.

Mise en pratique guidée

Déclarer la clé dans un plugin de démonstration chargé à init. Vérifier ensuite que la déclaration n’a pas créé automatiquement de boîte de saisie ni de ligne postmeta. Ajouter séparément une valeur contrôlée et la lire. Ce test clarifie la séparation entre le contrat des données et les opérations réelles de sauvegarde.

Précautions et limites

En présence d’un type personnalisé, vérifier le support custom-fields et la politique d’accès. Pour une exposition REST, définir soigneusement le schéma et l’autorisation.