get_metadata( string $meta_type, int $object_id, string $meta_key = '', bool $single = false )

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

Description

Si le champ de méta existe :
- Si $single = true, la valeur est retournée.
- Si $single = false, la valeur dans un tableau est retournée.

Si le champ de méta n'existe pas, le résultat dépend de get_metadata_default(). Par défaut :
- Si $single = true, une chaîne vide est retournée.
- Si $single = false, un tableau vide est retourné.

Paramètres

$meta_type

(string) (Requis) Type d'objet pour lequel on recherche la valeur de la méta-donnée. Accepte 'post', 'comment', 'term', 'user' ou tout autre type d'objet associé à une table de méta-donnée.

$object_id

(int) (Requis) Id de l'objet.

$meta_key

(string) (Optionnel) Clé de la méta-donnée. Si non spécifiée, retourne les valeurs de toutes les méta-données liées à l'objet spécifié par son id.

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 $meta_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 s'il y a un problème avec les paramètres passés à la fonction.

Structure de la fonction get_metadata()

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

function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) {
    $value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single );
    if ( ! is_null( $value ) ) {
        return $value;
    }

    return get_metadata_default( $meta_type, $object_id, $meta_key, $single );
}

Fonctions utilisées par get_metadata()

get_metadata_raw()

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

get_metadata_default()

Retourne la valeur de la méta-donnée par défaut pour une clé de méta et un id d'objet spécifiés.

Où trouver la fonction get_metadata() dans le CMS Wordpress

Sources

Codex Wordpress : get_metadata()

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

Retour