get_metadata_default( string $meta_type, int $object_id, string $meta_key = '', bool $single = false )
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.
Description
Par défaut, si le champ de méta n'est pas trouvé pour une clé et un objet donnés :
- 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 la méta-donnée est retournée. Accepte 'post', 'comment', 'term', 'user' ou tout autre type d'objet associé à une table meta.
$object_id
(int) (Requis) Id de l'objet pour lequel la méta-donnée est retournée.
$meta_key
(string) (Optionnel) Clé de la méta-donnée.
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) Retourne une valeur unique ou un tableau de valeurs.
Structure de la fonction get_metadata_default()
Définie dans le fichier wp-includes/meta.php à la ligne 615 :
function get_metadata_default( $meta_type, $object_id, $meta_key, $single = false ) {
if ( $single ) {
$value = '';
} else {
$value = array();
}
/**
* Filters the default metadata value for a specified meta key and object.
*
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type
* (post, comment, term, user, or any other type with an associated meta table).
*
* Possible filter names include:
*
* - `default_post_metadata`
* - `default_comment_metadata`
* - `default_term_metadata`
* - `default_user_metadata`
*
* @since 5.5.0
*
* @param mixed $value The value to return, either a single metadata value or an array
* of values depending on the value of `$single`.
* @param int $object_id ID of the object metadata is for.
* @param string $meta_key Metadata key.
* @param bool $single Whether to return only the first value of the specified `$meta_key`.
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
* or any other object type with an associated meta table.
*/
$value = apply_filters( "default_{$meta_type}_metadata", $value, $object_id, $meta_key, $single, $meta_type );
if ( ! $single && ! wp_is_numeric_array( $value ) ) {
$value = array( $value );
}
return $value;
}
Fonctions et Hook utilisés par get_metadata_default()
default_{$meta_type}_metadata
Filtre la valeur de la méta-donnée par défaut pour une clé de méta et un objet spécifiés.
wp_is_numeric_array()
Détermine si la variable est un tableau numérique.
apply_filters()
Appel les fonctions qui ont été attaché à un filtre (hook).
Où trouver la fonction get_metadata_default()
dans le CMS Wordpress
Sources
Codex Wordpress : get_metadata_default()
Autres fonctions dans le même fichier : wp-includes/meta.php