delete_post_meta( int $post_id, string $meta_key, mixed $meta_value = '' )

Supprime un champ de méta-donnée de poste pour un id de poste donné.

Paramètres

$post_id(int)requis

Id du poste.

$meta_key(string)requis

Nom de la méta-donnée.

$meta_value(mixed)optionnel

Valeur de la méta-donnée. Si fournie, supprimera seulement la méta-donnée correspondant à cette valeur.

Valeur par défaut : ''

Retourne

(bool) True si succès. False si échec.

Déclaration et structure de la fonction delete_post_meta()

function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) {
    // Make sure meta is deleted from the post, not from a revision.
    $the_post = wp_is_post_revision( $post_id );
    if ( $the_post ) {
        $post_id = $the_post;
    }

    return delete_metadata( 'post', $post_id, $meta_key, $meta_value );
}
wp_is_post_revision()

Détermine si un poste spécifié est une révision.

delete_metadata()

Supprime une méta-donnée pour un type d'objet spécifié.

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

Exemples

delete_post_meta(76, 'my_key', 'Steve');
Pour supprimer toutes les clés du même nom :
delete_post_meta_by_key( 'related_posts' );

Sources

Codex WordPress : delete_post_meta()

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

Retour