woocommerce/includes/class-wc-emails.php

372 lines
10 KiB
PHP

<?php
/**
* Transactional Emails Controller
*
* WooCommerce Emails Class which handles the sending on transactional emails and email templates. This class loads in available emails.
*
* @class WC_Emails
* @version 2.0.0
* @package WooCommerce/Classes/Emails
* @category Class
* @author WooThemes
*/
class WC_Emails {
/**
* @var array Array of email notification classes.
*/
public $emails;
/**
* @var string Stores the emailer's address.
* @access private
*/
private $_from_address;
/**
* @var string Stores the emailer's name.
* @access private
*/
private $_from_name;
/**
* @var mixed Content type for sent emails
* @access private
*/
private $_content_type;
/**
* @var WC_Emails The single instance of the class
* @since 2.1
*/
protected static $_instance = null;
/**
* Main WC_Emails Instance
*
* Ensures only one instance of WC_Emails is loaded or can be loaded.
*
* @since 2.1
* @static
* @return WC_Emails Main instance
*/
public static function instance() {
if ( is_null( self::$_instance ) ) {
self::$_instance = new self();
}
return self::$_instance;
}
/**
* Cloning is forbidden.
*
* @since 2.1
*/
public function __clone() {
_doing_it_wrong( __FUNCTION__, __( 'Cheatin&#8217; huh?', 'woocommerce' ), '2.1' );
}
/**
* Unserializing instances of this class is forbidden.
*
* @since 2.1
*/
public function __wakeup() {
_doing_it_wrong( __FUNCTION__, __( 'Cheatin&#8217; huh?', 'woocommerce' ), '2.1' );
}
/**
* Constructor for the email class hooks in all emails that can be sent.
*
*/
public function __construct() {
$this->init();
// Email Header, Footer and content hooks
add_action( 'woocommerce_email_header', array( $this, 'email_header' ) );
add_action( 'woocommerce_email_footer', array( $this, 'email_footer' ) );
add_action( 'woocommerce_email_order_meta', array( $this, 'order_meta' ), 10, 3 );
// Hooks for sending emails during store events
add_action( 'woocommerce_low_stock_notification', array( $this, 'low_stock' ) );
add_action( 'woocommerce_no_stock_notification', array( $this, 'no_stock' ) );
add_action( 'woocommerce_product_on_backorder_notification', array( $this, 'backorder' ) );
add_action( 'woocommerce_created_customer_notification', array( $this, 'customer_new_account' ), 10, 3 );
// Let 3rd parties unhook the above via this hook
do_action( 'woocommerce_email', $this );
}
/**
* Init email classes
*/
public function init() {
// Include email classes
include_once( 'emails/class-wc-email.php' );
$this->emails['WC_Email_New_Order'] = include( 'emails/class-wc-email-new-order.php' );
$this->emails['WC_Email_Cancelled_Order'] = include( 'emails/class-wc-email-cancelled-order.php' );
$this->emails['WC_Email_Customer_Processing_Order'] = include( 'emails/class-wc-email-customer-processing-order.php' );
$this->emails['WC_Email_Customer_Completed_Order'] = include( 'emails/class-wc-email-customer-completed-order.php' );
$this->emails['WC_Email_Customer_Invoice'] = include( 'emails/class-wc-email-customer-invoice.php' );
$this->emails['WC_Email_Customer_Note'] = include( 'emails/class-wc-email-customer-note.php' );
$this->emails['WC_Email_Customer_Reset_Password'] = include( 'emails/class-wc-email-customer-reset-password.php' );
$this->emails['WC_Email_Customer_New_Account'] = include( 'emails/class-wc-email-customer-new-account.php' );
$this->emails = apply_filters( 'woocommerce_email_classes', $this->emails );
// include css inliner
if ( ! class_exists( 'Emogrifier' ) ) {
include_once( 'libraries/class-emogrifier.php' );
}
}
/**
* Return the email classes - used in admin to load settings.
*
* @return array
*/
public function get_emails() {
return $this->emails;
}
/**
* Get from name for email.
*
* @return string
*/
public function get_from_name() {
if ( ! $this->_from_name ) {
$this->_from_name = get_option( 'woocommerce_email_from_name' );
}
return wp_specialchars_decode( $this->_from_name );
}
/**
* Get from email address.
*
* @return string
*/
public function get_from_address() {
if ( ! $this->_from_address ) {
$this->_from_address = get_option( 'woocommerce_email_from_address' );
}
return $this->_from_address;
}
/**
* Get the content type for the email.
*
* @return string
*/
public function get_content_type() {
return $this->_content_type;
}
/**
* Get the email header.
*
* @param mixed $email_heading heading for the email
*/
public function email_header( $email_heading ) {
wc_get_template( 'emails/email-header.php', array( 'email_heading' => $email_heading ) );
}
/**
* Get the email footer.
*/
public function email_footer() {
wc_get_template( 'emails/email-footer.php' );
}
/**
* Wraps a message in the woocommerce mail template.
*
* @param mixed $email_heading
* @param string $message
* @return string
*/
public function wrap_message( $email_heading, $message, $plain_text = false ) {
// Buffer
ob_start();
do_action( 'woocommerce_email_header', $email_heading );
echo wpautop( wptexturize( $message ) );
do_action( 'woocommerce_email_footer' );
// Get contents
$message = ob_get_clean();
return $message;
}
/**
* Send the email.
*
* @param mixed $to
* @param mixed $subject
* @param mixed $message
* @param string $headers (default: "Content-Type: text/html\r\n")
* @param string $attachments (default: "")
* @param string $content_type (default: "text/html")
*/
public function send( $to, $subject, $message, $headers = "Content-Type: text/html\r\n", $attachments = "", $content_type = 'text/html' ) {
// Set content type
$this->_content_type = $content_type;
// Send
$email = new WC_Email();
$email->send( $to, $subject, $message, $headers, $attachments );
}
/**
* Prepare and send the customer invoice email on demand.
*/
public function customer_invoice( $order ) {
$email = $this->emails['WC_Email_Customer_Invoice'];
$email->trigger( $order );
}
/**
* Customer new account welcome email.
*
* @param int $customer_id
* @param array $new_customer_data
*/
public function customer_new_account( $customer_id, $new_customer_data = array(), $password_generated = false ) {
if ( ! $customer_id ) {
return;
}
$user_pass = ! empty( $new_customer_data['user_pass'] ) ? $new_customer_data['user_pass'] : '';
$email = $this->emails['WC_Email_Customer_New_Account'];
$email->trigger( $customer_id, $user_pass, $password_generated );
}
/**
* Add order meta to email templates.
*
* @param mixed $order
* @param bool $sent_to_admin (default: false)
* @param bool $plain_text (default: false)
*/
public function order_meta( $order, $sent_to_admin = false, $plain_text = false ) {
$meta = array();
$show_fields = apply_filters( 'woocommerce_email_order_meta_keys', array(), $sent_to_admin );
if ( $order->customer_note ) {
$meta[ __( 'Note', 'woocommerce' ) ] = wptexturize( $order->customer_note );
}
if ( $show_fields ) {
foreach ( $show_fields as $key => $field ) {
if ( is_numeric( $key ) )
$key = $field;
$meta[ wptexturize( $key ) ] = wptexturize( get_post_meta( $order->id, $field, true ) );
}
}
if ( sizeof( $meta ) > 0 ) {
if ( $plain_text ) {
foreach ( $meta as $key => $value ) {
if ( $value ) {
echo $key . ': ' . $value . "\n";
}
}
} else {
foreach ( $meta as $key => $value ) {
if ( $value ) {
echo '<p><strong>' . $key . ':</strong> ' . $value . '</p>';
}
}
}
}
}
/**
* Get blog name formatted for emails
* @return string
*/
private function get_blogname() {
return wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
}
/**
* Low stock notification email.
*
* @param WC_Product $product
*/
public function low_stock( $product ) {
$subject = sprintf( '[%s] %s', $this->get_blogname(), __( 'Product low in stock', 'woocommerce' ) );
$message = sprintf( __( '%s is low in stock.', 'woocommerce' ), html_entity_decode( strip_tags( $product->get_formatted_name() ) ) );
wp_mail(
apply_filters( 'woocommerce_email_recipient_low_stock', get_option( 'woocommerce_stock_email_recipient' ), $product ),
apply_filters( 'woocommerce_email_subject_low_stock', $subject, $product ),
apply_filters( 'woocommerce_email_content_low_stock', $message, $product ),
apply_filters( 'woocommerce_email_headers', '', 'low_stock', $product ),
apply_filters( 'woocommerce_email_attachments', array(), 'low_stock', $product )
);
}
/**
* No stock notification email.
*
* @param WC_Product $product
*/
public function no_stock( $product ) {
$subject = sprintf( '[%s] %s', $this->get_blogname(), __( 'Product out of stock', 'woocommerce' ) );
$message = sprintf( __( '%s is out of stock.', 'woocommerce' ), html_entity_decode( strip_tags( $product->get_formatted_name() ) ) );
wp_mail(
apply_filters( 'woocommerce_email_recipient_no_stock', get_option( 'woocommerce_stock_email_recipient' ), $product ),
apply_filters( 'woocommerce_email_subject_no_stock', $subject, $product ),
apply_filters( 'woocommerce_email_content_no_stock', $message, $product ),
apply_filters( 'woocommerce_email_headers', '', 'no_stock', $product ),
apply_filters( 'woocommerce_email_attachments', array(), 'no_stock', $product )
);
}
/**
* Backorder notification email.
*
* @param array $args
*/
public function backorder( $args ) {
$args = wp_parse_args( $args, array(
'product' => '',
'quantity' => '',
'order_id' => ''
) );
extract( $args );
if ( ! $product || ! $quantity || ! ( $order = wc_get_order( $order_id ) ) ) {
return;
}
$subject = sprintf( '[%s] %s', $this->get_blogname(), __( 'Product Backorder', 'woocommerce' ) );
$message = sprintf( __( '%s units of %s have been backordered in order #%s.', 'woocommerce' ), $quantity, html_entity_decode( strip_tags( $product->get_formatted_name() ) ), $order->get_order_number() );
wp_mail(
apply_filters( 'woocommerce_email_recipient_backorder', get_option( 'woocommerce_stock_email_recipient' ), $args ),
apply_filters( 'woocommerce_email_subject_backorder', $subject, $args ),
apply_filters( 'woocommerce_email_content_backorder', $message, $args ),
apply_filters( 'woocommerce_email_headers', '', 'backorder', $args ),
apply_filters( 'woocommerce_email_attachments', array(), 'backorder', $args )
);
}
}