A WordPress-centric search engine for devs and theme authors



delete_post_meta ›

Since1.5.0
Deprecatedn/a
delete_post_meta ( $post_id, $meta_key, $meta_value = '' )
Parameters: (3)
  • (int) $post_id Post ID.
    Required: Yes
  • (string) $meta_key Metadata name.
    Required: Yes
  • (mixed) $meta_value Optional. Metadata value. Must be serializable if non-scalar. Default empty.
    Required: No
    Default: (empty)
Returns:
  • (bool) True on success, false on failure.
Defined at:
Codex:

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.



Source

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