bbp_forum_get_subforums

The bbPress bbp forum get subforums hook.

Description

apply_filters( 'bbp_forum_get_subforums', (unknown) $sub_forums, (unknown) $r ); 

Parameters (2)

0. $sub_forums (unknown)
The sub forums.
1. $r (unknown)
The r.

Usage

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

Defined (1)

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

/includes/forums/template.php  
  1. return (array) apply_filters( 'bbp_forum_get_subforums', $sub_forums, $r );