bp_email_set_to

Filters the new value of the email's "to" property.

Description

apply_filters( 'bp_email_set_to', (BP_Email_Recipient[]) $to, (string) $to_address, (string) $name, (string) $operation, (BP_Email) $instance ); 

Parameters (5)

0. $to (BP_Email_Recipient[])
"To" recipients.
1. $to_address (string)
The to address.
2. $name (string)
"To" name.
3. $operation (string)
If replace,, $to_address replaced previous recipients. If add, $to_address was added to the array of recipients.
4. $instance (BP_Email)
Current instance of the email type class.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-email.php  
  1. $this->to = apply_filters( 'bp_email_set_to', $to, $to_address, $name, $operation, $this );