BBP_Shortcodes::display_forum( array $attr, string $content = '' )

Display the contents of a specific forum ID in an output buffer and return to ensure that post/page contents are displayed first.

Description

Parameters

$attr

(Required)

$content

(Optional)

Default value: ''

Return

(string)

Source

File: bp-forums/common/shortcodes.php

	public function display_forum( $attr, $content = '' ) {

		// Sanity check required info
		if ( !empty( $content ) || ( empty( $attr['id'] ) || !is_numeric( $attr['id'] ) ) )
			return $content;

		// Set passed attribute to $forum_id for clarity
		$forum_id = bbpress()->current_forum_id = $attr['id'];

		// Bail if ID passed is not a forum
		if ( !bbp_is_forum( $forum_id ) )
			return $content;

		// Start output buffer
		$this->start( 'bbp_single_forum' );

		// Check forum caps
		if ( bbp_user_can_view_forum( array( 'forum_id' => $forum_id ) ) ) {
			bbp_get_template_part( 'content',  'single-forum' );

		// Forum is private and user does not have caps
		} elseif ( bbp_is_forum_private( $forum_id, false ) ) {
			bbp_get_template_part( 'feedback', 'no-access'    );
		}

		// Return contents of output buffer
		return $this->end();
	}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3031)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/template-functions.php: bbp_get_template_part()	Adds Forums theme support to any active WordPress theme
bp-forums/users/template.php: bbp_user_can_view_forum()	Check if the user can access a specific forum
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/classes/class-bbpress.php: bbpress()	The main function responsible for returning the one true bbPress Instance to functions everywhere.
bp-forums/common/shortcodes.php: BBP_Shortcodes::start()	Start an output buffer.
bp-forums/common/shortcodes.php: BBP_Shortcodes::end()	Return the contents of the output buffer and flush its contents.
bp-forums/common/template.php: bbp_is_forum()	Check if current page is a Forums forum

Show 3 more uses Hide more uses

Used By
Used By	Description
bp-forums/core/theme-compat.php: bbp_template_include_theme_compat()	Reset main query vars and filter ‘the_content’ to output a Forums template part as needed.

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