bbp_force_comment_status

The bbPress bbp force comment status hook.

Description

apply_filters( 'bbp_force_comment_status', (unknown) $retval, (unknown) $open, (unknown) $post_id, (unknown) $post_type ); 

Parameters (4)

0. $retval (unknown)
The retval.
1. $open (unknown)
The open.
2. $post_id (unknown)
The post id.
3. $post_type (unknown)
The post type.

Usage

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

Defined (1)

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

/includes/core/theme-compat.php  
  1. return apply_filters( 'bbp_force_comment_status', $retval, $open, $post_id, $post_type );