delete_post_meta() WordPress Function

The delete_post_meta() function allows you to delete a post meta field from a given post. You can specify the post ID and the meta key, and the function will delete the corresponding post meta field. This is useful for clean up when you no longer need a certain piece of post meta data.

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

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.


Top ↑

Parameters

$post_id

(int)(Required)Post ID.

$meta_key

(string)(Required)Metadata name.

$meta_value

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

Default value: ''


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

Source

File: wp-includes/post.php

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


Top ↑

Changelog

Changelog
VersionDescription
1.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More