bbp_get_topic_statuses

Return an associative array of available topic statuses.

Description

(array) apply_filters( 'bbp_get_topic_statuses', (array) $array ); 

Returns (array)

Parameters (1)

0. $array — Optional. (array) => array( bbp_get_public_status_id() => _x( 'Open', 'Open the topic', 'bbpress' ), bbp_get_closed_status_id() => _x( 'Closed', 'Close the topic', 'bbpress' ), bbp_get_spam_status_id() => _x( 'Spam', 'Spam the topic', 'bbpress' ), bbp_get_trash_status_id() => _x( 'Trash', 'Trash the topic', 'bbpress' ), bbp_get_pending_status_id() => _x( 'Pending', 'Mark topic as pending', 'bbpress' ), )
The array.

Usage

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

Defined (1)

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

/includes/topics/functions.php  
  1. return apply_filters( 'bbp_get_topic_statuses', array(