unstick_post( int $post_id )
Un-sticks a post.
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
.
View all references
function unstick_post( $post_id ) {
$post_id = (int) $post_id;
$stickies = get_option( 'sticky_posts' );
if ( ! is_array( $stickies ) ) {
return;
}
$stickies = array_values( array_unique( array_map( 'intval', $stickies ) ) );
if ( ! in_array( $post_id, $stickies, true ) ) {
return;
}
$offset = array_search( $post_id, $stickies, true );
if ( false === $offset ) {
return;
}
array_splice( $stickies, $offset, 1 );
$updated = update_option( 'sticky_posts', $stickies );
if ( $updated ) {
/**
* Fires once a post has been removed from the sticky list.
*
* @since 4.6.0
*
* @param int $post_id ID of the post that was unstuck.
*/
do_action( 'post_unstuck', $post_id );
}
}
Hooks
-
do_action( 'post_unstuck',
int $post_id ) -
Fires once a post has been removed from the sticky list.
Changelog
Version | Description |
---|---|
2.7.0 | Introduced. |