has_post_thumbnail( int|WP_Post|null $post = null ): bool
- Since
- 2.9.0, 4.4.0
- Source
wp-includes/post-thumbnail-template.php:25
Description
For more information on this and similar theme functions, check out the https://developer.wordpress.org/themes/basics/conditional-tags/ Conditional Tags article in the Theme Developer Handbook.
Compatibility
- WordPress
- since 4.4.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$postint|WP_Post|nulloptional- Post ID or WP_Post object. Default is global
$post.Default:null
Return value
bool- Whether the post has an image attached.
Performance profile
How much work a call to has_post_thumbnail() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 14
- Plugin surface
- 1 hook
- Called by
- 16
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5. The body compiles to 14.
Third-party callbacks on 'has_post_thumbnail' run inside this call, and their cost is not bounded by anything here.
16 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below has_post_thumbnail()
Further down the call graph this can also reach cache, serialize, option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost has_post_thumbnail() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 14 | get_post_thumbnail_id(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 14 instructions, 14 executed per call, 0 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Hooks and filters fired · 1
One hook fires while has_post_thumbnail() runs, in this order:
- apply_filters( has_post_thumbnail )filterline 38 (+13 into the body)
Filters whether a post has a post thumbnail.
Uses · 2
- get_post_thumbnail_id()Retrieves the post thumbnail ID.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 16
- Twenty_Fourteen_Ephemera_Widget::widget()Outputs the HTML for this widget.
- WP_Media_List_Table::column_title()Handles the title column output.
- get_oembed_response_data_rich()Filters the oEmbed response data to return an iframe embed code.
- get_post_class()Retrieves an array of the class names for the post container element.
- prepend_attachment()Wraps attachment in paragraph tag before content.
- render_block_core_latest_posts()Renders the `core/latest-posts` block on server.
- twenty_twenty_one_can_show_post_thumbnail()Determines if post thumbnail can be displayed.
- twentyfifteen_post_nav_background()Adds featured image as background image to post navigation elements.
- twentyfifteen_post_thumbnail()Displays an optional post thumbnail.
- twentyfourteen_post_classes()Extends the default WordPress post classes.
- twentyfourteen_post_thumbnail()Displays an optional post thumbnail.
- twentynineteen_can_show_post_thumbnail()Determines if post thumbnail can be displayed.
Show all 16
- twentyseventeen_should_show_featured_image()Shows the featured image below the header on single posts and pages, unless the page is the front page.
- twentysixteen_post_thumbnail()Displays an optional post thumbnail.
- twentytwelve_body_class()Extends the default WordPress body classes.
- twentytwenty_body_classes()Adds conditional body classes.
Source code
function has_post_thumbnail( $post = null ) { $thumbnail_id = get_post_thumbnail_id( $post ); $has_thumbnail = (bool) $thumbnail_id; /** * Filters whether a post has a post thumbnail. * * @since 5.1.0 * * @param bool $has_thumbnail true if the post has a post thumbnail, otherwise false. * @param int|WP_Post|null $post Post ID or WP_Post object. Default is global `$post`. * @param int|false $thumbnail_id Post thumbnail ID or false if the post does not exist. */ return (bool) apply_filters( 'has_post_thumbnail', $has_thumbnail, $post, $thumbnail_id );}Changelog
Introduced in 2.9.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post retyped from int|WP_Post to int|WP_Post|null.verified against source$post can be a post ID or WP_Post object.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/post-thumbnail-template.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.