bp_core_component_slug_from_root_slug

Filters the default component slug from a WP page root_slug.

Description

apply_filters( 'bp_core_component_slug_from_root_slug', (string) $slug, (string) $root_slug ); 

Parameters (2)

0. $slug (string)
Short slug for use in the middle of URLs.
1. $root_slug (string)
The root slug which comes from $bp->pages-[component]->slug.

Usage

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

Defined (1)

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

/bp-core/bp-core-functions.php  
  1. return apply_filters( 'bp_core_component_slug_from_root_slug', $slug, $root_slug );