is_sticky( int $post_id )
Determines whether a post is sticky.
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 Conditional Tags article in the Theme Developer Handbook.
Parameters
- $post_id
-
(Optional) Post ID. Default is the ID of the global
$post
.
Return
(bool) Whether post is sticky.
Source
File: wp-includes/post.php
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 ) )
return false;
if ( in_array( $post_id, $stickies ) )
return true;
return false;
}
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |