W3cubDocs

/WordPress

get_post_thumbnail_id( int|WP_Post $post = null )

Retrieve post thumbnail ID.

Parameters

$post

(int|WP_Post) (Optional) Post ID or WP_Post object. Default is global $post.

Default value: 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

File: wp-includes/post-thumbnail-template.php

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

	if ( ! $post ) {
		return false;
	}

	return (int) get_post_meta( $post->ID, '_thumbnail_id', true );
}

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.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_post_thumbnail_id