get_post_meta()

Définition : get_post_meta() récupère une métadonnée associée à une publication WordPress. Elle permet de lire une valeur enregistrée sous une clé précise, avec un retour simple ou une liste selon les arguments.

Terminologie

Terme officiel : get_post_meta()

Autres appellations : Lire les champs personnalisés

À quoi cela sert

La fonction sert à afficher ou exploiter des informations complémentaires qui ne font pas partie du titre ou du contenu principal : code interne, référence, date métier ou préférence propre à une fiche.

Comment cela fonctionne

WordPress consulte le système de métadonnées et ses caches pour retrouver la valeur liée à un identifiant de contenu. Avec le troisième paramètre true, une seule valeur est retournée ; sans ce mode, le résultat est un tableau.

Dans quel contexte l’utiliser

Choisir cette fonction pour lire une information persistante propre à un article ou à une page déjà identifiés.

Exemple concret

Une fiche de documentation affiche sa référence éditoriale conservée comme métadonnée privée.

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
$post_id = 123; // ID d’exemple, à remplacer par un vrai contenu.
$ref = get_post_meta( $post_id, '_atoolpha_reference', true );
if ( is_string( $ref ) && '' !== $ref ) {
    echo '<p>Référence : ' . esc_html( $ref ) . '</p>';
}

Explication pas à pas de l’exemple

1. Le code lit la clé _atoolpha_reference du contenu 123. 2. Le troisième argument demande une valeur unique. 3. Le type est contrôlé. 4. La sortie HTML est échappée.

Résultat attendu

Si la métadonnée existe et contient un texte, la référence est affichée sans interpréter les éventuelles balises qu’elle contient.

Mise en pratique guidée

Créer, en préproduction, un article portant la clé _atoolpha_reference. Comparer la lecture avec true, qui vise une valeur unique, et la lecture sans true, qui peut retourner une liste. Supprimer ensuite la clé et vérifier le résultat : ce cas sert à comprendre pourquoi une valeur vide ne suffit pas à prouver l’absence d’une métadonnée.

Précautions et limites

Une valeur absente peut être difficile à distinguer d’une valeur vide. Pour connaître explicitement la présence d’une clé, utiliser metadata_exists().