bbp_get_forum( int|object $forum, string $output = OBJECT, string $filter = 'raw' )

Gets a forum

Description

Parameters

$forum

(int|object) (Required) forum id or forum object

$output

(string) (Optional) OBJECT, ARRAY_A, or ARRAY_N. Default = OBJECT

Default value: OBJECT

$filter

(string) (Optional) Sanitation filter. See sanitize_post()

Default value: 'raw'

Return

(mixed) Null if error or forum (in specified form) if success

Source

File: bp-forums/forums/template.php

function bbp_get_forum( $forum, $output = OBJECT, $filter = 'raw' ) {

	// Use forum ID
	if ( empty( $forum ) || is_numeric( $forum ) )
		$forum = bbp_get_forum_id( $forum );

	// Attempt to load the forum
	$forum = get_post( $forum, OBJECT, $filter );
	if ( empty( $forum ) )
		return $forum;

	// Bail if post_type is not a forum
	if ( $forum->post_type !== bbp_get_forum_post_type() )
		return null;

	// Tweak the data type to return
	if ( $output === OBJECT ) {
		return $forum;

	} elseif ( $output === ARRAY_A ) {
		$_forum = get_object_vars( $forum );
		return $_forum;

	} elseif ( $output === ARRAY_N ) {
		$_forum = array_values( get_object_vars( $forum ) );
		return $_forum;

	}

	return apply_filters( 'bbp_get_forum', $forum, $output, $filter );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2787)	Introduced.

Uses

Uses
Uses	Description
bp-forums/forums/template.php: bbp_get_forum_id()	Return the forum id
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-groups/classes/class-bp-rest-group-settings-endpoint.php: BP_REST_Group_Settings_Endpoint::update_forum_fields()	Update Group Forum settings.
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::create_item()	Create a topic.
bp-forums/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::get_forum_current_user_permissions()	Forum permissions for the current user.
bp-forums/classes/class-bp-rest-reply-endpoint.php: BP_REST_Reply_Endpoint::create_item()	Create a reply.
bp-forums/templates/default/bbpress-functions.php: BBP_Default::ajax_forum_subscription()	AJAX handler to Subscribe/Unsubscribe a user from a forum
bp-forums/topics/functions.php: bbp_new_topic_handler()	Handles the front end topic submission
bp-forums/users/functions.php: bbp_is_user_subscribed_to_forum()	Check if a forum is in user’s subscription list or not
bp-forums/users/functions.php: bbp_add_user_forum_subscription()	Add a forum to user’s subscriptions
bp-forums/groups.php: BBP_Forums_Group_Extension::edit_screen_save()	Save the Group Forum data on edit
bp-forums/forums/template.php: bbp_get_forum_topics_link()	Return the topics link of the forum
bp-forums/forums/template.php: bbp_get_forum_ancestors()	Return array of parent forums
bp-forums/forums/functions.php: bbp_edit_forum_handler()	Handles the front end edit forum submission
bp-forums/replies/functions.php: bbp_new_reply_handler()	Handles the front end reply submission

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