bp_get_the_message_star_action_urlonly

Filters the star action URL for starring / unstarring a message.

Description

apply_filters( 'bp_get_the_message_star_action_urlonly', (string) $retval, (array) $r ); 

Parameters (2)

0. $retval (string)
URL for starring / unstarring a message.
1. $r (array)
Parsed link arguments. See $args in bp_get_the_message_star_action_link().

Usage

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

Defined (1)

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

/bp-messages/bp-messages-star.php  
  1. $retval = esc_url( apply_filters( 'bp_get_the_message_star_action_urlonly', $retval, $r ) );