bp_email_set_from

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

Description

apply_filters( 'bp_email_set_from', (BP_Email_Recipient) $from, (string|array|int|WP_User) $email_address, (string) $name, (BP_Email) $instance ); 

Parameters (4)

0. $from (BP_Email_Recipient)
Sender details.
1. $email_address (string|array|int|WP_User)
Either a email address, user ID, or WP_User object.
2. $name — Optional. (string)
If $email_address is a string, this is the recipient's name.
3. $instance (BP_Email)
Current instance of the email type class.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-email.php  
  1. $this->from = apply_filters( 'bp_email_set_from', $from, $email_address, $name, $this );