forum_description

The BuddyPress forum description hook.

Description

apply_filters( 'forum_description', (unknown) $get_forum_description, (unknown) $args_id, (unknown) $args ); 

Parameters (3)

0. $get_forum_description (unknown) => get_forum_description( $args['id'] )
The get forum description.
1. $args_id (unknown)
The args id.
2. $args (unknown)
The args.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-template.php  
  1. if ( $desc = apply_filters( 'forum_description', get_forum_description( $args['id'] ), $args['id'], $args ) )