Deletes a post meta field for the given post ID.

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 the key, if needed.

Parameters

$post_idintrequired

Post ID.

$meta_keystringrequired

Metadata name.

$meta_valuemixedoptional

Metadata value. If provided, rows will only be removed that match the value.
Must be serializable if non-scalar.

Default:''

Return

Source

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 );
}

View all references View on Trac View on GitHub

Changelog