PHP Class WC_Email_Customer_Refunded_Order

Order refunded emails are sent to the customer when the order is marked refunded.
Author: WooThemes
Inheritance: extends WC_Email
Exibir arquivo Open project: woocommerce/woocommerce

Public Properties

Property Type Description
$partial_refund boolean Is the order partial refunded?
$refund WC_Order | boolean Refund order.

Public Methods

Method Description
__construct ( ) Constructor.
get_content_html ( ) : string Get content html.
get_content_plain ( ) : string Get content plain.
get_heading ( ) : string Get email heading.
get_subject ( ) : string Get email subject.
init_form_fields ( ) Initialise settings form fields.
set_email_strings ( boolean $partial_refund = false ) Set email strings.
trigger ( integer $order_id, boolean $partial_refund = false, integer $refund_id = null ) Trigger.
trigger_full ( integer $order_id, integer $refund_id = null ) Full refund notification.
trigger_partial ( integer $order_id, integer $refund_id = null ) Partial refund notification.

Method Details

__construct() public method

Constructor.
public __construct ( )

get_content_html() public method

Get content html.
public get_content_html ( ) : string
return string

get_content_plain() public method

Get content plain.
public get_content_plain ( ) : string
return string

get_heading() public method

Get email heading.
public get_heading ( ) : string
return string

get_subject() public method

Get email subject.
public get_subject ( ) : string
return string

init_form_fields() public method

Initialise settings form fields.
public init_form_fields ( )

set_email_strings() public method

Set email strings.
public set_email_strings ( boolean $partial_refund = false )
$partial_refund boolean

trigger() public method

Trigger.
public trigger ( integer $order_id, boolean $partial_refund = false, integer $refund_id = null )
$order_id integer
$partial_refund boolean
$refund_id integer

trigger_full() public method

Full refund notification.
public trigger_full ( integer $order_id, integer $refund_id = null )
$order_id integer
$refund_id integer

trigger_partial() public method

Partial refund notification.
public trigger_partial ( integer $order_id, integer $refund_id = null )
$order_id integer
$refund_id integer

Property Details

$partial_refund public_oe property

Is the order partial refunded?
public bool $partial_refund
return boolean

$refund public_oe property

Refund order.
public WC_Order|bool $refund
return WC_Order | boolean