woocommerce_email_attachments

The WordPress Core woocommerce email attachments hook.

Description

apply_filters( 'woocommerce_email_attachments', (array) $array, (string) $low_stock, (unknown) $product ); 

Parameters (3)

0. $array (array) => array()
The array.
1. $low_stock (string) => 'low_stock'
The low stock.
2. $product (unknown)
The product.

Usage

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

Defined (4)

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

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