wpseek.com
A WordPress-centric search engine for devs and theme authors



is_sticky › WordPress Function

Since2.7.0
Deprecatedn/a
› is_sticky ( $post_id = 0 )
Parameters:
  • (int) $post_id Optional. Post ID. Default is the ID of the global `$post`.
    Required: No
    Default: —
Returns:
  • (bool) Whether post is sticky.
Defined at:
Codex:

Determines whether a post is sticky.

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 {@link Conditional Tags} article in the Theme Developer Handbook.


Related Functions: is_time, sticky_class, is_trackback, is_search, is_single

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