stick_post() WordPress Function
The stick_post() function is used to make a post sticky. A sticky post is a post that is always displayed at the top of the blog, regardless of the blog's sort order.
stick_post( int $post_id ) #
Make a post sticky.
Description
Sticky posts should be displayed at the top of the front page.
Parameters
- $post_id
(int)(Required)Post ID.
Source
File: wp-includes/post.php
function stick_post( $post_id ) {
$post_id = (int) $post_id;
$stickies = get_option( 'sticky_posts' );
$updated = false;
if ( ! is_array( $stickies ) ) {
$stickies = array();
} else {
$stickies = array_unique( array_map( 'intval', $stickies ) );
}
if ( ! in_array( $post_id, $stickies, true ) ) {
$stickies[] = $post_id;
$updated = update_option( 'sticky_posts', array_values( $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 );
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.7.0 | Introduced. |