forum_id

The BuddyPress forum id hook.

Description

apply_filters( 'forum_id', (unknown) $get_forum_id ); 

Parameters (1)

0. $get_forum_id (unknown) => get_forum_id( $forum_id )
The get forum id.

Usage

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

Defined (1)

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

/bp-forums/bbpress/bb-includes/functions.bb-template.php  
  1. echo apply_filters( 'forum_id', get_forum_id( $forum_id ) );