bbp_public_post_status

The bbPress bbp public post status hook.

Description

apply_filters( 'bbp_public_post_status', (string) $publish ); 

Parameters (1)

0. $publish (string) => 'publish'
The publish.

Usage

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

Defined (1)

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

/bbpress.php  
  1. $this->public_status_id = apply_filters( 'bbp_public_post_status', 'publish' );