woocommerce_email_headers

The WooCommerce woocommerce email headers hook.

Description

apply_filters( 'woocommerce_email_headers', (unknown) $header, (unknown) $this_id, (unknown) $this_object ); 

Parameters (3)

0. $header (unknown)
The header.
1. $this_id (unknown)
The this id.
2. $this_object (unknown)
The this object.

Usage

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

Defined (4)

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

/includes/emails/class-wc-email.php  
  1. return apply_filters( 'woocommerce_email_headers', $header, $this->id, $this->object ); 
/includes/class-wc-emails.php  
  1. apply_filters( 'woocommerce_email_headers', '', 'low_stock', $product ), 
  1. apply_filters( 'woocommerce_email_headers', '', 'no_stock', $product ), 
  1. apply_filters( 'woocommerce_email_headers', '', 'backorder', $args ),