set_post_thumbnail( int|WP_Post $post, int $thumbnail_id )

Set a post thumbnail.

Parameters

$post

(Required) Post ID or post object where thumbnail should be attached.

$thumbnail_id

(Required) Thumbnail to attach.

Return

(int|bool) True on success, false on failure.

Source

File: wp-includes/post.php 

function set_post_thumbnail( $post, $thumbnail_id ) {
	$post = get_post( $post );
	$thumbnail_id = absint( $thumbnail_id );
	if ( $post && $thumbnail_id && get_post( $thumbnail_id ) ) {
		if ( wp_get_attachment_image( $thumbnail_id, 'thumbnail' ) )
			return update_post_meta( $post->ID, '_thumbnail_id', $thumbnail_id );
		else
			return delete_post_meta( $post->ID, '_thumbnail_id' );
	}
	return false;
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/media.php: wp_get_attachment_image()

Get an HTML img element representing an image attachment
wp-includes/post.php: update_post_meta()

Update post meta field based on post ID.
wp-includes/post.php: delete_post_meta()

Remove metadata matching criteria from a post.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/functions.php: absint()

Convert a value to non-negative integer.

Used By

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

Determines the featured media based on a request param.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_newPost()

Create a new post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_editPost()

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

Helper method for wp_newPost() and wp_editPost(), containing shared logic.
wp-includes/post.php: wp_insert_post()

Insert or update a post.
wp-admin/includes/ajax-actions.php: wp_ajax_set_attachment_thumbnail()

Ajax handler for setting the featured image for an attachment.
wp-admin/includes/ajax-actions.php: wp_ajax_set_post_thumbnail()

Ajax handler for setting the featured image.
Show 2 more used by Hide more used by

Changelog

Changelog
Version Description
WP-3.1.0 Introduced.