WC_Emails::order_schema_markup() - Code Metrics - Inspection of "Improved Structured Data" - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#11455)

unknown

created 2016-08-12 21:55 UTC

WC_Emails::order_schema_markup() A

↳ Parent: WC_Emails

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
cc	1
eloc	4
c	3
b	1
f	0
nc	1
nop	3
dl	0
loc	6
rs	9.4285

<?php

if ( ! defined( 'ABSPATH' ) ) {
	exit; // Exit if accessed directly
}

/**
 * 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.3.0
 * @package		WooCommerce/Classes/Emails
 * @category	Class
 * @author 		WooThemes
 */
class WC_Emails {

	/** @var array Array of email notification classes */
	public $emails;

	/** @var WC_Emails The single instance of the class */
	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' );
	}

	/**
	 * Hook in all transactional emails.
	 */
	public static function init_transactional_emails() {
		$email_actions = apply_filters( 'woocommerce_email_actions', array(
			'woocommerce_low_stock',
			'woocommerce_no_stock',
			'woocommerce_product_on_backorder',
			'woocommerce_order_status_pending_to_processing',
			'woocommerce_order_status_pending_to_completed',
			'woocommerce_order_status_pending_to_cancelled',
			'woocommerce_order_status_pending_to_failed',
			'woocommerce_order_status_pending_to_on-hold',
			'woocommerce_order_status_failed_to_processing',
			'woocommerce_order_status_failed_to_completed',
			'woocommerce_order_status_failed_to_on-hold',
			'woocommerce_order_status_on-hold_to_processing',
			'woocommerce_order_status_on-hold_to_cancelled',
			'woocommerce_order_status_on-hold_to_failed',
			'woocommerce_order_status_completed',
			'woocommerce_order_fully_refunded',
			'woocommerce_order_partially_refunded',
			'woocommerce_new_customer_note',
			'woocommerce_created_customer'
		) );

		foreach ( $email_actions as $action ) {
			add_action( $action, array( __CLASS__, 'send_transactional_email' ), 10, 10 );
		}
	}

	/**
	 * Init the mailer instance and call the notifications for the current filter.
	 * @internal param array $args (default: array())
	 */
	public static function send_transactional_email() {
		$args = func_get_args();
		self::instance();
		do_action_ref_array( current_filter() . '_notification', $args );
	}

	/**
	 * 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_details', array( $this, 'order_details' ), 10, 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 ) );
		}
	}

	/**
	 * 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->get_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 '<p><strong>' . $field['label'] . ':</strong> ' . $field['value'] . '</p>';
					}
				}
			}
		}
	}

	/**
	 * 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->get_customer_note() ) {
			$fields['customer_note'] = array(
				'label' => __( 'Note', 'woocommerce' ),
				'value' => wptexturize( $order->get_customer_note() )
			);
		}

		if ( $order->get_billing_email() ) {
			$fields['billing_email'] = array(
				'label' => __( 'Email', 'woocommerce' ),
				'value' => wptexturize( $order->get_billing_email() )
			);
	    }

	    if ( $order->get_billing_phone() ) {
			$fields['billing_phone'] = array(
				'label' => __( 'Tel', 'woocommerce' ),
				'value' => wptexturize( $order->get_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 )
		);
	}

	/**
	 * Adds Schema.org markup for order in JSON-LD format.
	 *
	 * @deprecated 2.7.0
	 * @see WC_Structured_Data::generate_email_order_data()
	 *
	 * @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 ) {
		_deprecated_function( 'WC_Emails::order_schema_markup', '2.7', 'WC_Structured_Data::generate_email_order_data' );

		WC()->structured_data->generate_email_order_data( $order, $sent_to_admin, $plain_text );
		WC()->structured_data->enqueue_data( array( 'Order' ) );
	}
}


1			<?php
2
3			if ( ! defined( 'ABSPATH' ) ) {
4			exit; // Exit if accessed directly
5			}
6
7			/**
8			* Transactional Emails Controller
9			*
10			* WooCommerce Emails Class which handles the sending on transactional emails and email templates. This class loads in available emails.
11			*
12			* @class WC_Emails
13			* @version 2.3.0
14			* @package WooCommerce/Classes/Emails
15			* @category Class
16			* @author WooThemes
17			*/
18			class WC_Emails {
19
20			/** @var array Array of email notification classes */
21			public $emails;
22
23			/** @var WC_Emails The single instance of the class */
24			protected static $_instance = null;
25
26			/**
27			* Main WC_Emails Instance.
28			*
29			* Ensures only one instance of WC_Emails is loaded or can be loaded.
30			*
31			* @since 2.1
32			* @static
33			* @return WC_Emails Main instance
34			*/
35			public static function instance() {
36			if ( is_null( self::$_instance ) ) {
37			self::$_instance = new self();
38			}
39			return self::$_instance;
40			}
41
42			/**
43			* Cloning is forbidden.
44			*
45			* @since 2.1
46			*/
47			public function __clone() {
48			_doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'woocommerce' ), '2.1' );
49			}
50
51			/**
52			* Unserializing instances of this class is forbidden.
53			*
54			* @since 2.1
55			*/
56			public function __wakeup() {
57			_doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'woocommerce' ), '2.1' );
58			}
59
60			/**
61			* Hook in all transactional emails.
62			*/
63			public static function init_transactional_emails() {
64			$email_actions = apply_filters( 'woocommerce_email_actions', array(
65			'woocommerce_low_stock',
66			'woocommerce_no_stock',
67			'woocommerce_product_on_backorder',
68			'woocommerce_order_status_pending_to_processing',
69			'woocommerce_order_status_pending_to_completed',
70			'woocommerce_order_status_pending_to_cancelled',
71			'woocommerce_order_status_pending_to_failed',
72			'woocommerce_order_status_pending_to_on-hold',
73			'woocommerce_order_status_failed_to_processing',
74			'woocommerce_order_status_failed_to_completed',
75			'woocommerce_order_status_failed_to_on-hold',
76			'woocommerce_order_status_on-hold_to_processing',
77			'woocommerce_order_status_on-hold_to_cancelled',
78			'woocommerce_order_status_on-hold_to_failed',
79			'woocommerce_order_status_completed',
80			'woocommerce_order_fully_refunded',
81			'woocommerce_order_partially_refunded',
82			'woocommerce_new_customer_note',
83			'woocommerce_created_customer'
84			) );
85
86			foreach ( $email_actions as $action ) {
87			add_action( $action, array( __CLASS__, 'send_transactional_email' ), 10, 10 );
88			}
89			}
90
91			/**
92			* Init the mailer instance and call the notifications for the current filter.
93			* @internal param array $args (default: array())
94			*/
95			public static function send_transactional_email() {
96			$args = func_get_args();
97			self::instance();
98			do_action_ref_array( current_filter() . '_notification', $args );
99			}
100
101			/**
102			* Constructor for the email class hooks in all emails that can be sent.
103			*
104			*/
105			public function __construct() {
106			$this->init();
107
108			// Email Header, Footer and content hooks
109			add_action( 'woocommerce_email_header', array( $this, 'email_header' ) );
110			add_action( 'woocommerce_email_footer', array( $this, 'email_footer' ) );
111			add_action( 'woocommerce_email_order_details', array( $this, 'order_details' ), 10, 4 );
112			add_action( 'woocommerce_email_order_meta', array( $this, 'order_meta' ), 10, 3 );
113			add_action( 'woocommerce_email_customer_details', array( $this, 'customer_details' ), 10, 3 );
114			add_action( 'woocommerce_email_customer_details', array( $this, 'email_addresses' ), 20, 3 );
115
116			// Hooks for sending emails during store events
117			add_action( 'woocommerce_low_stock_notification', array( $this, 'low_stock' ) );
118			add_action( 'woocommerce_no_stock_notification', array( $this, 'no_stock' ) );
119			add_action( 'woocommerce_product_on_backorder_notification', array( $this, 'backorder' ) );
120			add_action( 'woocommerce_created_customer_notification', array( $this, 'customer_new_account' ), 10, 3 );
121
122			// Let 3rd parties unhook the above via this hook
123			do_action( 'woocommerce_email', $this );
124			}
125
126			/**
127			* Init email classes.
128			*/
129			public function init() {
130			// Include email classes
131			include_once( dirname( __FILE__ ) . '/emails/class-wc-email.php' );
132
133			$this->emails['WC_Email_New_Order'] = include( 'emails/class-wc-email-new-order.php' );
134			$this->emails['WC_Email_Cancelled_Order'] = include( 'emails/class-wc-email-cancelled-order.php' );
135			$this->emails['WC_Email_Failed_Order'] = include( 'emails/class-wc-email-failed-order.php' );
136			$this->emails['WC_Email_Customer_On_Hold_Order'] = include( 'emails/class-wc-email-customer-on-hold-order.php' );
137			$this->emails['WC_Email_Customer_Processing_Order'] = include( 'emails/class-wc-email-customer-processing-order.php' );
138			$this->emails['WC_Email_Customer_Completed_Order'] = include( 'emails/class-wc-email-customer-completed-order.php' );
139			$this->emails['WC_Email_Customer_Refunded_Order'] = include( 'emails/class-wc-email-customer-refunded-order.php' );
140			$this->emails['WC_Email_Customer_Invoice'] = include( 'emails/class-wc-email-customer-invoice.php' );
141			$this->emails['WC_Email_Customer_Note'] = include( 'emails/class-wc-email-customer-note.php' );
142			$this->emails['WC_Email_Customer_Reset_Password'] = include( 'emails/class-wc-email-customer-reset-password.php' );
143			$this->emails['WC_Email_Customer_New_Account'] = include( 'emails/class-wc-email-customer-new-account.php' );
144
145			$this->emails = apply_filters( 'woocommerce_email_classes', $this->emails );
146
147			// include css inliner
148			if ( ! class_exists( 'Emogrifier' ) && class_exists( 'DOMDocument' ) ) {
149			include_once( dirname( __FILE__ ) . '/libraries/class-emogrifier.php' );
150			}
151			}
152
153			/**
154			* Return the email classes - used in admin to load settings.
155			*
156			* @return array
157			*/
158			public function get_emails() {
159			return $this->emails;
160			}
161
162			/**
163			* Get from name for email.
164			*
165			* @return string
166			*/
167			public function get_from_name() {
168			return wp_specialchars_decode( get_option( 'woocommerce_email_from_name' ), ENT_QUOTES );
169			}
170
171			/**
172			* Get from email address.
173			*
174			* @return string
175			*/
176			public function get_from_address() {
177			return sanitize_email( get_option( 'woocommerce_email_from_address' ) );
178			}
179
180			/**
181			* Get the email header.
182			*
183			* @param mixed $email_heading heading for the email
184			*/
185			public function email_header( $email_heading ) {
186			wc_get_template( 'emails/email-header.php', array( 'email_heading' => $email_heading ) );
187			}
188
189			/**
190			* Get the email footer.
191			*/
192			public function email_footer() {
193			wc_get_template( 'emails/email-footer.php' );
194			}
195
196			/**
197			* Wraps a message in the woocommerce mail template.
198			*
199			* @param mixed $email_heading
200			* @param string $message
201			* @return string
202			*/
203			public function wrap_message( $email_heading, $message, $plain_text = false ) {
			0 ignored issues – show Unused Code introduced 2015-11-21 02:57 UTC by Report Bug Copy Issue Report The parameter `$plain_text` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
204			// Buffer
205			ob_start();
206
207			do_action( 'woocommerce_email_header', $email_heading );
208
209			echo wpautop( wptexturize( $message ) );
210
211			do_action( 'woocommerce_email_footer' );
212
213			// Get contents
214			$message = ob_get_clean();
215
216			return $message;
217			}
218
219			/**
220			* Send the email.
221			*
222			* @param mixed $to
223			* @param mixed $subject
224			* @param mixed $message
225			* @param string $headers (default: "Content-Type: text/html\r\n")
226			* @param string $attachments (default: "")
227			* @return bool
228			*/
229			public function send( $to, $subject, $message, $headers = "Content-Type: text/html\r\n", $attachments = "" ) {
230			// Send
231			$email = new WC_Email();
232			return $email->send( $to, $subject, $message, $headers, $attachments );
233			}
234
235			/**
236			* Prepare and send the customer invoice email on demand.
237			*/
238			public function customer_invoice( $order ) {
239			$email = $this->emails['WC_Email_Customer_Invoice'];
240			$email->trigger( $order );
241			}
242
243			/**
244			* Customer new account welcome email.
245			*
246			* @param int $customer_id
247			* @param array $new_customer_data
248			*/
249			public function customer_new_account( $customer_id, $new_customer_data = array(), $password_generated = false ) {
250			if ( ! $customer_id ) {
251			return;
252			}
253
254			$user_pass = ! empty( $new_customer_data['user_pass'] ) ? $new_customer_data['user_pass'] : '';
255
256			$email = $this->emails['WC_Email_Customer_New_Account'];
257			$email->trigger( $customer_id, $user_pass, $password_generated );
258			}
259
260			/**
261			* Show the order details table
262			*/
263			public function order_details( $order, $sent_to_admin = false, $plain_text = false, $email = '' ) {
264			if ( $plain_text ) {
265			wc_get_template( 'emails/plain/email-order-details.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin, 'plain_text' => $plain_text, 'email' => $email ) );
266			} else {
267			wc_get_template( 'emails/email-order-details.php', array( 'order' => $order, 'sent_to_admin' => $sent_to_admin, 'plain_text' => $plain_text, 'email' => $email ) );
268			}
269			}
270
271			/**
272			* Add order meta to email templates.
273			*
274			* @param mixed $order
275			* @param bool $sent_to_admin (default: false)
276			* @param bool $plain_text (default: false)
277			* @return string
278			*/
279			public function order_meta( $order, $sent_to_admin = false, $plain_text = false ) {
280			$fields = apply_filters( 'woocommerce_email_order_meta_fields', array(), $sent_to_admin, $order );
281
282			/**
283			* Deprecated woocommerce_email_order_meta_keys filter.
284			*
285			* @since 2.3.0
286			*/
287			$_fields = apply_filters( 'woocommerce_email_order_meta_keys', array(), $sent_to_admin );
288
289			if ( $_fields ) {
290			foreach ( $_fields as $key => $field ) {
291			if ( is_numeric( $key ) ) {
292			$key = $field;
293			}
294
295			$fields[ $key ] = array(
296			'label' => wptexturize( $key ),
297			'value' => wptexturize( get_post_meta( $order->get_id(), $field, true ) )
298			);
299			}
300			}
301
302			if ( $fields ) {
303
304			if ( $plain_text ) {
305
306			foreach ( $fields as $field ) {
307			if ( isset( $field['label'] ) && isset( $field['value'] ) && $field['value'] ) {
308			echo $field['label'] . ': ' . $field['value'] . "\n";
309			}
310			}
311
312			} else {
313
314			foreach ( $fields as $field ) {
315			if ( isset( $field['label'] ) && isset( $field['value'] ) && $field['value'] ) {
316			echo '<p><strong>' . $field['label'] . ':</strong> ' . $field['value'] . '</p>';
317			}
318			}
319			}
320			}
321			}
322
323			/**
324			* Is customer detail field valid?
325			* @param array $field
326			* @return boolean
327			*/
328			public function customer_detail_field_is_valid( $field ) {
329			return isset( $field['label'] ) && ! empty( $field['value'] );
330			}
331
332			/**
333			* Add customer details to email templates.
334			*
335			* @param mixed $order
336			* @param bool $sent_to_admin (default: false)
337			* @param bool $plain_text (default: false)
338			* @return string
339			*/
340			public function customer_details( $order, $sent_to_admin = false, $plain_text = false ) {
341			$fields = array();
342
343			if ( $order->get_customer_note() ) {
344			$fields['customer_note'] = array(
345			'label' => __( 'Note', 'woocommerce' ),
346			'value' => wptexturize( $order->get_customer_note() )
347			);
348			}
349
350			if ( $order->get_billing_email() ) {
351			$fields['billing_email'] = array(
352			'label' => __( 'Email', 'woocommerce' ),
353			'value' => wptexturize( $order->get_billing_email() )
354			);
355			}
356
357			if ( $order->get_billing_phone() ) {
358			$fields['billing_phone'] = array(
359			'label' => __( 'Tel', 'woocommerce' ),
360			'value' => wptexturize( $order->get_billing_phone() )
361			);
362			}
363
364			$fields = array_filter( apply_filters( 'woocommerce_email_customer_details_fields', $fields, $sent_to_admin, $order ), array( $this, 'customer_detail_field_is_valid' ) );
365
366			if ( $plain_text ) {
367			wc_get_template( 'emails/plain/email-customer-details.php', array( 'fields' => $fields ) );
368			} else {
369			wc_get_template( 'emails/email-customer-details.php', array( 'fields' => $fields ) );
370			}
371			}
372
373			/**
374			* Get the email addresses.
375			*/
376			public function email_addresses( $order, $sent_to_admin = false, $plain_text = false ) {
377			if ( $plain_text ) {
378			wc_get_template( 'emails/plain/email-addresses.php', array( 'order' => $order ) );
379			} else {
380			wc_get_template( 'emails/email-addresses.php', array( 'order' => $order ) );
381			}
382			}
383
384			/**
385			* Get blog name formatted for emails.
386			* @return string
387			*/
388			private function get_blogname() {
389			return wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
390			}
391
392			/**
393			* Low stock notification email.
394			*
395			* @param WC_Product $product
396			*/
397			public function low_stock( $product ) {
398			$subject = sprintf( '[%s] %s', $this->get_blogname(), __( 'Product low in stock', 'woocommerce' ) );
399			$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() ) ) );
400
401			wp_mail(
402			apply_filters( 'woocommerce_email_recipient_low_stock', get_option( 'woocommerce_stock_email_recipient' ), $product ),
403			apply_filters( 'woocommerce_email_subject_low_stock', $subject, $product ),
404			apply_filters( 'woocommerce_email_content_low_stock', $message, $product ),
405			apply_filters( 'woocommerce_email_headers', '', 'low_stock', $product ),
406			apply_filters( 'woocommerce_email_attachments', array(), 'low_stock', $product )
407			);
408			}
409
410			/**
411			* No stock notification email.
412			*
413			* @param WC_Product $product
414			*/
415			public function no_stock( $product ) {
416			$subject = sprintf( '[%s] %s', $this->get_blogname(), __( 'Product out of stock', 'woocommerce' ) );
417			$message = sprintf( __( '%s is out of stock.', 'woocommerce' ), html_entity_decode( strip_tags( $product->get_formatted_name() ), ENT_QUOTES, get_bloginfo( 'charset' ) ) );
418
419			wp_mail(
420			apply_filters( 'woocommerce_email_recipient_no_stock', get_option( 'woocommerce_stock_email_recipient' ), $product ),
421			apply_filters( 'woocommerce_email_subject_no_stock', $subject, $product ),
422			apply_filters( 'woocommerce_email_content_no_stock', $message, $product ),
423			apply_filters( 'woocommerce_email_headers', '', 'no_stock', $product ),
424			apply_filters( 'woocommerce_email_attachments', array(), 'no_stock', $product )
425			);
426			}
427
428			/**
429			* Backorder notification email.
430			*
431			* @param array $args
432			*/
433			public function backorder( $args ) {
434			$args = wp_parse_args( $args, array(
435			'product' => '',
436			'quantity' => '',
437			'order_id' => ''
438			) );
439
440			extract( $args );
441
442			if ( ! $product \|\| ! $quantity \|\| ! ( $order = wc_get_order( $order_id ) ) ) {
443			return;
444			}
445
446			$subject = sprintf( '[%s] %s', $this->get_blogname(), __( 'Product Backorder', 'woocommerce' ) );
447			$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() );
448
449			wp_mail(
450			apply_filters( 'woocommerce_email_recipient_backorder', get_option( 'woocommerce_stock_email_recipient' ), $args ),
451			apply_filters( 'woocommerce_email_subject_backorder', $subject, $args ),
452			apply_filters( 'woocommerce_email_content_backorder', $message, $args ),
453			apply_filters( 'woocommerce_email_headers', '', 'backorder', $args ),
454			apply_filters( 'woocommerce_email_attachments', array(), 'backorder', $args )
455			);
456			}
457
458			/**
459			* Adds Schema.org markup for order in JSON-LD format.
460			*
461			* @deprecated 2.7.0
462			* @see WC_Structured_Data::generate_email_order_data()
463			*
464			* @since 2.6.0
465			* @param mixed $order
466			* @param bool $sent_to_admin (default: false)
467			* @param bool $plain_text (default: false)
468			*/
469			public function order_schema_markup( $order, $sent_to_admin = false, $plain_text = false ) {
470			_deprecated_function( 'WC_Emails::order_schema_markup', '2.7', 'WC_Structured_Data::generate_email_order_data' );
471
472			WC()->structured_data->generate_email_order_data( $order, $sent_to_admin, $plain_text );
473			WC()->structured_data->enqueue_data( array( 'Order' ) );
474			}
475			}
476

woothemes / woocommerce

Pull Request — master (#11455)

WC_Emails::order_schema_markup() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like