Featured_Content::get_featured_post_ids(): array
- Since
- Twenty Fourteen 1.0
- Source
wp-content/themes/twentyfourteen/inc/featured-content.php:143
Description
This function will return the an array containing the post IDs of all featured posts.
Sets the "featured_content_ids" transient.
Compatibility
- WordPress
- since Twenty Fourteen 1.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.
Return value
array- Array of post IDs.
Performance profile
How much work a call to Featured_Content::get_featured_post_ids() 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
- 11–45
- Plugin surface
- None
- Called by
- 2
Reaches the database via get_posts().
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 45.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- transienttransient
get_transient()called directly - querycontent query
get_posts()called directly - hookthird-party callbacks
apply_filters()one call below Featured_Content::get_featured_post_ids() - cacheobject cache
wp_cache_get()one call below Featured_Content::get_featured_post_ids() - optionoption read or write
get_option()one call below Featured_Content::get_featured_post_ids()
Further down the call graph this can also reach serialize. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost Featured_Content::get_featured_post_ids() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$featured_ids !== false | 11 | get_transient(), array_map() |
$featured_ids === false | 28–42 | get_transient(), ::get_setting(), get_term_by(), set_transient(), array_map() |
$featured_ids === false | 31–45 | get_transient(), ::get_setting(), get_term_by(), ::get_sticky_posts(), set_transient(), array_map() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 45 instructions, 11–45 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.
Uses · 6
- get_transient()Retrieves the value of a transient.
- get_term_by()Gets all term data from database by term field and data.
- get_posts()Retrieves an array of the latest posts, or posts matching the given criteria.
- set_transient()Sets/updates the value of a transient.
- Featured_Content::get_setting()Gets featured content settings.
- Featured_Content::get_sticky_posts()Returns an array with IDs of posts marked as sticky.
Used by · 2
- Featured_Content::get_featured_posts()Gets featured posts.
- Featured_Content::pre_get_posts()Excludes featured posts from the home page blog query.
Source code
public static function get_featured_post_ids() { // Get array of cached results if they exist. $featured_ids = get_transient( 'featured_content_ids' ); if ( false === $featured_ids ) { $settings = self::get_setting(); $term = get_term_by( 'name', $settings['tag-name'], 'post_tag' ); if ( $term ) { // Query for featured posts. $featured_ids = get_posts( array( 'fields' => 'ids', 'numberposts' => self::$max_posts, 'suppress_filters' => false, 'tax_query' => array( array( 'field' => 'term_id', 'taxonomy' => 'post_tag', 'terms' => $term->term_id, ), ), ) ); } // Get sticky posts if no Featured Content exists. if ( ! $featured_ids ) { $featured_ids = self::get_sticky_posts(); } set_transient( 'featured_content_ids', $featured_ids ); } // Ensure correct format before return. return array_map( 'absint', $featured_ids ); }Changelog
Introduced in Twenty Fourteen 1.0. 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/twentyfourteen/inc/featured-content.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.