bp_is_<component>_<feature>_active

Filters whether or not a given feature for a component is active.

Description

apply_filters( 'bp_is_<component>_<feature>_active', (bool) $retval ); 

This is a variable filter that is based on the component and feature that you are checking of active status of.

Parameters (1)

0. $retval (bool)
The retval.

Usage

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

Defined (1)

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

/bp-core/bp-core-template.php  
  1. $retval = apply_filters( "bp_is_{$component}_{$feature}_active", $retval );