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

Gets a forum


Description Description


Parameters Parameters

$forum

(Required) forum id or forum object

$output

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

Default value: OBJECT

$filter

(Optional) Sanitation filter. See sanitize_post()

Default value: 'raw'


Top ↑

Return Return

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


Top ↑

Source Source

File: includes/forums/template.php

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

	// Maybe get ID from empty or int
	if ( empty( $forum ) || is_numeric( $forum ) ) {
		$forum = bbp_get_forum_id( $forum );
	}

	// Bail if no post object
	$forum = get_post( $forum, OBJECT, $filter );
	if ( empty( $forum ) ) {
		return $forum;
	}

	// Bail if not correct post type
	if ( $forum->post_type !== bbp_get_forum_post_type() ) {
		return null;
	}

	// Default return value is OBJECT
	$retval = $forum;

	// Array A
	if ( $output === ARRAY_A ) {
		$retval = get_object_vars( $forum );

	// Array N
	} elseif ( $output === ARRAY_N ) {
		$retval = array_values( get_object_vars( $forum ) );
	}

	// Filter & return
	return apply_filters( 'bbp_get_forum', $retval, $forum, $output, $filter );
}

Top ↑

Changelog Changelog

Changelog
Version Description
2.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.