From 971f6a3dee6279c3c10f283b8f03ab7189f27f1e Mon Sep 17 00:00:00 2001
From: Mike Jolley <mike.jolley@me.com>
Date: Mon, 8 Feb 2016 13:20:19 +0000
Subject: [PATCH] Added email for on-hold orders.

Closes #9792
---
 includes/class-wc-emails.php                  |   3 +-
 .../class-wc-email-customer-on-hold-order.php | 102 ++++++++++++++++++
 ...ass-wc-email-customer-processing-order.php |   5 +-
 templates/emails/customer-on-hold-order.php   |  51 +++++++++
 .../emails/plain/customer-on-hold-order.php   |  49 +++++++++
 5 files changed, 206 insertions(+), 4 deletions(-)
 create mode 100644 includes/emails/class-wc-email-customer-on-hold-order.php
 create mode 100644 templates/emails/customer-on-hold-order.php
 create mode 100644 templates/emails/plain/customer-on-hold-order.php

diff --git a/includes/class-wc-emails.php b/includes/class-wc-emails.php
index 667ef7e5a8b..c0c8b4d6079 100644
--- a/includes/class-wc-emails.php
+++ b/includes/class-wc-emails.php
@@ -132,6 +132,7 @@ class WC_Emails {
 		$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' );
@@ -344,7 +345,7 @@ class WC_Emails {
 				'value' => wptexturize( $order->customer_note )
 			);
 		}
