get_post_thumbnail_id() – Function | Developer.WordPress.org

Retrieves the post thumbnail ID.

Parameters

$postint|WP_Postoptional: Post ID or WP_Post object. Default is global $post.
Default:null

Return

int|false Post thumbnail ID (which can be 0 if the thumbnail is not set), or false if the post does not exist.

More Information

To enable featured images, see post thumbnails, the current theme must include add_theme_support( 'post-thumbnails' ); in its functions.php file. See also Post Thumbnails.
“Post Thumbnail” is an outdated term for “Featured Image”. This function returns the ID of the post’s featured image. It does not return IDs of other images attached to posts that are thumbnail sized.

Source

function get_post_thumbnail_id( $post = null ) {
	$post = get_post( $post );

	if ( ! $post ) {
		return false;
	}

	$thumbnail_id = (int) get_post_meta( $post->ID, '_thumbnail_id', true );

	/**
	 * Filters the post thumbnail ID.
	 *
	 * @since 5.9.0
	 *
	 * @param int|false        $thumbnail_id Post thumbnail ID or false if the post does not exist.
	 * @param int|WP_Post|null $post         Post ID or WP_Post object. Default is global `$post`.
	 */
	return (int) apply_filters( 'post_thumbnail_id', $thumbnail_id, $post );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘post_thumbnail_id’, int|false $thumbnail_id, int|WP_Post|null $post ): Filters the post thumbnail ID.

Uses	Description
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post_meta()`wp-includes/post.php`	Retrieves 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.

Show 1 more Show less

Used by	Description
WP_REST_Posts_Controller::prepare_links()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Prepares links for the request.
WP_REST_Posts_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Prepares a single post output for response.
get_the_post_thumbnail_caption()`wp-includes/post-thumbnail-template.php`	Returns the post thumbnail caption.
get_oembed_response_data_rich()`wp-includes/embed.php`	Filters the oEmbed response data to return an iframe embed code.
get_the_post_thumbnail_url()`wp-includes/post-thumbnail-template.php`	Returns the post thumbnail URL.
WP_Media_List_Table::column_title()`wp-admin/includes/class-wp-media-list-table.php`	Handles the title column output.
edit_form_image_editor()`wp-admin/includes/media.php`	Displays the image and editor in the post editor
get_media_item()`wp-admin/includes/media.php`	Retrieves HTML form for modifying the image attachment.
has_post_thumbnail()`wp-includes/post-thumbnail-template.php`	Determines whether a post has an image attached.
update_post_thumbnail_cache()`wp-includes/post-thumbnail-template.php`	Updates cache for thumbnails in the current loop.
get_the_post_thumbnail()`wp-includes/post-thumbnail-template.php`	Retrieves the post thumbnail.
prepend_attachment()`wp-includes/post-template.php`	Wraps attachment in paragraph tag before content.
wp_xmlrpc_server::mw_getPost()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves a post.
wp_xmlrpc_server::mw_getRecentPosts()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves list of recent posts.
wp_xmlrpc_server::_prepare_post()`wp-includes/class-wp-xmlrpc-server.php`	Prepares post data for return in an XML-RPC object.

Show 10 more Show less

Changelog

Version	Description
5.5.0	The return value for a non-existing post was changed to false instead of an empty string.
4.4.0	`$post` can be a post ID or WP_Post object.
2.9.0	Introduced.

User Contributed Notes

Skip to note 5 content

crstauf 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

Note that the return value is typically a string, not an integer (have not yet seen the function return an integer).

Log in to add feedback
Skip to note 6 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Show all attachments for the current post except the Featured Image
To get all post attachments except the Featured Image, you can use this function with something like get_posts().

Do this inside The_Loop (where $post->ID is available).
$args = array( 'post_type' => 'attachment', 'numberposts' => -1, 'post_status' => 'any', 'post_parent' => $post->ID, 'exclude' => get_post_thumbnail_id(), ); $attachments = get_posts( $args ); if ( $attachments ) { foreach ( $attachments as $attachment ) { echo apply_filters( 'the_title', $attachment->post_title ); the_attachment_link( $attachment->ID, false ); } }
Log in to add feedback
Skip to note 7 content

Hay 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
To set the post thumbnail, use set_post_thumbnail:
```
set_post_thumbnail( $post_id, $thumbnail_id );
```
Log in to add feedback
Skip to note 8 content

frankerinage 2 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
If you would like to retrieve the post thumbnail id outside of WP_Query Object and can’t get it by the get_post_thumbnail_id() function, you could use the below code.
```
$post_thumbnail_id = get_post_meta( $post->ID, '_thumbnail_id', true );
```
Log in to add feedback

get_post_thumbnail_id( int|WP_Post $post = null ): int|false

In this article

Parameters

Return

More Information

Source

Hooks

Changelog

User Contributed Notes