Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

Users can sign up for Maileon newsletters by checking the checkbox on the checkout page. Users who haven’t checked this checkbox will also be created in Maileon, however they will not have any permissions. This is due to the fact that the user needs to exist in order for Maileon to send transactional emails.

The user creation process can be hooked into vie the wc_maileon_checkout_contact and wc_maileon_create_contact_params WordPress filter hooks.

Contact Creation

wc_maileon_update_contact_checkout

Description

wc_maileon_update_contact_checkout is a filter applied to a contact created on the checkout page.

Parameters

$contact
(Maileon\Contacts\Contact) (required) The contact to be filtered

$user_id
(integer) The ID of the user

$newsletter
(boolean) Whether the user opted in to recieve newsletters

$data
(array) The checkout data

wc_maileon_update_contact_registration

Description

wc_maileon_update_contact_registration is a filter applied to a contact created via the registration form.

Parameters

$contact
(Maileon\Contacts\Contact) (required) The contact to be filtered

$user_id
(integer) The ID of the user

$newsletter
(boolean) Whether the user opted in to recieve newsletters

$user_data
(array) The user data

wc_maileon_update_contact_account

wc_maileon_update_contact_account is a filter applied to an updated contact.

$contact
(Maileon\Contacts\Contact) (required) The contact to be filtered

$customer
(\WC_Customer) (required) The customer data

wc_maileon_unsubscribe_contact_reasons

wc_maileon_unsubscribe_contact_reasons is a filter applied to the unsubscription reasons supplied to Maileon.

$reasons
(array) (required) The unsusbcription reasons array

$user_id
(integer) (required) The unsubscrining customer

wc_maileon_create_contact_params

Description

wc_maileon_create_contact_params is a filter applied to any contact creation Maileon API calls. The hook receives an array of parameters that are passed to the Maileon API. The array contains the following elements:

Parameters

contact
(Maileon\Contacts\Contact) (required) The contact to be created

syncMode
(Maileon\Contacts\SynchronizationMode) The synchronization mode

src
(string) Subscription source

subscriptionPage
(string) Subscription page

doi
(boolean) Start doi process

doiPlus
(boolean) Enable doi plus

doiMailingKey
(string) The doi mailing key

Transactions

wc_maileon_transaction_name

Description

wc_maileon_transaction_name is a filter applied to all Maileon transaction names.

Parameters

$transaction_name
(string) (required) The transaction name

wc_maileon_get_{$transaction_name}_attributes

Description

wc_maileon_get_{$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_order

  • wc_on_hold_order

  • wc_processing_order

  • wc_refunded_order

Parameters

$transaction_attributes
(Maileon\Transactions\AttributeType[]) (required) The transaction type attributes

wc_maileon_map_order_item

Description

wc_maileon_map_order_item is a filter applied to each order_item in the order_items attribute in the default transaction mapping.

Parameters

$value
(array) (required) The mapped attributes

$item
(\WC_Order_Item) (required) The WooCommerce order item

wc_maileon_map_order_item_coupon

Description

wc_maileon_map_order_item_coupon is a filter applied to each coupon type order_item in the order_items attribute in the default transaction mapping.

Parameters

$value
(array) (required) The mapped attributes

$coupon
(\WC_Order_Item_Coupon) (required) The WooCommerce order item

wc_maileon_map_order_item_fee

Description

wc_maileon_map_order_item_fee is a filter applied to each fee type order_item in the order_items attribute in the default transaction mapping.

Parameters

$value
(array) (required) The mapped attributes

$fee
(\WC_Order_Item_Fee) (required) The WooCommerce order item

wc_maileon_map_order_item_product

Description

wc_maileon_map_order_item_product is a filter applied to each product type order_item in the order_items attribute in the default transaction mapping.

Parameters

$value
(array) (required) The mapped attributes

$product_item
(\WC_Order_Item_Product) (required) The WooCommerce order item

$product
(\WC_Product) (required) The WooCommerce product

wc_maileon_map_order_item_shipping

Description

wc_maileon_map_order_item_shipping is a filter applied to each shipping type order_item in the order_items attribute in the default transaction mapping.

Parameters

$value
(array) (required) The mapped attributes

$shipping
(\WC_Order_Item_Shipping) (required) The WooCommerce order item

  • No labels