...
$result
(boolean) Whether the transaction was successful
Email hooks
wc_maileon_email_hooks
Description
wc_maileon_email_hooks is a filter applied to replaced WooCommerce emails. It can be used to override custom email types.
Parameters
$wc_email_hooks
(array) The defined email hooks.
$wc_email_hooks is an array of email classes for the plugin to override. The default definition is the following:
| Code Block | ||
|---|---|---|
| ||
$wc_email_hooks = [
\WC_Email_Customer_Completed_Order::class => [
'actions' => [
'woocommerce_order_status_completed_notification' => ['WC_Email_Customer_Completed_Order()', 'trigger', 10, 2]
],
'class' => Maileon\WooCommerce\Emails\CompletedOrder::class,
],
\WC_Email_Customer_On_Hold_Order::class => [
'actions' => [
'woocommerce_order_status_pending_to_on-hold_notification' => ['WC_Email_Customer_On_Hold_Order()', 'trigger', 10, 2],
'woocommerce_order_status_failed_to_on-hold_notification' => ['WC_Email_Customer_On_Hold_Order()', 'trigger', 10, 2],
'woocommerce_order_status_cancelled_to_on-hold_notification' => ['WC_Email_Customer_On_Hold_Order()', 'trigger', 10, 2]
],
'class' => Maileon\WooCommerce\Emails\OnHoldOrder::class,
],
\WC_Email_Customer_Processing_Order::class => [
'actions' => [
'woocommerce_order_status_cancelled_to_processing_notification' => ['WC_Email_Customer_Processing_Order()', 'trigger', 10, 2],
'woocommerce_order_status_failed_to_processing_notification' => ['WC_Email_Customer_Processing_Order()', 'trigger', 10, 2],
'woocommerce_order_status_on-hold_to_processing_notification' => ['WC_Email_Customer_Processing_Order()', 'trigger', 10, 2],
'woocommerce_order_status_pending_to_processing_notification' => ['WC_Email_Customer_Processing_Order()', 'trigger', 10, 2],
],
'class' => Maileon\WooCommerce\Emails\ProcessingOrder::class,
],
\WC_Email_Customer_Refunded_Order::class => [
'actions' => [
'woocommerce_order_fully_refunded_notification' => ['WC_Email_Customer_Refunded_Order()', 'trigger_full', 10, 2],
'woocommerce_order_partially_refunded_notification' => ['WC_Email_Customer_Refunded_Order()', 'trigger_partial', 10, 2]
],
'class' => Maileon\WooCommerce\Emails\RefundedOrder::class,
]
] |
See Sample Extension for an usage example.
Transaction Filters
wc_maileon_transaction_name
Description
wc_maileon_transaction_name is a filter applied to all Maileon transaction names.
Parameters
$transaction_name
(string) The transaction name
wc_maileon_transaction_archiving_duration
Description
wc_maileon_transaction_archiving_duration is a filter applied to all Maileon transaction archiving durations.
Parameters
$duration
(integer) The transaction archiving duration in days. Defaults to 365
wc_maileon_transaction_{$transaction_name}_archiving_duration
Description
wc_maileon_transaction_archiving_duration is a filter applied to all Maileon transaction archiving durations. It can be used to modify the transaction archiving duration for transaction types created by the plugin. $transaction_name is one of the following by default:
wc_completed_orderwc_on_hold_orderwc_processing_orderwc_refunded_order
Parameters
$duration
(integer) The transaction archiving duration in days. Defaults to 365
wc_maileon_transaction_attributes
Description
wc_maileon_transaction_attributes is a filter applied to all Maileon transaction attributes.
Parameters
$transaction_attributes
(Maileon\Transactions\AttributeType[]) The transaction attributes
wc_maileon_transaction_{$transaction_name}_attributes
Description
wc_maileon_transaction_{$transaction_name}_attributes is a filter applied to all Maileon transaction attribute definitions. It can be used to modify the transaction types created by the plugin. $transaction_name is one of the following by default:
wc_completed_orderwc_on_hold_orderwc_processing_orderwc_refunded_order
Parameters
$transaction_attributes
(Maileon\Transactions\AttributeType[]) The transaction type attributes
wc_maileon_transaction_map_order_products
Description
wc_maileon_transaction_map_order_products is applied to product lines.
Parameters
$content
(array) The mapped attributes
...
wc_maileon_transaction_map_order_product_item
Description
wc_maileon_transaction_map_order_product_item is applied to a single product line item.
Parameters
$content
(array) The mapped attributes
...
wc_maileon_transaction_map_order_fees
Description
wc_maileon_transaction_map_order_fees is applied to fees and shipping lines.
Parameters
$content
(array) The mapped attributes
...
wc_maileon_transaction_map_order_fee_shipping_item
Description
wc_maileon_transaction_map_order_fee_shipping_item is applied to a single shipping line item.
Parameters
$content
(array) The mapped attributes
...
wc_maileon_transaction_map_order_fee_item
Description
wc_maileon_transaction_map_order_fee_item is applied to a single fee line item.
Parameters
$content
(array) The mapped attributes
...
wc_maileon_transaction_map_order_discounts
Description
wc_maileon_transaction_map_order_discounts is applied to coupon lines.
Parameters
$content
(array) The mapped attributes
...
wc_maileon_transaction_map_order_discount_item
Description
wc_maileon_transaction_map_order_discount_item is applied to a single coupon line item.
Parameters
$content
(array) The mapped attributes
...
wc_maileon_transaction_{$transaction_name}_content
Description
wc_maileon_transaction_{$transaction_name}_content is a filter applied to every Maileon transaction’s content. $transaction_name is one of the following by default:
...