bbp_is_forum( int $post_id )

Check if current page is a Forums forum

Description

Parameters

$post_id: (int) (Required) Possible post_id to check

Return

(bool) True if it's a forum page, false if not

Source

function bbp_is_forum( $post_id = 0 ) {

	// Assume false
	$retval = false;

	// Supplied ID is a forum
	if ( !empty( $post_id ) && ( bbp_get_forum_post_type() === get_post_type( $post_id ) ) )
		$retval = true;

	return (bool) apply_filters( 'bbp_is_forum', $retval, $post_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2549)	Introduced.

Uses

Uses
Uses	Description
bp-forums/forums/template.php: bbp_get_forum_post_type()	Return the unique id of the custom post type for forums

Used By
Used By	Description
bp-forums/admin/forums.php: BBP_Forums_Admin::attributes_metabox_save()	Pass the forum attributes for processing
bp-forums/topics/functions.php: bbp_update_topic_walker()	Walks up the post_parent tree from the current topic_id, and updates the counts of forums above it. This calls a few internal functions that all run manual queries against the database to get their results. As such, this function can be costly to run but is necessary to keep everything accurate.
bp-forums/topics/functions.php: bbp_move_topic_handler()	Handle the moving of a topic from one forum to another. This includes walking up the old and new branches and updating the counts.
bp-forums/forums/template.php: bbp_is_forum_private()	Is the forum private?
bp-forums/forums/template.php: bbp_is_forum_hidden()	Is the forum hidden?
bp-forums/forums/template.php: bbp_is_forum_public()	Is the forum public?
bp-forums/forums/template.php: bbp_get_forum_id()	Return the forum id
bp-forums/forums/functions.php: bbp_untrashed_forum()	Called after untrashing a forum
bp-forums/forums/functions.php: bbp_delete_forum()	Called before deleting a forum.
bp-forums/forums/functions.php: bbp_trash_forum()	Called before trashing a forum
bp-forums/forums/functions.php: bbp_untrash_forum()	Called before untrashing a forum
bp-forums/forums/functions.php: bbp_deleted_forum()	Called after deleting a forum
bp-forums/forums/functions.php: bbp_trashed_forum()	Called after trashing a forum
bp-forums/forums/functions.php: bbp_save_forum_extras()	Handle the saving of core forum metadata (Status, Visibility, and Type)
bp-forums/common/shortcodes.php: BBP_Shortcodes::display_forum()	Display the contents of a specific forum ID in an output buffer and return to ensure that post/page contents are displayed first.
bp-forums/common/shortcodes.php: BBP_Shortcodes::display_topic_form()	Display the topic form in an output buffer and return to ensure post/page contents are displayed first.
bp-forums/replies/functions.php: bbp_update_reply_walker()	Walk up the ancestor tree from the current reply, and update all the counts

Show 12 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