bp_is_root_blog

Filters whether or not we're on the root blog.

Description

apply_filters( 'bp_is_root_blog', (bool) $bool_is_root_blog ); 

Parameters (1)

0. $bool_is_root_blog (bool) => (bool) $is_root_blog
Whether or not we're on the root blog.

Usage

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

Defined (1)

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

/bp-core/bp-core-functions.php  
  1. return (bool) apply_filters( 'bp_is_root_blog', (bool) $is_root_blog );