WC_Email_Customer_Note{}WC 1.0

Customer Note Order Email.

Customer note emails are sent when you add a note to an order.

No Hooks.

Usage

$WC_Email_Customer_Note = new WC_Email_Customer_Note();
// use class methods

Methods

  1. public __construct()
  2. public get_content_html()
  3. public get_content_plain()
  4. public get_default_additional_content()
  5. public get_default_heading()
  6. public get_default_subject()
  7. public trigger( $args )

Notes

  • Package: WooCommerce\Classes\Emails

WC_Email_Customer_Note{} code WC 8.7.0

class WC_Email_Customer_Note extends WC_Email {

	/**
	 * Customer note.
	 *
	 * @var string
	 */
	public $customer_note;

	/**
	 * Constructor.
	 */
	public function __construct() {
		$this->id             = 'customer_note';
		$this->customer_email = true;
		$this->title          = __( 'Customer note', 'woocommerce' );
		$this->description    = __( 'Customer note emails are sent when you add a note to an order.', 'woocommerce' );
		$this->template_html  = 'emails/customer-note.php';
		$this->template_plain = 'emails/plain/customer-note.php';
		$this->placeholders   = array(
			'{order_date}'   => '',
			'{order_number}' => '',
		);

		// Triggers.
		add_action( 'woocommerce_new_customer_note_notification', array( $this, 'trigger' ) );

		// Call parent constructor.
		parent::__construct();
	}

	/**
	 * Get email subject.
	 *
	 * @since  3.1.0
	 * @return string
	 */
	public function get_default_subject() {
		return __( 'Note added to your {site_title} order from {order_date}', 'woocommerce' );
	}

	/**
	 * Get email heading.
	 *
	 * @since  3.1.0
	 * @return string
	 */
	public function get_default_heading() {
		return __( 'A note has been added to your order', 'woocommerce' );
	}

	/**
	 * Trigger.
	 *
	 * @param array $args Email arguments.
	 */
	public function trigger( $args ) {
		$this->setup_locale();

		if ( ! empty( $args ) ) {
			$defaults = array(
				'order_id'      => '',
				'customer_note' => '',
			);

			$args = wp_parse_args( $args, $defaults );

			$order_id      = $args['order_id'];
			$customer_note = $args['customer_note'];

			if ( $order_id ) {
				$this->object = wc_get_order( $order_id );

				if ( $this->object ) {
					$this->recipient                      = $this->object->get_billing_email();
					$this->customer_note                  = $customer_note;
					$this->placeholders['{order_date}']   = wc_format_datetime( $this->object->get_date_created() );
					$this->placeholders['{order_number}'] = $this->object->get_order_number();
				}
			}
		}

		if ( $this->is_enabled() && $this->get_recipient() ) {
			$this->send( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
		}

		$this->restore_locale();
	}

	/**
	 * Get content html.
	 *
	 * @return string
	 */
	public function get_content_html() {
		return wc_get_template_html(
			$this->template_html,
			array(
				'order'              => $this->object,
				'email_heading'      => $this->get_heading(),
				'additional_content' => $this->get_additional_content(),
				'customer_note'      => $this->customer_note,
				'sent_to_admin'      => false,
				'plain_text'         => false,
				'email'              => $this,
			)
		);
	}

	/**
	 * Get content plain.
	 *
	 * @return string
	 */
	public function get_content_plain() {
		return wc_get_template_html(
			$this->template_plain,
			array(
				'order'              => $this->object,
				'email_heading'      => $this->get_heading(),
				'additional_content' => $this->get_additional_content(),
				'customer_note'      => $this->customer_note,
				'sent_to_admin'      => false,
				'plain_text'         => true,
				'email'              => $this,
			)
		);
	}

	/**
	 * Default content to show below main email content.
	 *
	 * @since 3.7.0
	 * @return string
	 */
	public function get_default_additional_content() {
		return __( 'Thanks for reading.', 'woocommerce' );
	}
}