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_details', array( $this, 'order_details' ), 10, 4 ); add_action( 'woocommerce_email_order_details', array( $this, 'order_schema_markup' ), 20, 4 ); add_action( 'woocommerce_email_order_meta', array( $this, 'order_meta' ), 10, 3 ); add_action( 'woocommerce_email_customer_details', array( $this, 'customer_details' ), 10, 3 ); add_action( 'woocommerce_email_customer_details', array( $this, 'email_addresses' ), 20, 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( dirname( __FILE__ ) . '/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_Failed_Order'] = include( 'emails/class-wc-email-failed-order.php' ); $this->emails['WC_Email_Customer_On_Hold_Order'] = include( 'emails/class-wc-email-customer-on-hold-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_Refunded_Order'] = include( 'emails/class-wc-email-customer-refunded-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' ) && class_exists( 'DOMDocument' ) ) { include_once( dirname( __FILE__ ) . '/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() { return wp_specialchars_decode( get_option( 'woocommerce_email_from_name' ), ENT_QUOTES ); } /** * Get from email address. * * @return string */ public function get_from_address() { return sanitize_email( get_option( 'woocommerce_email_from_address' ) ); } /** * 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: "") * @return bool */ public function send( $to, $subject, $message, $headers = "Content-Type: text/html\r\n", $attachments = "" ) { // Send $email = new WC_Email(); return $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 ); } /** * Show the order details table */ public function order_details( $order, $sent_to_admin = false, $plain_text = false, $email = '' ) { if ( $plain_text ) { wc_get_template( 'emails/plain/email-order-details.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin, 'plain_text' => $plain_text, 'email' => $email ) ); } else { wc_get_template( 'emails/email-order-details.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin, 'plain_text' => $plain_text, 'email' => $email ) ); } } /** * Adds Schema.org markup for order in JSON-LD format. * * @since 2.6.0 * @param mixed $order * @param bool $sent_to_admin (default: false) * @param bool $plain_text (default: false) */ public function order_schema_markup( $order, $sent_to_admin = false, $plain_text = false ) { if ( $plain_text ) { return; } $accepted_offers = array(); foreach ( $order->get_items() as $item ) { if ( ! apply_filters( 'woocommerce_order_item_visible', true, $item ) ) { continue; } $product = apply_filters( 'woocommerce_order_item_product', $order->get_product_from_item( $item ), $item ); $product_exists = is_object( $product ); $is_visible = $product_exists && $product->is_visible(); $item_offered = array( '@type' => 'Product', 'name' => apply_filters( 'woocommerce_order_item_name', $item['name'], $item, $is_visible ), ); if ( $product_exists ) { if ( $sku = $product->get_sku() ) { $item_offered['sku'] = $sku; } if ( $image_id = $product->get_image_id() ) { $item_offered['image'] = wp_get_attachment_image_url( $image_id, 'thumbnail' ); } } if ( $is_visible ) { $item_offered['url'] = get_permalink( $product->get_id() ); } else { $item_offered['url'] = get_home_url(); } $accepted_offer = (object) array( '@type' => 'Offer', 'itemOffered' => $item_offered, 'price' => $order->get_line_subtotal( $item ), 'priceCurrency' => $order->get_order_currency(), 'eligibleQuantity' => (object) array( '@type' => 'QuantitativeValue', 'value' => apply_filters( 'woocommerce_email_order_item_quantity', $item['qty'], $item ) ), 'url' => get_home_url(), ); $accepted_offers[] = $accepted_offer; } $markup = array( '@context' => 'http://schema.org', '@type' => 'Order', 'merchant' => (object) array( '@type' => 'Organization', 'name' => get_bloginfo( 'name' ), ), 'orderNumber' => strval( $order->get_order_number() ), 'priceCurrency' => $order->get_order_currency(), 'price' => $order->get_total(), 'acceptedOffer' => $accepted_offers, 'url' => $order->get_view_order_url(), ); switch ( $order->get_status() ) { case 'pending': $markup['orderStatus'] = 'http://schema.org/OrderPaymentDue'; break; case 'processing': $markup['orderStatus'] = 'http://schema.org/OrderProcessing'; break; case 'on-hold': $markup['orderStatus'] = 'http://schema.org/OrderProblem'; break; case 'completed': $markup['orderStatus'] = 'http://schema.org/OrderDelivered'; break; case 'cancelled': $markup['orderStatus'] = 'http://schema.org/OrderCancelled'; break; case 'refunded': $markup['orderStatus'] = 'http://schema.org/OrderReturned'; break; case 'failed': $markup['orderStatus'] = 'http://schema.org/OrderProblem'; break; } if ( $sent_to_admin ) { $markup['potentialAction'] = (object) array( '@type' => 'ViewAction', 'target' => admin_url( 'post.php?post=' . absint( $order->id ) . '&action=edit' ), ); } $markup = apply_filters( 'woocommerce_email_order_schema_markup', $markup, $sent_to_admin, $order ); echo '
'; } /** * Add order meta to email templates. * * @param mixed $order * @param bool $sent_to_admin (default: false) * @param bool $plain_text (default: false) * @return string */ public function order_meta( $order, $sent_to_admin = false, $plain_text = false ) { $fields = apply_filters( 'woocommerce_email_order_meta_fields', array(), $sent_to_admin, $order ); /** * Deprecated woocommerce_email_order_meta_keys filter. * * @since 2.3.0 */ $_fields = apply_filters( 'woocommerce_email_order_meta_keys', array(), $sent_to_admin ); if ( $_fields ) { foreach ( $_fields as $key => $field ) { if ( is_numeric( $key ) ) { $key = $field; } $fields[ $key ] = array( 'label' => wptexturize( $key ), 'value' => wptexturize( get_post_meta( $order->id, $field, true ) ) ); } } if ( $fields ) { if ( $plain_text ) { foreach ( $fields as $field ) { if ( isset( $field['label'] ) && isset( $field['value'] ) && $field['value'] ) { echo $field['label'] . ': ' . $field['value'] . "\n"; } } } else { foreach ( $fields as $field ) { if ( isset( $field['label'] ) && isset( $field['value'] ) && $field['value'] ) { echo '' . $field['label'] . ': ' . $field['value'] . '
'; } } } } } /** * Is customer detail field valid? * @param array $field * @return boolean */ public function customer_detail_field_is_valid( $field ) { return isset( $field['label'] ) && ! empty( $field['value'] ); } /** * Add customer details to email templates. * * @param mixed $order * @param bool $sent_to_admin (default: false) * @param bool $plain_text (default: false) * @return string */ public function customer_details( $order, $sent_to_admin = false, $plain_text = false ) { $fields = array(); if ( $order->customer_note ) { $fields['customer_note'] = array( 'label' => __( 'Note', 'woocommerce' ), 'value' => wptexturize( $order->customer_note ) ); } if ( $order->billing_email ) { $fields['billing_email'] = array( 'label' => __( 'Email', 'woocommerce' ), 'value' => wptexturize( $order->billing_email ) ); } if ( $order->billing_phone ) { $fields['billing_phone'] = array( 'label' => __( 'Tel', 'woocommerce' ), 'value' => wptexturize( $order->billing_phone ) ); } $fields = array_filter( apply_filters( 'woocommerce_email_customer_details_fields', $fields, $sent_to_admin, $order ), array( $this, 'customer_detail_field_is_valid' ) ); if ( $plain_text ) { wc_get_template( 'emails/plain/email-customer-details.php', array( 'fields' => $fields ) ); } else { wc_get_template( 'emails/email-customer-details.php', array( 'fields' => $fields ) ); } } /** * Get the email addresses. */ public function email_addresses( $order, $sent_to_admin = false, $plain_text = false ) { if ( $plain_text ) { wc_get_template( 'emails/plain/email-addresses.php', array( 'order' => $order ) ); } else { wc_get_template( 'emails/email-addresses.php', array( 'order' => $order ) ); } } /** * 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() ), ENT_QUOTES, get_bloginfo( 'charset' ) ) ) . ' ' . sprintf( __( 'There are %d left', 'woocommerce' ), html_entity_decode( strip_tags( $product->get_total_stock() ) ) ); 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() ), ENT_QUOTES, get_bloginfo( 'charset' ) ) ); 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( __( '%1$s units of %2$s have been backordered in order #%3$s.', 'woocommerce' ), $quantity, html_entity_decode( strip_tags( $product->get_formatted_name() ), ENT_QUOTES, get_bloginfo( 'charset' ) ), $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 ) ); } }