bp_email_recipient_get_address

Filters the recipient's address before it's returned.

Description

apply_filters( 'bp_email_recipient_get_address', (string) $this_address, (BP_Email) $instance ); 

Parameters (2)

0. $this_address (string)
Recipient's address.
1. $instance (BP_Email)
$this Current instance of the email recipient class.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-email-recipient.php  
  1. return apply_filters( 'bp_email_recipient_get_address', $this->address, $this );