WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

delete_post_thumbnail()

delete_post_thumbnail( int|WP_Post $post ): bool

In this article

Back to top

Removes the thumbnail (featured image) from the given post.

Parameters

$postint|WP_Postrequired
Post ID or post object from which the thumbnail should be removed.

Return

bool True on success, false on failure.

Source

function delete_post_thumbnail( $post ) {
	$post = get_post( $post );
	if ( $post ) {
		return delete_post_meta( $post->ID, '_thumbnail_id' );
	}
	return false;
}

View all references View on Trac View on GitHub

UsesDescription
delete_post_meta()wp-includes/post.php

Deletes a post meta field for the given post ID.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Used byDescription
WP_REST_Posts_Controller::handle_featured_media()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Determines the featured media based on a request param.

wp_ajax_set_post_thumbnail()wp-admin/includes/ajax-actions.php

Handles setting the featured image via AJAX.

wp_insert_post()wp-includes/post.php

Inserts or update a post.

wp_xmlrpc_server::mw_editPost()wp-includes/class-wp-xmlrpc-server.php

Edits a post.

wp_xmlrpc_server::_insert_post()wp-includes/class-wp-xmlrpc-server.php

Helper method for wp_newPost() and wp_editPost(), containing shared logic.

Changelog

VersionDescription
3.3.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.