delete_post_thumbnail( int|WP_Post $post ): bool

Parameters

$postint|WP_Post

Post ID or post object from which the thumbnail should be removed.

Return

bool

True on success, false on failure.

Uses · 2

• get_post()Retrieves post data given a post ID or post object.
• delete_post_meta()Deletes a post meta field for the given post ID.

Used by · 5

• WP_REST_Posts_Controller::handle_featured_media()Determines the featured media based on a request param.
• wp_ajax_set_post_thumbnail()Handles setting the featured image via AJAX.
• wp_insert_post()Inserts or updates a post in the database.
• wp_xmlrpc_server::_insert_post()Helper method for wp_newPost() and wp_editPost(), containing shared logic.
• wp_xmlrpc_server::mw_editPost()Edits a post.

Source

View on Trac ↗View on GitHub ↗

8135function delete_post_thumbnail( $post ) {8136	$post = get_post( $post );8137	if ( $post ) {8138		return delete_post_meta( $post->ID, '_thumbnail_id' );8139	}8140	return false;8141}

History

Introduced in 3.3.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 7.0.4 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.