twentyseventeen_should_show_featured_image(): bool
- Since
- Twenty Seventeen 3.7
- Source
wp-content/themes/twentyseventeen/functions.php:717
Description
Uses the filter twentyseventeen_should_show_featured_image in a child theme or plugin to change when the image is shown. This example prevents the image from showing:
add_filter(
'twentyseventeen_should_show_featured_image',
'__return_false'
);Compatibility
- WordPress
- since Twenty Seventeen 3.7
- 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.
Return value
bool- Whether the post thumbnail should be shown.
Performance profile
How much work a call to twentyseventeen_should_show_featured_image() 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
- Trivial
- Scaling
- Constant
- Instructions
- 12–22
- Plugin surface
- 1 hook
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 22.
Third-party callbacks on 'twentyseventeen_should_show_featured_image' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach query, 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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost twentyseventeen_should_show_featured_image() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_single() && !is_page() | 12 | is_single(), is_page(), apply_filters() |
is_single() | 15 | is_single(), get_queried_object_id(), has_post_thumbnail(), apply_filters() |
!is_single() && is_page() && $value | 16 | is_single(), is_page(), twentyseventeen_is_frontpage(), apply_filters() |
!is_single() && is_page() && !$value | 22 | is_single(), is_page(), twentyseventeen_is_frontpage(), get_queried_object_id(), has_post_thumbnail(), 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: 22 instructions, 12–22 executed per call, 3 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 twentyseventeen_should_show_featured_image() runs, in this order:
- apply_filters( twentyseventeen_should_show_featured_image )filterline 729 (+12 into the body)
Filters whether to show the Twenty Seventeen featured image below the header.
Uses · 6
- is_single()Determines whether the query is for an existing single post.
- is_page()Determines whether the query is for an existing single page.
- twentyseventeen_is_frontpage()Checks to see if we are on the front page or not.
- has_post_thumbnail()Determines whether a post has an image attached.
- get_queried_object_id()Retrieves the ID of the currently queried object.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Source code
function twentyseventeen_should_show_featured_image() { $show_featured_image = ( is_single() || ( is_page() && ! twentyseventeen_is_frontpage() ) ) && has_post_thumbnail( get_queried_object_id() ); /** * Filters whether to show the Twenty Seventeen featured image below the header. * * By default, the image is displayed on single posts and pages, unless the page is the front page. * * @since Twenty Seventeen 3.7 * * @param bool $show_featured_image Whether to display the featured image below the header. */ return apply_filters( 'twentyseventeen_should_show_featured_image', $show_featured_image );}Changelog
Introduced in Twenty Seventeen 3.7. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-content/themes/twentyseventeen/functions.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.