bbp_get_spectator_role

The spectator role is for registered users without any capabilities.

Description

(string) apply_filters( 'bbp_get_spectator_role', (string) $bbp_spectator ); 

Returns (string)

Parameters (1)

0. $bbp_spectator (string) => 'bbp_spectator'
The bbp spectator.

Usage

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

Defined (1)

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

/includes/core/capabilities.php  
  1. return apply_filters( 'bbp_get_spectator_role', 'bbp_spectator' );