delete_post_meta() – Deletes a post meta field for the given post ID.

You appear to be a bot. Output may be restricted

Description

Deletes a post meta field for the given post ID.

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.

Usage

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

Parameters

$post_id
( int ) required – Post ID.
$meta_key
( string ) required – Metadata name.
$meta_value
( mixed ) optional – Optional. Metadata value. If provided, rows will only be removed that match the value. Must be serializable if non-scalar. Default empty.

Returns

bool True on success, false on failure.

Source

File name: wordpress/wp-includes/post.php


Lines:

1 to 10 of 10
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 on GitHub View on Trac