Question

stick_post( int $post_id )

Make a post sticky.

---

description

Sticky posts should be displayed at the top of the front page.

---

参数

$post_id

(int) (Required) Post ID.

---

源代码

File: wp-includes/post.php

function stick_post( $post_id ) {
	$stickies = get_option('sticky_posts');

	if ( !is_array($stickies) )
		$stickies = array($post_id);

	if ( ! in_array($post_id, $stickies) )
		$stickies[] = $post_id;

	$updated = update_option( 'sticky_posts', $stickies );

	if ( $updated ) {
		/**
		 * Fires once a post has been added to the sticky list.
		 *
		 * @since 4.6.0
		 *
		 * @param int $post_id ID of the post that was stuck.
		 */
		do_action( 'post_stuck', $post_id );
	}
}

---

更新日志

Version	description
2.7.0	Introduced.

---

相关函数

Uses

• wp-includes/post.php: post_stuck
• wp-includes/plugin.php: do_action()
• wp-includes/option.php: update_option()
• wp-includes/option.php: get_option()

---

Used By

• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::create_item()
• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::update_item()
• wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_toggle_sticky()
• wp-admin/includes/post.php: edit_post()
• wp-admin/includes/post.php: bulk_edit_posts()

---

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

   Example

   
   $post_id = 1;
   stick_post( $post_id );