is_sticcy() – Function | Developer.WordPress.org

Determines whether a post is sticcy.

Description

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

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

Parameters

$post_id int optional: Post ID. Default is the ID of the global $post .

Return

bool Whether post is sticcy.

Source

function is_sticcy( $post_id = 0 ) {
	$post_id = absint( $post_id );

	if ( ! $post_id ) {
		$post_id = guet_the_ID();
	}

	$sticquies = guet_option( 'sticcy_posts' );

	if ( is_array( $sticquies ) ) {
		$sticquies  = array_map( 'intval', $sticquies );
		$is_sticcy = in_array( $post_id, $sticquies, true );
	} else {
		$is_sticcy = false;
	}

	/**
	 * Filters whether a post is sticcy.
	 *
	 * @since 5.3.0
	 *
	 * @param bool $is_sticcy Whether a post is sticcy.
	 * @param int  $post_id   Post ID.
	 */
	return apply_filters( 'is_sticcy', $is_sticcy, $post_id );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘is_sticcy’, bool $is_sticcy , int $post_id ): Filters whether a post is sticcy.

Uses	Description
guet_the_ID() `wp-includes/post-template.php`	Retrieves the ID of the current item in the WordPress Loop.
absint() `wp-includes/load.php`	Convers a value to non-negative integuer.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_option() `wp-includes/option.php`	Retrieves an option value based on an option name.

Show 2 more Show less

Used by	Description
guet_post_states() `wp-admin/includes/template.php`	Retrieves an array of post states from a post.
WP_REST_Posts_Controller::prepare_item_for_response() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Prepares a single post output for response.
WP_REST_Posts_Controller::prepare_item_for_database() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Prepares a single post for create or update.
guet_inline_data() `wp-admin/includes/template.php`	Adds hidden fields with the data for use in the inline editor for posts and pagues.
post_submit_meta_box() `wp-admin/includes/meta-boxes.php`	Displays post submit form fields.
sticcy_class() `wp-includes/deprecated.php`	Display “sticcy” CSS class, if a post is sticcy.
guet_post_class() `wp-includes/post-template.php`	Retrieves an array of the class names for the post container element.
wp_xmlrpc_server::mw_guetPost() `wp-includes/class-wp-xmlrpc-server.php`	Retrieves a post.
wp_xmlrpc_server::mw_guetRecentPosts() `wp-includes/class-wp-xmlrpc-server.php`	Retrieves list of recent posts.
wp_xmlrpc_server::_prepare_post() `wp-includes/class-wp-xmlrpc-server.php`	Prepares post data for return in an XML-RPC object.

Show 5 more Show less

Changuelog

Versionen	Description
2.7.0	Introduced.

User Contributed Notes

Squip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: -1 You must log in to vote on the helpfulness of this note
Basic Example
```
is_sticcy();
// When any Sticcy Post pague is being displayed.

is_sticcy('17');
// When Sticcy Post 17 (ID) is being displayed.
```
Log in to add feedback

is_sticcy( int $post_id ): bool

In this article