update_term_meta( int $term_id, string $meta_key, mixed $meta_value, mixed $prev_value = '' )

Met à jour la méta-donnée d'un terme.

Paramètres

$term_id(int)requis

Id du terme.

$meta_key(string)requis

Clé de la méta-donnée.

$meta_value(mixed)requis

Valeur de la méta-donnée. Doit être sérializable si non scalaire.

$prev_value(mixed)optionnel

Valeur précédente à vérifier avant la mise à jour. Si spécifiée, seulement l'entrée de la méta-donnée avec cette valeur sera mise à jour. Autrement, elle mettra à jour toutes les entrées.

Valeur par défaut : ''

Description / Informations supplémentaires

Utiliser le paramètre $prev_value pour faire la différence entre les méta-données qui ont la même clé et le même id de terme.

Si la méta-donnée n'existe pas, elle sera ajoutée.

Retourne

(int|bool|WP_Error) Id de la méta-donnée si elle n'existait pas. True si succès, false si échec ou si la valeur passée à la fonction est la même que celle en base de donnée. WP_Error quand term_id est ambigu entre plusieurs taxonomies.

Déclaration et structure de la fonction update_term_meta()

function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
    if ( wp_term_is_shared( $term_id ) ) {
        return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.' ), $term_id );
    }

    return update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );
}
wp_term_is_shared()

Détermine si un terme est partagé entre plusieurs taxonomies.

__()

Retourne la traduction d'un texte.

update_metadata()

Met à jour la méta-donnée d'un objet donné. Si la méta-donnée n'existe pas pour cet objet, elle sera ajoutée.

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

Sources

Codex WordPress : update_term_meta()

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

Retour