bbp_is_topic_sticky( int $topic_id, int $check_super = true )

Is the topic a sticky or super sticky?

Description

Parameters

$topic_id

(Optional) Topic id

$check_super

(Optional) If set to true and if the topic is not a normal sticky, it is checked if it is a super sticky or not. Defaults to true.

Default value: true

Return

(bool) True if sticky or super sticky, false if not.

Source

File: bp-forums/topics/template.php

function bbp_is_topic_sticky( $topic_id = 0, $check_super = true ) {
	$topic_id = bbp_get_topic_id( $topic_id );
	$forum_id = bbp_get_topic_forum_id( $topic_id );
	$stickies = bbp_get_stickies( $forum_id );

	if ( in_array( $topic_id, $stickies ) || ( !empty( $check_super ) && bbp_is_topic_super_sticky( $topic_id ) ) )
		return true;

	return false;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2754)	Introduced.

Uses

Uses
Uses	Description
bp-forums/topics/template.php: bbp_get_topic_forum_id()	Return the forum id a topic belongs to
bp-forums/topics/template.php: bbp_is_topic_super_sticky()	Is the topic a super sticky?
bp-forums/topics/template.php: bbp_get_topic_id()	Return the topic id
bp-forums/topics/functions.php: bbp_get_stickies()	Return sticky topics of a forum

Used By
Used By	Description
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::prepare_item_for_response()	Prepares component data for return as an object.
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::get_topic_action_states()	Get topic actions state based on current user.
bp-forums/classes/class-bp-rest-topics-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::rest_update_sticky()	Update sticky things for the topic.
bp-forums/admin/topics.php: BBP_Topics_Admin::toggle_topic()	Toggle topic
bp-forums/admin/topics.php: BBP_Topics_Admin::row_actions()	Topic Row actions
bp-forums/topics/template.php: bbp_get_form_topic_type_dropdown()	Returns topic type select box (normal/sticky/super sticky)
bp-forums/topics/template.php: bbp_get_topic_stick_link()	Return the stick link of the topic
bp-forums/topics/template.php: bbp_get_topic_class()	Return the row class of a topic
bp-forums/topics/functions.php: bbp_toggle_topic_handler()	Handles the front end opening/closing, spamming/unspamming, sticking/unsticking and trashing/untrashing/deleting of topics

Show 4 more used by Hide more used by

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents