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

Description

Parameters

$post_idint

Post ID.

$meta_keystring

Metadata name.

$meta_valuemixedoptional

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

Return

bool

True on success, false on failure.

Uses · 2

• wp_is_post_revision()Determines if the specified post is a revision.
• delete_metadata()Deletes metadata for the specified object.

Used by · 27

• Custom_Image_Header::ajax_header_remove()Given an attachment ID for a header image, unsets it as a user-uploaded header image for the active theme.
• WP_Customize_Manager::handle_dismiss_autosave_or_lock_request()Deletes a given auto-draft changeset or the autosave revision for a given changeset or delete changeset lock.
• WP_Customize_Nav_Menus::save_nav_menus_created_posts()Publishes the auto-draft posts that were created for nav menu items.
• WP_Embed::delete_oembed_caches()Deletes all oEmbed caches. Unused by core as of 4.0.0.
• WP_Privacy_Policy_Content::_policy_page_updated()Updates the cached policy info when the policy page is updated.
• WP_Privacy_Policy_Content::get_suggested_policy_text()Checks for updated, added or removed privacy policy information from plugins.
• _wp_delete_customize_changeset_dependent_auto_drafts()Deletes auto-draft posts associated with the supplied changeset.
• delete_post_thumbnail()Removes the thumbnail (featured image) from the given post.
• do_all_enclosures()Performs all enclosures.
• do_all_pingbacks()Performs all pingbacks.
• do_all_trackbacks()Performs all trackbacks.
• set_post_thumbnail()Sets the post thumbnail (featured image) for the given post.

Source

View on Trac ↗View on GitHub ↗

2632function delete_post_meta( $post_id, $meta_key, $meta_value = '' ) {2633	// Make sure meta is deleted from the post, not from a revision.2634	$the_post = wp_is_post_revision( $post_id );2635	if ( $the_post ) {2636		$post_id = $the_post;2637	}2638 2639	return delete_metadata( 'post', $post_id, $meta_key, $meta_value );2640}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.