bp_get_friends_root_slug

Filters the friends component root slug.

Description

apply_filters( 'bp_get_friends_root_slug', (string) $buddypress ); 

Parameters (1)

0. $buddypress (string) => buddypress()->friends->root_slug
Friends component root slug.

Usage

To run the hook, copy the example below.
  1. $buddypress = apply_filters( 'bp_get_friends_root_slug', $buddypress ); 
  2.  
  3. if ( !empty( $buddypress ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the bp_get_friends_root_slug callback 
  2. function filter_bp_get_friends_root_slug( $buddypress ) { 
  3. // make filter magic happen here... 
  4. return $buddypress
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_get_friends_root_slug', 'filter_bp_get_friends_root_slug', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_get_friends_root_slug', 'filter_bp_get_friends_root_slug', 10, 1 ); 

Defined (1)

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

/bp-friends/bp-friends-template.php  
  1. return apply_filters( 'bp_get_friends_root_slug', buddypress()->friends->root_slug );