is_sticky( int $post_id )

Check if 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.

Parameters

$post_id

(Optional) Post ID. Default is 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;
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/post-template.php: get_the_ID()

Retrieve the ID of the current item in the ClassicPress Loop.
wp-includes/functions.php: absint()

Convert a value to non-negative integer.

Used By

Used By
Used By Description
wp-includes/deprecated.php: sticky_class()

Display “sticky” CSS class, if a post is sticky.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()

Prepares a single post output for response.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_database()

Prepares a single post for create or update.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getPost()

Retrieve post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getRecentPosts()

Retrieve list of recent posts.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_post()

Prepares post data for return in an XML-RPC object.
wp-includes/post-template.php: get_post_class()

Retrieves the classes for the post div as an array.
wp-admin/includes/template.php: _post_states()
wp-admin/includes/template.php: get_inline_data()

Adds hidden fields with the data for use in the inline editor for posts and pages.
wp-admin/includes/meta-boxes.php: post_submit_meta_box()

Displays post submit form fields.
wp-admin/includes/export.php: export_wp()

Generates the WXR export file for download.
Show 6 more used by Hide more used by

Changelog

Changelog
Version Description
WP-2.7.0 Introduced.