bbp_is_forum_private( int $forum_id, bool $check_ancestors = true )
Is the forum private?
Description Description
Parameters Parameters
- $forum_id
-
(Optional) Forum id
- $check_ancestors
-
(Optional) Check if the ancestors are private
Default value: true
Return Return
(bool) True if private, false if not
Source Source
File: includes/forums/template.php
function bbp_is_forum_private( $forum_id = 0, $check_ancestors = true ) {
// Get the forum ID
$forum_id = bbp_get_forum_id( $forum_id );
// Check if the forum or one of it's ancestors is private
$retval = bbp_is_forum_visibility( $forum_id, bbp_get_private_status_id(), $check_ancestors, 'OR' );
// Filter & return
return (bool) apply_filters( 'bbp_is_forum_private', $retval, $forum_id, $check_ancestors );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |