bp_is_current_component

Filters whether the current page belongs to the specified component.

Description

apply_filters( 'bp_is_current_component', (bool) $is_current_component, (string) $component ); 

Parameters (2)

0. $is_current_component (bool)
Whether or not the current page belongs to specified component.
1. $component (string)
Name of the component being checked.

Usage

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

Defined (1)

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

/bp-core/bp-core-template.php  
  1. return apply_filters( 'bp_is_current_component', $is_current_component, $component );