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.

$meta_key

(string) (Requis) Clé de la méta-donnée.

$meta_value

(mixed) (Optionnel) Valeur de la méta-donnée. Doit être sérializable si non scalaire. Si spécifiée, supprime seulement les champs de la méta-donnée qui correspondent à cette valeur. Sinon supprime tous les champs $meta_key. Passer null, false ou '' pour garder cette vérification active. Pour une raison de compatibilité il est impossible de passer '' pour supprimer une méta-donnée valant ''.

Valeur par défaut : ''

$delete_all

(bool) (Optionnel) Si true, supprime toutes les méta-données nommées par $meta_key pour tous les objets, ignorant ainsi $object_id.

Valeur par défaut : false

Retourne

(bool) True si succès, false autrement.

Structure de la fonction delete_metadata()

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

function delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false ) {
    global $wpdb;

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

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

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

    $type_column = sanitize_key( $meta_type . '_id' );
    $id_column   = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id';

    // expected_slashed ($meta_key)
    $meta_key   = wp_unslash( $meta_key );
    $meta_value = wp_unslash( $meta_value );

    /**
     * Short-circuits deleting 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 $delete     Whether to allow metadata deletion of 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      $delete_all Whether to delete the matching metadata entries
     *                              for all objects, ignoring the specified $object_id.
     *                              Default false.
     */
    $check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );
    if ( null !== $check ) {
        return (bool) $check;
    }

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

    $query = $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s", $meta_key );

    if ( ! $delete_all ) {
        $query .= $wpdb->prepare( " AND $type_column = %d", $object_id );
    }

    if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value ) {
        $query .= $wpdb->prepare( ' AND meta_value = %s', $meta_value );
    }

    $meta_ids = $wpdb->get_col( $query );
    if ( ! count( $meta_ids ) ) {
        return false;
    }

    if ( $delete_all ) {
        if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value ) {
            $object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $type_column FROM $table WHERE meta_key = %s AND meta_value = %s", $meta_key, $meta_value ) );
        } else {
            $object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $type_column FROM $table WHERE meta_key = %s", $meta_key ) );
        }
    }

    /**
     * Fires immediately before deleting 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).
     *
     * @since 3.1.0
     *
     * @param string[] $meta_ids    An array of metadata entry IDs to delete.
     * @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( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );

    // Old-style action.
    if ( 'post' === $meta_type ) {
        /**
         * Fires immediately before deleting metadata for a post.
         *
         * @since 2.9.0
         *
         * @param string[] $meta_ids An array of metadata entry IDs to delete.
         */
        do_action( 'delete_postmeta', $meta_ids );
    }

    $query = "DELETE FROM $table WHERE $id_column IN( " . implode( ',', $meta_ids ) . ' )';

    $count = $wpdb->query( $query );

    if ( ! $count ) {
        return false;
    }

    if ( $delete_all ) {
        foreach ( (array) $object_ids as $o_id ) {
            wp_cache_delete( $o_id, $meta_type . '_meta' );
        }
    } else {
        wp_cache_delete( $object_id, $meta_type . '_meta' );
    }

    /**
     * Fires immediately after deleting 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).
     *
     * @since 2.9.0
     *
     * @param string[] $meta_ids    An array of metadata entry IDs to delete.
     * @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( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );

    // Old-style action.
    if ( 'post' === $meta_type ) {
        /**
         * Fires immediately after deleting metadata for a post.
         *
         * @since 2.9.0
         *
         * @param string[] $meta_ids An array of metadata entry IDs to delete.
         */
        do_action( 'deleted_postmeta', $meta_ids );
    }

    return true;
}

Fonctions et Hooks utilisés par delete_metadata()

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

delete_{$meta_type}_metadata

Court-circuite une méta-donnée de type spécifique à supprimer.

delete_{$meta_type}_meta

Se lance immédiatement avant une méta-donnée de type spécifique à supprimer.

delete_postmeta

Se lance immédiatement avant une méta-donnée de type poste à supprimer.

deleted_{$meta_type}_meta

Se lance immédiatement après qu'une méta-donnée de type spécifique soit supprimée.

deleted_postmeta

Se lance immédiatement après qu'une méta-donnée de type poste soit supprimée.

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

Exemple

Supprimer toutes les méta-données d'un type de poste personnalisé :
$meta_type  = 'post';
$object_id  = 0; 
$meta_key   = 'my_meta_key';
$meta_value = '';
$delete_all = true;

delete_metadata( $meta_type, $object_id, $meta_key, $meta_value, $delete_all );

Sources

Codex Wordpress : delete_metadata()

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

Retour