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

Is the forum public?

Description

Parameters

$forum_id

(Optional) Forum id

$check_ancestors

(Optional) Check if the ancestors are public (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_public( $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 public, return true
    $retval = ( bbp_get_public_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_public( $ancestor, false ) ) {
                $retval = true;
            }
        }
    }
 
    return (bool) apply_filters( 'bbp_is_forum_public', (bool) $retval, $forum_id, $check_ancestors );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2997)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/functions.php: bbp_get_public_status_id()	Return the public post status ID
bp-forums/forums/template.php: bbp_get_forum_visibility()	Return the visibility of the forum
bp-forums/forums/template.php: bbp_is_forum_public()	Is the forum public?
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/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_public()	Is the forum public?
bp-forums/activity.php: BBP_BuddyPress_Activity::reply_create()	Record an activity stream entry when a reply is created
bp-forums/activity.php: BBP_BuddyPress_Activity::topic_create()	Record an activity stream entry when a topic is created or updated

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