Featured_Content::pre_get_posts( WP_Query $query ): void
- Since
- Twenty Fourteen 1.0
- Source
wp-content/themes/twentyfourteen/inc/featured-content.php:217
Description
Filters the home page posts, and removes any featured post ID's from it.
Hooked onto the 'pre_get_posts' action, this changes the parameters of the query before it gets any posts.
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.
Parameters
$queryWP_Query- WP_Query object.
Return value
void
Performance profile
How much work a call to Featured_Content::pre_get_posts() 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
- Moderate
- Scaling
- Constant
- Instructions
- 5–37
- Plugin surface
- None
- Called by
- 0
Reads stored settings via get_option(), cached per request but not free on a cold cache.
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 40.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()one call below Featured_Content::pre_get_posts() - cacheobject cache
wp_cache_get()one call below Featured_Content::pre_get_posts() - serializeserialisation
maybe_unserialize()one call below Featured_Content::pre_get_posts()
Further down the call graph this can also reach query 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 · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost Featured_Content::pre_get_posts() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!->is_home() | 5 | ->is_home() |
->is_home() && !->is_main_query() | 8 | ->is_home(), ->is_main_query() |
->is_home() && ->is_main_query() | 13 | ->is_home(), ->is_main_query(), get_option() |
->is_home() && ->is_main_query() | 17 | ->is_home(), ->is_main_query(), get_option(), ::get_featured_post_ids() |
->is_home() && ->is_main_query() && empty($post__not_in) | 27 | ->is_home(), ->is_main_query(), get_option(), ::get_featured_post_ids(), ->get(), ->set() |
->is_home() && ->is_main_query() && !empty($post__not_in) | 37 | ->is_home(), ->is_main_query(), get_option(), ::get_featured_post_ids(), ->get(), array_merge(), array_unique(), ->set() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 40 instructions, 5–37 executed per call, 5 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 · 2
- get_option()Retrieves an option value based on an option name.
- Featured_Content::get_featured_post_ids()Gets featured post IDs.
Source code
public static function pre_get_posts( $query ) { // Bail if not home or not main query. if ( ! $query->is_home() || ! $query->is_main_query() ) { return; } // Bail if the blog page is not the front page. if ( 'posts' !== get_option( 'show_on_front' ) ) { return; } $featured = self::get_featured_post_ids(); // Bail if no featured posts. if ( ! $featured ) { return; } // We need to respect post IDs already in the exclude list. $post__not_in = $query->get( 'post__not_in' ); if ( ! empty( $post__not_in ) ) { $featured = array_merge( (array) $post__not_in, $featured ); $featured = array_unique( $featured ); } $query->set( 'post__not_in', $featured ); }Changelog
Introduced in Twenty Fourteen 1.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
WP_Query to void.verified against sourceAbout 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.