is_sticky( int $post_id )

Determines whether a post is sticky.

Description 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 Parameters


(int) (Optional) Post ID. Default is ID of the global $post.

Top ↑

Return Return

(bool) Whether post is sticky.

Top ↑

Source 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' );

	$is_sticky = is_array( $stickies ) && in_array( $post_id, $stickies );

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

Top ↑

Changelog Changelog

Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.