bbp_list_forums

The bbPress bbp list forums hook.

Description

apply_filters( 'bbp_list_forums', (unknown) $r_before_output_r_after, (unknown) $r ); 

Parameters (2)

0. $r_before_output_r_after (unknown)
The before output r after.
1. $r (unknown)
The r.

Usage

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

Defined (1)

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

/includes/forums/template.php  
  1. echo apply_filters( 'bbp_list_forums', $r['before'] . $output . $r['after'], $r );