is_sticky() – Function | Developer.WordPress.org

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_idintoptional: Post ID. Default is the ID of the global $post.

Return

bool Whether post is sticky.

Source

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 );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘is_sticky’, bool $is_sticky, int $post_id ): Filters whether a post is sticky.

Uses	Description
get_the_ID()`wp-includes/post-template.php`	Retrieves the ID of the current item in the WordPress Loop.
absint()`wp-includes/load.php`	Converts a value to non-negative integer.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.

Show 2 more Show less

Used by	Description
get_post_states()`wp-admin/includes/template.php`	Retrieves an array of post states from a post.
WP_REST_Posts_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Prepares a single post output for response.
WP_REST_Posts_Controller::prepare_item_for_database()`wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php`	Prepares a single post for create or update.
get_inline_data()`wp-admin/includes/template.php`	Adds hidden fields with the data for use in the inline editor for posts and pages.
post_submit_meta_box()`wp-admin/includes/meta-boxes.php`	Displays post submit form fields.
sticky_class()`wp-includes/deprecated.php`	Display “sticky” CSS class, if a post is sticky.
get_post_class()`wp-includes/post-template.php`	Retrieves an array of the class names for the post container element.
wp_xmlrpc_server::mw_getPost()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves a post.
wp_xmlrpc_server::mw_getRecentPosts()`wp-includes/class-wp-xmlrpc-server.php`	Retrieves list of recent posts.
wp_xmlrpc_server::_prepare_post()`wp-includes/class-wp-xmlrpc-server.php`	Prepares post data for return in an XML-RPC object.

Show 5 more Show less

Changelog

Version	Description
2.7.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Basic Example
```
is_sticky();
// When any Sticky Post page is being displayed.

is_sticky('17');
// When Sticky Post 17 (ID) is being displayed.
```
Log in to add feedback

is_sticky( int $post_id ): bool

In this article