is_sticky( int $post_id = 0 ): bool
- Since
- 2.7.0
- Source
wp-includes/post.php:2875
Description
Sticky posts should remain at the top of The Loop. If the post ID is not given, then The Loop ID for the current post will be used.
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 2.7.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
$post_idintoptional- Post ID. Default is the ID of the global
$post.Default:0
Return value
bool- Whether post is sticky.
Performance profile
How much work a call to is_sticky() 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
- 19–29
- 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, depending on the branch taken. The body compiles to 30.
Third-party callbacks on 'is_sticky' 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
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below is_sticky() - cacheobject cache
wp_cache_get()one call below is_sticky() - serializeserialisation
maybe_unserialize()one call below is_sticky()
Further down the call graph this can also reach transient. That is 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 is_sticky() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_array($stickies) | 19 | absint(), get_option(), apply_filters() |
!is_array($stickies) | 22 | absint(), get_the_ID(), get_option(), apply_filters() |
is_array($stickies) | 26 | absint(), get_option(), array_map(), apply_filters() |
is_array($stickies) | 29 | absint(), get_the_ID(), get_option(), array_map(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 30 | 19–29 | 2 | |
| 8.5 | 30 | 19–29 | 2 | |
| 8.4 | 30 | 19–29 | 2 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 33 | 19–32 | 2 | |
| 8.2 | 33 | 19–32 | 2 | |
| 8.1 | 33 | 19–32 | 2 | |
| 7.4 | 33 | 19–32 | 2 |
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 is_sticky() runs, in this order:
Uses · 4
- absint()Converts a value to non-negative integer.
- get_the_ID()Retrieves the ID of the current item in the WordPress Loop.
- get_option()Retrieves an option value based on an option name.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 16
- WP_REST_Posts_Controller::prepare_item_for_database()Prepares a single post for create or update.
- WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
- export_wp()Generates the WXR export file for download.
- get_inline_data()Adds hidden fields with the data for use in the inline editor for posts and pages.
- get_post_class()Retrieves an array of the class names for the post container element.
- get_post_states()Retrieves an array of post states from a post.
- post_submit_meta_box()Displays post submit form fields.
- sticky_class()Display "sticky" CSS class, if a post is sticky.
- twenty_twenty_one_entry_meta_footer()Prints HTML with meta information for the categories, tags and comments.
- twentyfifteen_entry_meta()Prints HTML with meta information for the categories, tags.
- twentyfourteen_posted_on()Prints HTML with meta information for the current post-date/time and author.
- twentythirteen_entry_meta()Prints HTML with meta information for current post: categories, tags, permalink, author, and date.
Show all 16
- twentytwenty_get_post_meta()Retrieves the post meta.
- wp_xmlrpc_server::_prepare_post()Prepares post data for return in an XML-RPC object.
- wp_xmlrpc_server::mw_getPost()Retrieves a post.
- wp_xmlrpc_server::mw_getRecentPosts()Retrieves list of recent posts.
Source code
function is_sticky( $post_id = 0 ) { $post_id = absint( $post_id ); if ( ! $post_id ) { $post_id = get_the_ID(); } $stickies = get_option( 'sticky_posts' ); if ( is_array( $stickies ) ) { $stickies = array_map( 'intval', $stickies ); $is_sticky = in_array( $post_id, $stickies, true ); } else { $is_sticky = false; } /** * Filters whether a post is sticky. * * @since 5.3.0 * * @param bool $is_sticky Whether a post is sticky. * @param int $post_id Post ID. */ return apply_filters( 'is_sticky', $is_sticky, $post_id );}Changelog
Introduced in 2.7.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.0.4 tag, from
src/wp-includes/post.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.