bbp_get_forum

The bbPress bbp get forum hook.

Description

apply_filters( 'bbp_get_forum', (unknown) $forum, (unknown) $output, (unknown) $filter ); 

Parameters (3)

0. $forum (unknown)
The forum.
1. $output (unknown)
The output.
2. $filter (unknown)
The filter.

Usage

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

Defined (1)

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

/includes/forums/template.php  
  1. return apply_filters( 'bbp_get_forum', $forum, $output, $filter );