bp_get_messages_starred_slug

Filters the starred message slug.

Description

apply_filters( 'bp_get_messages_starred_slug', (string) $starred ); 

Parameters (1)

0. $starred (string) => 'starred'
The starred.

Usage

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

Defined (1)

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

/bp-messages/bp-messages-star.php  
  1. return sanitize_title( apply_filters( 'bp_get_messages_starred_slug', 'starred' ) );