bbp_is_forum_private

The bbPress bbp is forum private hook.

Description

apply_filters( 'bbp_is_forum_private', (bool) $bool_retval, (unknown) $forum_id, (unknown) $check_ancestors ); 

Parameters (3)

0. $bool_retval (bool) => (bool) $retval
The bool retval.
1. $forum_id (unknown)
The forum id.
2. $check_ancestors (unknown)
The check ancestors.

Usage

To run the hook, copy the example below.
  1. $bool_retval = apply_filters( 'bbp_is_forum_private', $bool_retval, $forum_id, $check_ancestors ); 
  2.  
  3. if ( !empty( $bool_retval ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the bbp_is_forum_private callback 
  2. function filter_bbp_is_forum_private( $bool_retval, $forum_id, $check_ancestors ) { 
  3. // make filter magic happen here... 
  4. return $bool_retval
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bbp_is_forum_private', 'filter_bbp_is_forum_private', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bbp_is_forum_private', 'filter_bbp_is_forum_private', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/forums/template.php  
  1. return (bool) apply_filters( 'bbp_is_forum_private', (bool) $retval, $forum_id, $check_ancestors );