bbp_get_forum_visibilities

Return an associative array of forum visibility.

Description

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

Returns (array)

Parameters (1)

0. $array — Optional. (array) => array( bbp_get_public_status_id() => _x( 'Public', 'Make forum public', 'bbpress' ), bbp_get_private_status_id() => _x( 'Private', 'Make forum private', 'bbpress' ), bbp_get_hidden_status_id() => _x( 'Hidden', 'Make forum hidden', 'bbpress' ) )
The array.

Usage

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

Defined (1)

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

/includes/forums/functions.php  
  1. return apply_filters( 'bbp_get_forum_visibilities', array(