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

Is the forum closed?

Description

Parameters

$forum_id

(Optional) Forum id

$check_ancestors

(Optional) Check if the ancestors are closed (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_closed( $forum_id = 0, $check_ancestors = true ) {

		$forum_id = bbp_get_forum_id( $forum_id );
		$retval    = ( bbp_get_closed_status_id() === bbp_get_forum_status( $forum_id ) );

		if ( !empty( $check_ancestors ) ) {
			$ancestors = bbp_get_forum_ancestors( $forum_id );

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

		return (bool) apply_filters( 'bbp_is_forum_closed', (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_closed_status_id()	Return the closed post status ID
bp-forums/forums/template.php: bbp_is_forum_category()	Is the forum a category?
bp-forums/forums/template.php: bbp_is_forum_closed()	Is the forum closed?
bp-forums/forums/template.php: bbp_get_forum_status()	Return the status 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

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/classes/class-bp-rest-forums-endpoint.php: BP_REST_Forums_Endpoint::prepare_item_for_response()	Prepares component data for return as an object.
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/forums/template.php: bbp_is_forum_open()	Is the forum open?
bp-forums/forums/template.php: bbp_is_forum_closed()	Is the forum closed?
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/forums/functions.php: bbp_save_forum_extras()	Handle the saving of core forum metadata (Status, Visibility, and Type)
bp-forums/common/classes.php: BBP_Walker_Dropdown::start_el()
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 10 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