wpseek.com
A WordPress-centric search engine for devs and theme authors



unstick_post › WordPress Function

Since2.7.0
Deprecatedn/a
› unstick_post ( $post_id )
Parameters:
  • (int) $post_id Post ID.
    Required: Yes
Defined at:
Codex:

Un-sticks a post.

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


Related Functions: stick_post, next_post, next_posts, sanitize_post, wp_insert_post

Source 

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