WC_Email_Customer_Failed_Order{} │ WC 1.0
Customer failed Order Email.
Order failed emails are sent to the customer when their order are marked as failed.
No Hooks.
Usage
$WC_Email_Customer_Failed_Order = new WC_Email_Customer_Failed_Order();
// use class methods
Methods
- public __construct()
- public get_content_html()
- public get_content_plain()
- public get_default_additional_content()
- public get_default_heading()
- public get_default_subject()
- public trigger( $order_id, $order = false )
Notes
- Package: WooCommerce\Classes\Emails
WC_Email_Customer_Failed_Order{} WC Email Customer Failed Order{} code
WC 9.5.1
class WC_Email_Customer_Failed_Order extends WC_Email {
/**
* Constructor.
*/
public function __construct() {
$this->id = 'customer_failed_order';
$this->customer_email = true;
$this->title = __( 'Failed order', 'woocommerce' );
$this->description = __( 'Order failed emails are sent to customers when their orders are marked as failed.', 'woocommerce' );
$this->template_html = 'emails/customer-failed-order.php';
$this->template_plain = 'emails/plain/customer-failed-order.php';
$this->placeholders = array(
'{order_date}' => '',
'{order_number}' => '',
);
// Triggers for this email.
add_action( 'woocommerce_order_status_failed_notification', array( $this, 'trigger' ), 10, 2 );
// Call parent constructor.
parent::__construct();
}
/**
* Trigger the sending of this email.
*
* @param int $order_id The order ID.
* @param WC_Order|false $order Order object.
*/
public function trigger( $order_id, $order = false ) {
$this->setup_locale();
if ( $order_id && ! is_a( $order, 'WC_Order' ) ) {
$order = wc_get_order( $order_id );
}
if ( is_a( $order, 'WC_Order' ) ) {
$this->object = $order;
$this->recipient = $this->object->get_billing_email();
$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 email subject.
*
* @since 3.1.0
* @return string
*/
public function get_default_subject() {
return __( 'Your order at {site_title} was unsuccessful', 'woocommerce' );
}
/**
* Get email heading.
*
* @since 3.1.0
* @return string
*/
public function get_default_heading() {
return __( 'Sorry, your order was unsuccessful', 'woocommerce' );
}
/**
* 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(),
'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(),
'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 '';
}
}