Codex

Function Reference/is sticky

Contents

Description

This Conditional Tag checks if "Stick this post to the front page" check box has been checked for the current post. This is a boolean function, meaning it returns either TRUE or FALSE.

Usage

<?php is_sticky($post_ID); ?>

Parameters

$post_ID
(string) (optional) The post ID
Default: None

Return Values

(boolean) 
True on success, false on failure.

Examples

is_sticky();
// When any Sticky Post page is being displayed.

is_sticky('17');
// When Sticky Post 17 (ID) is being displayed.

Notes

Change Log

Since: 2.7.0

Source File

is_sticky() is located in wp-includes/post.php.

Related

Conditional Tags: comments_open(), is_404(), is_admin(), is_archive(), is_attachment(), is_author(), is_category(), is_comments_popup(), is_date(), is_day(), is_feed(), is_front_page(), is_home(), is_local_attachment(), is_multi_author, is_month(), is_new_day(), is_page(), is_page_template(), is_paged(), is_plugin_active(), is_plugin_active_for_network(), is_plugin_inactive(), is_plugin_page(), is_post_type_archive(), is_preview(), is_search(), is_single(), is_singular(), is_sticky(), is_tag(), is_tax(), is_taxonomy_hierarchical(), is_time(), is_trackback(), is_year(), in_category(), in_the_loop(), is_active_sidebar(), is_active_widget(), is_blog_installed(), is_rtl(), is_dynamic_sidebar(), is_user_logged_in(), has_excerpt(), has_post_thumbnail(), has_tag(), pings_open(), email exists(), post_type_exists(), taxonomy_exists(), term_exists(), username exists(), wp_attachment_is_image()

See also index of Function Reference and index of Template Tags.