get_forum_description

The BuddyPress get forum description hook.

Description

apply_filters( 'get_forum_description', (unknown) $forum_forum_desc, (unknown) $forum_forum_id ); 

Parameters (2)

0. $forum_forum_desc (unknown)
The forum forum desc.
1. $forum_forum_id (unknown)
The forum forum id.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-template.php  
  1. return apply_filters( 'get_forum_description', $forum->forum_desc, $forum->forum_id );