get_post_meta() | Fonctions Wordpress

Description

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é.

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

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.

Structure de la fonction `get_post_meta()`

Définie dans le fichier wp-includes/post.php à la ligne 2219 :

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

Fonction utilisée par `get_post_meta()`

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ù trouver 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