bp_get_messages_username_value

Filters the default username for the recipient box.

Description

apply_filters( 'bp_get_messages_username_value', (string) $cookie_bp_messages_send_to ); 

Value passed into filter is dependent on if the bp_messages_send_to cookie or r $_GET parameter is set.

Parameters (1)

0. $cookie_bp_messages_send_to (string)
The cookie bp messages send to.

Usage

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

Defined (2)

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

/bp-messages/bp-messages-template.php  
  1. return apply_filters( 'bp_get_messages_username_value', $_COOKIE['bp_messages_send_to'] ); 
  1. return apply_filters( 'bp_get_messages_username_value', $_GET['r'] );