is_sticky( int $post_id = 0 ): bool

Description

Parameters

$post_idintoptional

Post ID. Default is the ID of the global $post.Default: 0

Return

bool

Whether post is sticky.

Hooks fired · 1

One hook fires while is_sticky() runs, in this order:

1. 1
   apply_filters( is_sticky )filterline 2899 (+24 into the body)

   Filters whether a post is sticky.

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.

Source

View on Trac ↗View on GitHub ↗

2875function is_sticky( $post_id = 0 ) {2876	$post_id = absint( $post_id );2877 2878	if ( ! $post_id ) {2879		$post_id = get_the_ID();2880	}2881 2882	$stickies = get_option( 'sticky_posts' );2883 2884	if ( is_array( $stickies ) ) {2885		$stickies  = array_map( 'intval', $stickies );2886		$is_sticky = in_array( $post_id, $stickies, true );2887	} else {2888		$is_sticky = false;2889	}2890 2891	/**2892	 * Filters whether a post is sticky.2893	 *2894	 * @since 5.3.02895	 *2896	 * @param bool $is_sticky Whether a post is sticky.2897	 * @param int  $post_id   Post ID.2898	 */2899	return apply_filters( 'is_sticky', $is_sticky, $post_id );2900}

History

Introduced in 2.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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.