Contents

Code Reference Functions bbp_register_view()

bbp_register_view( string $view, string $title, mixed $query_args = '', bool $feed = true, string $capability = '' )

Register a Forums view

Description

Parameters

$view

(Required) View name

$title

(Required) View title

$query_args

(Optional) bbp_has_topics() arguments.

Default value: ''

$feed

(Optional) Have a feed for the view? Defaults to true. NOT IMPLEMENTED

Default value: true

$capability

(Optional) Capability that the current user must have

Default value: ''

Return

(array) The just registered (but processed) view

Source

File: bp-forums/core/functions.php 

function bbp_register_view( $view, $title, $query_args = '', $feed = true, $capability = '' ) {

	// Bail if user does not have capability
	if ( ! empty( $capability ) && ! current_user_can( $capability ) )
		return false;

	$bbp   = bbpress();
	$view  = sanitize_title( $view );
	$title = esc_html( $title );

	if ( empty( $view ) || empty( $title ) )
		return false;

	$query_args = bbp_parse_args( $query_args, '', 'register_view' );

	// Set show_stickies to false if it wasn't supplied
	if ( !isset( $query_args['show_stickies'] ) )
		$query_args['show_stickies'] = false;

	$bbp->views[$view] = array(
		'title'  => $title,
		'query'  => $query_args,
		'feed'   => $feed
	);

	return $bbp->views[$view];
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r2789) Introduced.

Uses

Uses
Uses Description
bp-forums/classes/class-bbpress.php: bbpress()

The main function responsible for returning the one true bbPress Instance to functions everywhere.
bp-forums/common/functions.php: bbp_parse_args()

Merge user defined arguments into defaults array.

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.