bp_email_set_headers

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

Description

apply_filters( 'bp_email_set_headers', (string[]) $new_headers, (BP_Email) $instance ); 

Parameters (2)

0. $new_headers (string[])
Key/value pairs of new header name/values (strings).
1. $instance (BP_Email)
Current instance of the email type class.

Usage

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

Defined (1)

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

/bp-core/classes/class-bp-email.php  
  1. $this->headers = apply_filters( 'bp_email_set_headers', $new_headers, $this );