delete_post_meta() WP 1.0

Remove metadata matching criteria from a post.

You can match based on the key, or key and value. Removing based on key and value, will keep from removing duplicate metadata with the same key. It also allows removing all metadata matching key, if needed.

No Hooks.

Return

true/false. True on success, false on failure.

Usage

delete_post_meta( $post_id, $meta_key, $meta_value );

$post_id(int) (required)

Post ID.

$meta_key(string) (required)

Metadata name.

$meta_value(mixed)

Metadata value. Must be serializable if non-scalar.
Default: ''

Code of delete_post_meta: wp-includes/post.php ^{VER 4.9.8}

<?php
function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) {
	// Make sure meta is added to the post, not a revision.
	if ( $the_post = wp_is_post_revision($post_id) )
		$post_id = $the_post;

	$deleted = delete_metadata( 'post', $post_id, $meta_key, $meta_value );
	if ( $deleted ) {
		wp_cache_set( 'last_changed', microtime(), 'posts' );
	}
	return $deleted;
}

Related Functions

From tag: Metadatas (any)