bbp_get_forum_status

The bbPress bbp get forum status hook.

Description

apply_filters( 'bbp_get_forum_status', (unknown) $status, (unknown) $forum_id ); 

Parameters (2)

0. $status (unknown)
The status.
1. $forum_id (unknown)
The forum id.

Usage

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

Defined (1)

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

/includes/forums/template.php  
  1. return apply_filters( 'bbp_get_forum_status', $status, $forum_id );