delete_post_meta( int $post_id, string $meta_key, mixed $meta_value = ” )
Deletes a post meta field for the given post ID.
Description 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 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: ”
Return Return
(bool) True on success, false on failure.
Source Source
File: wp-includes/post.php
|
2101 2102 2103 2104 2105 2106 2107 2108 2109 |
function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) { // Make sure meta is added to the post, not 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 Trac
Changelog Changelog
| Version | Description |
|---|---|
| 1.5.0 | Introduced. |