bp_is_component_front_page

Filters whether or not the specified BuddyPress component directory is set to be the front page.

Description

apply_filters( 'bp_is_component_front_page', (bool) $bp_pages_component_id_page_on_front, (string) $component ); 

Parameters (2)

0. $bp_pages_component_id_page_on_front — Optional. (bool) => ( $bp->pages->{$component}->id == $page_on_front )
Whether or not the specified component directory is set as front page.
1. $component (string)
Current component being checked.

Usage

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

Defined (1)

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

/bp-core/bp-core-template.php  
  1. return (bool) apply_filters( 'bp_is_component_front_page', ( $bp->pages->{$component}->id == $page_on_front ), $component );