bbp_exclude_forum_ids

The bbPress bbp exclude forum ids hook.

Description

apply_filters( 'bbp_exclude_forum_ids', (unknown) $retval, (unknown) $forum_ids, (unknown) $type ); 

Parameters (3)

0. $retval (unknown)
The retval.
1. $forum_ids (unknown)
The forum ids.
2. $type (unknown)
The type.

Usage

To run the hook, copy the example below.
  1. $retval = apply_filters( 'bbp_exclude_forum_ids', $retval, $forum_ids, $type ); 
  2.  
  3. if ( !empty( $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_exclude_forum_ids callback 
  2. function filter_bbp_exclude_forum_ids( $retval, $forum_ids, $type ) { 
  3. // make filter magic happen here... 
  4. return $retval
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bbp_exclude_forum_ids', 'filter_bbp_exclude_forum_ids', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bbp_exclude_forum_ids', 'filter_bbp_exclude_forum_ids', 10, 3 ); 

Defined (1)

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

/includes/forums/functions.php  
  1. return apply_filters( 'bbp_exclude_forum_ids', $retval, $forum_ids, $type );