-		
+
 		if ( $order->billing_email ) {
 			$fields['billing_email'] = array(
 				'label' => __( 'Email', 'woocommerce' ),
diff --git a/includes/emails/class-wc-email-customer-on-hold-order.php b/includes/emails/class-wc-email-customer-on-hold-order.php
new file mode 100644
index 00000000000..433a1cc452d
--- /dev/null
+++ b/includes/emails/class-wc-email-customer-on-hold-order.php
@@ -0,0 +1,102 @@
+<?php
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit; // Exit if accessed directly
+}
+
+if ( ! class_exists( 'WC_Email_Customer_Processing_Order' ) ) :
+
+/**
+ * Customer On-hold Order Email.
+ *
+ * An email sent to the customer when a new order is on-hold for.
+ *
+ * @class       WC_Email_Customer_On_Hold_Order
+ * @version     2.0.0
+ * @package     WooCommerce/Classes/Emails
+ * @author      WooThemes
+ * @extends     WC_Email
+ */
+class WC_Email_Customer_On_Hold_Order extends WC_Email {
+
+	/**
+	 * Constructor.
+	 */
+	function __construct() {
+		$this->id               = 'customer_on_hold_order';
+		$this->customer_email   = true;
+		$this->title            = __( 'Order on-hold', 'woocommerce' );
+		$this->description      = __( 'This is an order notification sent to customers containing order details after an order is placed on-hold.', 'woocommerce' );
+		$this->heading          = __( 'Thank you for your order', 'woocommerce' );
+		$this->subject          = __( 'Your {site_title} order receipt from {order_date}', 'woocommerce' );
+		$this->template_html    = 'emails/customer-on-hold-order.php';
+		$this->template_plain   = 'emails/plain/customer-on-hold-order.php';
+
+		// Triggers for this email
+		add_action( 'woocommerce_order_status_pending_to_on-hold_notification', array( $this, 'trigger' ) );
+
+		// Call parent constructor
+		parent::__construct();
+	}
+
+	/**
+	 * Trigger.
+	 *
+	 * @param int $order_id
+	 */
+	function trigger( $order_id ) {
+
+		if ( $order_id ) {
+			$this->object       = wc_get_order( $order_id );
+			$this->recipient    = $this->object->billing_email;
+
+			$this->find['order-date']      = '{order_date}';
+			$this->find['order-number']    = '{order_number}';
+
+			$this->replace['order-date']   = date_i18n( wc_date_format(), strtotime( $this->object->order_date ) );
+			$this->replace['order-number'] = $this->object->get_order_number();
+		}
+
+		if ( ! $this->is_enabled() || ! $this->get_recipient() ) {
+			return;
+		}
+
+		$this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
+	}
+
+	/**
+	 * Get content html.
+	 *
+	 * @access public
+	 * @return string
+	 */
+	function get_content_html() {
+		return wc_get_template_html( $this->template_html, array(
+			'order'         => $this->object,
+			'email_heading' => $this->get_heading(),
+			'sent_to_admin' => false,
+			'plain_text'    => false,
+			'email'			=> $this
+		) );
+	}
+
+	/**
+	 * Get content plain.
+	 *
+	 * @access public
+	 * @return string
+	 */
+	function get_content_plain() {
+		return wc_get_template_html( $this->template_plain, array(
+			'order'         => $this->object,
+			'email_heading' => $this->get_heading(),
+			'sent_to_admin' => false,
+			'plain_text'    => true,
+			'email'			=> $this
+		) );
+	}
+}
+
+endif;
+
+return new WC_Email_Customer_On_Hold_Order();
diff --git a/includes/emails/class-wc-email-customer-processing-order.php b/includes/emails/class-wc-email-customer-processing-order.php
index d91175576da..4966fcd2227 100644
--- a/includes/emails/class-wc-email-customer-processing-order.php
+++ b/includes/emails/class-wc-email-customer-processing-order.php
@@ -9,7 +9,7 @@ if ( ! class_exists( 'WC_Email_Customer_Processing_Order' ) ) :
 /**
  * Customer Processing Order Email.
  *
- * An email sent to the customer when a new order is received/paid for.
+ * An email sent to the customer when a new order is paid for.
  *
  * @class       WC_Email_Customer_Processing_Order
  * @version     2.0.0
@@ -26,7 +26,7 @@ class WC_Email_Customer_Processing_Order extends WC_Email {
 		$this->id               = 'customer_processing_order';
 		$this->customer_email   = true;
 		$this->title            = __( 'Processing order', 'woocommerce' );
-		$this->description      = __( 'This is an order notification sent to customers containing their order details after payment.', 'woocommerce' );
+		$this->description      = __( 'This is an order notification sent to customers containing order details after payment.', 'woocommerce' );
 		$this->heading          = __( 'Thank you for your order', 'woocommerce' );
 		$this->subject          = __( 'Your {site_title} order receipt from {order_date}', 'woocommerce' );
 		$this->template_html    = 'emails/customer-processing-order.php';
@@ -34,7 +34,6 @@ class WC_Email_Customer_Processing_Order extends WC_Email {
 
 		// Triggers for this email
 		add_action( 'woocommerce_order_status_pending_to_processing_notification', array( $this, 'trigger' ) );
-		add_action( 'woocommerce_order_status_pending_to_on-hold_notification', array( $this, 'trigger' ) );
 
 		// Call parent constructor
 		parent::__construct();
diff --git a/templates/emails/customer-on-hold-order.php b/templates/emails/customer-on-hold-order.php
new file mode 100644
index 00000000000..4b6a3873164
--- /dev/null
+++ b/templates/emails/customer-on-hold-order.php
@@ -0,0 +1,51 @@
+<?php
+/**
+ * Customer on-hold order email
+ *
+ * This template can be overridden by copying it to yourtheme/woocommerce/emails/customer-processing-order.php.
+ *
+ * HOWEVER, on occasion WooCommerce will need to update template files and you (the theme developer).
+ * will need to copy the new files to your theme to maintain compatibility. We try to do this.
+ * as little as possible, but it does happen. When this occurs the version of the template file will.
+ * be bumped and the readme will list any important changes.
+ *
+ * @see 	    http://docs.woothemes.com/document/template-structure/
+ * @author 		WooThemes
+ * @package 	WooCommerce/Templates/Emails
+ * @version     2.5.0
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+/**
+ * @hooked WC_Emails::email_header() Output the email header
+ */
+do_action( 'woocommerce_email_header', $email_heading, $email ); ?>
+
+<p><?php _e( "Your order is on-hold until we confirm payment has been received. Your order details are shown below for your reference:", 'woocommerce' ); ?></p>
+
+<?php
+
+/**
+ * @hooked WC_Emails::order_details() Shows the order details table.
+ * @since 2.5.0
+ */
+do_action( 'woocommerce_email_order_details', $order, $sent_to_admin, $plain_text, $email );
+
+/**
+ * @hooked WC_Emails::order_meta() Shows order meta data.
+ */
+do_action( 'woocommerce_email_order_meta', $order, $sent_to_admin, $plain_text, $email );
+
+/**
+ * @hooked WC_Emails::customer_details() Shows customer details
+ * @hooked WC_Emails::email_address() Shows email address
+ */
+do_action( 'woocommerce_email_customer_details', $order, $sent_to_admin, $plain_text, $email );
+
+/**
+ * @hooked WC_Emails::email_footer() Output the email footer
+ */
+do_action( 'woocommerce_email_footer', $email );
diff --git a/templates/emails/plain/customer-on-hold-order.php b/templates/emails/plain/customer-on-hold-order.php
new file mode 100644
index 00000000000..98af7a19328
--- /dev/null
+++ b/templates/emails/plain/customer-on-hold-order.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ * Customer on-hold order email
+ *
+ * This template can be overridden by copying it to yourtheme/woocommerce/emails/plain/customer-processing-order.php.
+ *
+ * HOWEVER, on occasion WooCommerce will need to update template files and you (the theme developer).
+ * will need to copy the new files to your theme to maintain compatibility. We try to do this.
+ * as little as possible, but it does happen. When this occurs the version of the template file will.
+ * be bumped and the readme will list any important changes.
+ *
+ * @see 	    http://docs.woothemes.com/document/template-structure/
+ * @author		WooThemes
+ * @package 	WooCommerce/Templates/Emails/Plain
+ * @version		2.5.0
+ */
+
+if ( ! defined( 'ABSPATH' ) ) {
+	exit;
+}
+
+echo "= " . $email_heading . " =\n\n";
+
+echo __( "Your order is on-hold until we confirm payment has been received. Your order details are shown below for your reference:", 'woocommerce' ) . "\n\n";
+
+echo "=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\n\n";
+
+/**
+ * @hooked WC_Emails::order_details() Shows the order details table.
+ * @since 2.5.0
+ */
+do_action( 'woocommerce_email_order_details', $order, $sent_to_admin, $plain_text, $email );
+
+echo "\n=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\n\n";
+
+/**
+ * @hooked WC_Emails::order_meta() Shows order meta data.
+ */
+do_action( 'woocommerce_email_order_meta', $order, $sent_to_admin, $plain_text, $email );
+
+/**
+ * @hooked WC_Emails::customer_details() Shows customer details
+ * @hooked WC_Emails::email_address() Shows email address
+ */
+do_action( 'woocommerce_email_customer_details', $order, $sent_to_admin, $plain_text, $email );
+
+echo "\n=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=\n\n";
+
+echo apply_filters( 'woocommerce_email_footer_text', get_option( 'woocommerce_email_footer_text' ) );