bbp_get_private_forum_ids

The bbPress bbp get private forum ids hook.

Description

apply_filters( 'bbp_get_private_forum_ids', (array) $array_forum_ids ); 

Parameters (1)

0. $array_forum_ids (array) => (array) $forum_ids
The array forum ids.

Usage

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

Defined (1)

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

/includes/forums/functions.php  
  1. return apply_filters( 'bbp_get_private_forum_ids', (array) $forum_ids );