bbp_is_forum_private( int $forum_id, bool $check_ancestors = true )

Is the forum private?

Description

Parameters

$forum_id

(Optional) Forum id

$check_ancestors

(Optional) Check if the ancestors are private (only if they're a category)

Default value: true

Return

(bool) True if closed, false if not

Source

File: bp-forums/forums/template.php

function bbp_is_forum_private( $forum_id = 0, $check_ancestors = true ) {

	$forum_id   = bbp_get_forum_id( $forum_id );
	$visibility = bbp_get_forum_visibility( $forum_id );

	// If post status is private, return true
	$retval = ( bbp_get_private_status_id() === $visibility );

	// Check ancestors and inherit their privacy setting for display
	if ( !empty( $check_ancestors ) ) {
		$ancestors = bbp_get_forum_ancestors( $forum_id );

		foreach ( (array) $ancestors as $ancestor ) {
			if ( bbp_is_forum( $ancestor ) && bbp_is_forum_private( $ancestor, false ) ) {
				$retval = true;
			}
		}
	}

	return (bool) apply_filters( 'bbp_is_forum_private', (bool) $retval, $forum_id, $check_ancestors );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2746)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/functions.php: bbp_get_private_status_id()	Return the private post status ID
bp-forums/forums/template.php: bbp_is_forum_private()	Is the forum private?
bp-forums/forums/template.php: bbp_get_forum_visibility()	Return the visibility of the forum
bp-forums/forums/template.php: bbp_get_forum_ancestors()	Return array of parent forums
bp-forums/forums/template.php: bbp_get_forum_id()	Return the forum id
bp-forums/common/template.php: bbp_is_forum()	Check if current page is a Forums forum

Show 1 more use Hide more uses

Used By
Used By	Description
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::create_item()	Create a topic.
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::update_item()	Update/Edit a topic.
bp-forums/classes/class-bp-rest-reply-endpoint.php: BP_REST_Reply_Endpoint::create_item()	Create a reply.
bp-forums/classes/class-bp-rest-reply-endpoint.php: BP_REST_Reply_Endpoint::update_item()	Update/Edit a reply.
bp-forums/topics/functions.php: bbp_new_topic_handler()	Handles the front end topic submission
bp-forums/topics/functions.php: bbp_edit_topic_handler()	Handles the front end edit topic submission
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_suppress_private_forum_meta()	Replace forum meta details for users that cannot view them.
bp-forums/forums/template.php: bbp_suppress_private_author_link()	Replace forum author details for users that cannot view them.
bp-forums/forums/template.php: bbp_is_forum_private()	Is the forum private?
bp-forums/forums/functions.php: bbp_forum_enforce_private()	Check if it’s a private forum or a topic or reply of a private forum and if the user can’t view it, then sets a 404
bp-forums/forums/functions.php: bbp_new_forum_handler()	Handles the front end forum submission
bp-forums/forums/functions.php: bbp_edit_forum_handler()	Handles the front end edit forum submission
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()	Display the contents of a specific topic 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/common/shortcodes.php: BBP_Shortcodes::display_reply()	Display the contents of a specific reply ID in an output buffer and return to ensure that post/page contents are displayed first.
bp-forums/replies/functions.php: bbp_new_reply_handler()	Handles the front end reply submission
bp-forums/replies/functions.php: bbp_edit_reply_handler()	Handles the front end edit reply submission

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