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

Remove metadata matching criteria from a post.


Description

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.


Parameters

$post_id

(int) (Required) Post ID.

$meta_key

(string) (Required) Metadata name.

$meta_value

(mixed) (Optional) Metadata value. Must be serializable if non-scalar.

Default value: ''


Return

(bool) True on success, false on failure.


Source

File: wp-includes/post.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;
}


Changelog

Changelog
Version Description
WP-1.5.0 Introduced.