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.

$forum_forum_desc = apply_filters( 'get_forum_description', $forum_forum_desc, $forum_forum_id ); 
                         
if ( !empty( $forum_forum_desc ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the get_forum_description callback 
function filter_get_forum_description( $forum_forum_desc, $forum_forum_id ) { 
    // make filter magic happen here... 
    return $forum_forum_desc; 
}; 
         
// add the filter 
add_filter( 'get_forum_description', 'filter_get_forum_description', 10, 2 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'get_forum_description', 'filter_get_forum_description', 10, 2 );