update_term_meta() | Fonctions Wordpress

Description

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.

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 : ''

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.

Structure de la fonction `update_term_meta()`

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

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 );
}

Fonctions utilisées par `update_term_meta()`

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