get_post_meta( int $post_id, string $key = '', bool $single = false )

Retourne la valeur d'un champ de méta-donnée pour un id de poste donné.

Paramètres

$post_id(int)requis

Id du poste.

$key(string)optionnel

Clé de la méta dont la valeur est à retourner. Si omis, la fonction retournera les valeurs de toutes les métas liées à un poste dans un tableau.

Valeur par défaut : ''

$single(bool)optionnel

Si true, la valeur sera retournée simplement, si laissé à false, la valeur sera retournée dans un tableau. Si $key est omis ce réglage n'aura aucun effet.

Valeur par défaut : false

Description / Informations supplémentaires

Si le champ de méta n'est pas trouvé pour une clé et un id de poste donnés :

  • Si $single = true, une chaîne vide est retournée.
  • Si $single = false, un tableau vide est retourné.

Retourne

(mixed) La valeur du champ de méta-donnée dans un tableau si $single = false, simplement la valeur si $single = true. False si $post_id est invalide.

Déclaration et structure de la fonction get_post_meta()

function get_post_meta( $post_id, $key = '', $single = false ) {
    return get_metadata( 'post', $post_id, $key, $single );
}
get_metadata()

Retourne la valeur d'un champ de méta-donnée pour un type d'objet et un id spécifiés.

Où est utilisée la fonction get_post_meta() dans le CMS WordPress

Exemples

Si la fonction retourne une chaîne ou un tableau vide, elle pourra être évaluée comme false dans une condition :
if( ! get_post_meta( '1', 'meta_existante_ou_non', false ) ){
    // Code ici ...
}
L'exemple précédent ne fait pas la différence si la valeur du champ de méta est vide ou inexistante, pour cela :
if( ! in_array( 'given_key', get_post_custom_keys( '1' ) ) ) {
    // Code ici ...
}

Sources

Codex WordPress : get_post_meta()

Autres fonctions dans le même fichier : wp-includes/post.php

Retour