is_sticky( int $post_id )

Determines whether a post is sticky.

Contents

Description Description

Sticky posts should remain at the top of The Loop. If the post ID is not given, then The Loop ID for the current post will be used.

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Parameters Parameters

$post_id

(int) (Optional) Post ID. Default is ID of the global $post.

Top ↑

Return Return

(bool) Whether post is sticky.

Top ↑

Source Source

File: wp-includes/post.php

2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
function is_sticky( $post_id = 0 ) {
    $post_id = absint( $post_id );
 
    if ( ! $post_id ) {
        $post_id = get_the_ID();
    }
 
    $stickies = get_option( 'sticky_posts' );
 
    if ( ! is_array( $stickies ) ) {
        return false;
    }
 
    if ( in_array( $post_id, $stickies ) ) {
        return true;
    }
 
    return false;
}

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/functions.php: absint()

Convert a value to non-negative integer.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/post-template.php: get_the_ID()

Retrieve the ID of the current item in the WordPress Loop.

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::prepare_item_for_response()

Prepares a single post output for response.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::prepare_item_for_database()

Prepares a single post for create or update.
wp-admin/includes/export.php: export_wp()

Generates the WXR export file for download.
wp-admin/includes/template.php: _post_states()
wp-admin/includes/template.php: get_inline_data()

Adds hidden fields with the data for use in the inline editor for posts and pages.
wp-admin/includes/meta-boxes.php: post_submit_meta_box()

Displays post submit form fields.
wp-includes/deprecated.php: sticky_class()

Display “sticky” CSS class, if a post is sticky.
wp-includes/post-template.php: get_post_class()

Retrieves an array of the class names for the post container element.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getPost()

Retrieve post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_getRecentPosts()

Retrieve list of recent posts.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_prepare_post()

Prepares post data for return in an XML-RPC object.
Show 6 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.