unstick_post( int $post_id )

Un-stick a post.

Contents

Description Description

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

Parameters Parameters

$post_id

(int) (Required) Post ID.

Top ↑

Source Source

File: wp-includes/post.php

2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
function unstick_post( $post_id ) {
    $stickies = get_option( 'sticky_posts' );
 
    if ( ! is_array( $stickies ) ) {
        return;
    }
 
    if ( ! in_array( $post_id, $stickies ) ) {
        return;
    }
 
    $offset = array_search( $post_id, $stickies );
    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 );
    }
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.7.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/post.php: post_unstuck

Fires once a post has been removed from the sticky list.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/option.php: update_option()

Update the value of an option that was already added.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::create_item()

Creates a single post.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::update_item()

Updates a single post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_toggle_sticky()

Encapsulate the logic for sticking a post and determining if the user has permission to do so
wp-admin/includes/post.php: edit_post()

Update an existing post with values provided in $_POST.
wp-admin/includes/post.php: bulk_edit_posts()

Process the post data for the bulk editing of posts.
wp-includes/post.php: _reset_front_page_settings_for_post()

Reset the page_on_front, show_on_front, and page_for_post settings when a linked page is deleted or trashed.
Show 1 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.