add_metadata() | Fonctions Wordpress

Paramètres

$meta_type

(string) (Requis) Type d'objet. 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 pour lequel la méta-donnée est liée.

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

$unique

(bool) (Optionnel) Réglé à true pour que la clé de la méta-donnée ajouté soit unique pour le type d'objet. Si réglé à true et que la méta-donnée a déjà une valeur pour l'objet, aucun changement ne sera fait.

Valeur par défaut : false

Retourne

(int | false) L'id de la méta-donnée si succès, false sinon.

Structure de la fonction `add_metadata()`

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

function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = false ) {
    global $wpdb;

    if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) ) {
        return false;
    }

    $object_id = absint( $object_id );
    if ( ! $object_id ) {
        return false;
    }

    $table = _get_meta_table( $meta_type );
    if ( ! $table ) {
        return false;
    }

    $meta_subtype = get_object_subtype( $meta_type, $object_id );

    $column = sanitize_key( $meta_type . '_id' );

    // expected_slashed ($meta_key)
    $meta_key   = wp_unslash( $meta_key );
    $meta_value = wp_unslash( $meta_value );
    $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype );

    /**
     * Short-circuits adding metadata of a specific type.
     *
     * 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).
     * Returning a non-null value will effectively short-circuit the function.
     *
     * @since 3.1.0
     *
     * @param null|bool $check      Whether to allow adding metadata for the given type.
     * @param int       $object_id  ID of the object metadata is for.
     * @param string    $meta_key   Metadata key.
     * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.
     * @param bool      $unique     Whether the specified meta key should be unique for the object.
     */
    $check = apply_filters( "add_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $unique );
    if ( null !== $check ) {
        return $check;
    }

    if ( $unique && $wpdb->get_var(
        $wpdb->prepare(
            "SELECT COUNT(*) FROM $table WHERE meta_key = %s AND $column = %d",
            $meta_key,
            $object_id
        )
    ) ) {
        return false;
    }

    $_meta_value = $meta_value;
    $meta_value  = maybe_serialize( $meta_value );

    /**
     * Fires immediately before meta of a specific type is added.
     *
     * 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).
     *
     * @since 3.1.0
     *
     * @param int    $object_id   ID of the object metadata is for.
     * @param string $meta_key    Metadata key.
     * @param mixed  $_meta_value Metadata value. Serialized if non-scalar.
     */
    do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value );

    $result = $wpdb->insert(
        $table,
        array(
            $column      => $object_id,
            'meta_key'   => $meta_key,
            'meta_value' => $meta_value,
        )
    );

    if ( ! $result ) {
        return false;
    }

    $mid = (int) $wpdb->insert_id;

    wp_cache_delete( $object_id, $meta_type . '_meta' );

    /**
     * Fires immediately after meta of a specific type is added.
     *
     * 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).
     *
     * @since 2.9.0
     *
     * @param int    $mid         The meta ID after successful update.
     * @param int    $object_id   ID of the object metadata is for.
     * @param string $meta_key    Metadata key.
     * @param mixed  $_meta_value Metadata value. Serialized if non-scalar.
     */
    do_action( "added_{$meta_type}_meta", $mid, $object_id, $meta_key, $_meta_value );

    return $mid;
}

Fonctions et Hooks utilisés par `add_metadata()`

get_object_subtype(): Retourne le sous-type d'un objet pour un type d'objet et un id d'objet donné.
wp_cache_delete(): Supprime les contenus du cache correspondant à la clé et au groupe.
wp_unslash(): Supprime les slashes d'une chaîne ou d'un tableau de chaînes.
sanitize_key(): Nettoie une clé de type chaîne.
absint(): Convertit une valeur en entier positif (valeur absolue).
maybe_serialize(): Sérialize une donnée si besoin.
apply_filters(): Appel les fonctions qui ont été attaché à un filtre (hook).
do_action(): Exécute des fonctions attachées à un hook spécifique.
_get_meta_table(): Retourne le nom d'une table de méta-donnée pour un type d'objet spécifié.
sanitize_meta(): Nettoie une valeur de méta-donnée.
add_{$meta_type}_metadata: Court-circuite la méta-donné à ajouter d'un type spécifique.
add_{$meta_type}_meta: Se lance immédiatement avant que la méta-donné d'un type spécifique soit ajoutée.
added_{$meta_type}_meta: Se lance immédiatement après que la méta-donné d'un type spécifique soit ajoutée.

Où trouver la fonction `add_metadata()` dans le CMS Wordpress

Exemple

add_metadata( 'comment', $comment_id, 'location', wp_slash( $location ) );

Sources

Codex Wordpress : add_metadata()

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

Retour