bbp_get_topic_status

The bbPress bbp get topic status hook.

Description

apply_filters( 'bbp_get_topic_status', (unknown) $get_post_status, (unknown) $topic_id ); 

Parameters (2)

0. $get_post_status (unknown) => get_post_status( $topic_id )
The get post status.
1. $topic_id (unknown)
The topic id.

Usage

To run the hook, copy the example below.
  1. $get_post_status = apply_filters( 'bbp_get_topic_status', $get_post_status, $topic_id ); 
  2.  
  3. if ( !empty( $get_post_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_topic_status callback 
  2. function filter_bbp_get_topic_status( $get_post_status, $topic_id ) { 
  3. // make filter magic happen here... 
  4. return $get_post_status
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bbp_get_topic_status', 'filter_bbp_get_topic_status', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bbp_get_topic_status', 'filter_bbp_get_topic_status', 10, 2 ); 

Defined (1)

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

/includes/topics/template.php  
  1. return apply_filters( 'bbp_get_topic_status', get_post_status( $topic_id ), $topic_id );