Question

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.

---

参数

$post_id

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

---

返回值

(bool) Whether post is sticky.

---

源代码

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

---

更新日志

Version	description
2.7.0	Introduced.

---

相关函数

Uses

• wp-includes/functions.php: absint()
• wp-includes/option.php: get_option()
• wp-includes/post-template.php: get_the_ID()

---

Used By

• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_response()
• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_database()
• wp-admin/includes/export.php: export_wp()
• wp-admin/includes/template.php: _post_states()
• wp-admin/includes/template.php: get_inline_data()
• wp-admin/includes/meta-boxes.php: post_submit_meta_box()
• wp-includes/deprecated.php: sticky_class()
• wp-includes/post-template.php: get_post_class()
• wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getPost()
• wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getRecentPosts()
• wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_post()
Show 6 more used by Hide more used by

---

User Contributed Notes

1. Skip to note content You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note Contributed by Codex

   Basic Example

   
   is_sticky();
   // When any Sticky Post page is being displayed.
   
   is_sticky('17');
   // When Sticky Post 17 (ID) is being displayed.