WooCommerce Code Reference

WC_Email_Customer_Abandoned_Cart_Recovery extends WC_Email
in package

WooCommerce

Classes

Emails

Customer Abandoned Cart Recovery email.

A transactional email that prompts the customer to complete a checkout they left pending. The send is scheduled via Action Scheduler two hours after the pending order is created, gated on the merchant's automated setting. Merchants can also trigger the email manually from the order edit page.

ABANDONMENT_THRESHOLD_SECONDS

Minimum age (in seconds, from `date_created`) before an order is considered actually abandoned. Gives the customer a window to come back and complete the checkout on their own before merchants can nudge them.


    public
    mixed
    ABANDONMENT_THRESHOLD_SECONDS
    = HOUR_IN_SECONDS

AUTO_SEND_DELAY_SECONDS

Delay between order creation and the automated recovery send.


    public
    mixed
    AUTO_SEND_DELAY_SECONDS
    = 2 * HOUR_IN_SECONDS

Deliberately longer than ABANDONMENT_THRESHOLD_SECONDS so the auto-send never races the customer's own checkout retry. The shorter eligibility threshold still gates manual sends from the order edit page so merchants have an earlier window to intervene.

EMAIL_ID

Email identifier — kept in `$this->id` for the rest of WC_Email's machinery but also exposed as a constant so static methods (and external callers using the unsubscribe storage) can reference the same string without it drifting out of sync with the constructor.


    public
    mixed
    EMAIL_ID
    = 'customer_abandoned_cart_recovery'

KNOWN_RECOVERY_HANDLERS

Plugins known to provide their own abandoned cart recovery flow.


    public
    mixed
    KNOWN_RECOVERY_HANDLERS
    = array('automatewoo/automatewoo.php' => 'AutomateWoo', 'mailpoet/mailpoet.php' => 'MailPoet')

Detection is install-only.

MANUAL_RECOVERY_EMAIL_SEND_ACTION

Order action id used by the recovery email send item on the order edit page.


    public
    mixed
    MANUAL_RECOVERY_EMAIL_SEND_ACTION
    = AutomatticWooCommerceInternalAbandonedCartRecoveryManualSendHandler::MANUAL_SEND_ACTION

Re-exports ManualSendHandler::MANUAL_SEND_ACTION so external callers (and tests) can reference it from the email class. Source of truth lives on the dispatcher because its hook registration runs before this email class file is included.

META_KEY_SENT_AT

Order meta key recording the timestamp of the most recent send.


    public
    mixed
    META_KEY_SENT_AT
    = '_abandoned_cart_recovery_email_sent_at'

Written by trigger() after a successful dispatch (manual or automated) of the abandoned cart recovery email.

SKIP_REASON_NO_RECIPIENT

Skip-reason identifier used when the email has no recipient address.


    public
    mixed
    SKIP_REASON_NO_RECIPIENT
    = 'no_recipient'

ABANDONED_STATUSES

Order statuses that represent an abandoned checkout for the purposes of the manual-send action and the trigger-level status gate.


    private
    array<string|int, string>
    ABANDONED_STATUSES
    = array(AutomatticWooCommerceEnumsOrderStatus::PENDING, AutomatticWooCommerceEnumsOrderStatus::CHECKOUT_DRAFT)

pending — classic checkout reached "place order" but no payment yet.
checkout-draft — block checkout (Store API) parks the order here while the customer is mid-flow. May have no billing email yet, in which case trigger() no-ops.

Covers block checkout as well as classic. The automated scheduler is scoped to pending.

$bcc

Bcc recipients for the email.


    public
        string
    $bcc

$block_email_editor_enabled

Whether email block editor feature is enabled.


    public
        bool
    $block_email_editor_enabled

$cc

Cc recipients for the email.


    public
        string
    $cc

$description

Description for the email.


    public
        string
    $description

$email_group

Email group slug.


    public
        string
    $email_group
     = ''

$email_improvements_enabled

Whether email improvements feature is enabled.


    public
        bool
    $email_improvements_enabled

$email_type

E-mail type: plain, html or multipart.


    public
        string
    $email_type

$enabled

'yes' if the method is enabled.


    public
        string
    $enabled

$errors

Validation errors.


    public
        array<string|int, mixed>
    $errors
     = array()

$find

Strings to find in subjects/headings.


    public
        array<string|int, mixed>
    $find
     = array()

$form_fields

Form option fields.


    public
        array<string|int, mixed>
    $form_fields
     = array()

$heading

Default heading.


    public
        string
    $heading
     = ''

Supported for backwards compatibility but we recommend overloading the get_default_x methods instead so localization can be done when needed.

$id

ID of the class extending the settings API. Used in option names.


    public
        string
    $id
     = ''

$mime_boundary

Mime boundary (for multipart emails).


    public
        string
    $mime_boundary

$mime_boundary_header

Mime boundary header (for multipart emails).


    public
        string
    $mime_boundary_header

$object

Object this email is for, for example a customer, product, or email.


    public
        object|bool
    $object

$personalizer

Personalizer instance for converting Personalization tags.


    public
        TransactionalEmailPersonalizer
    $personalizer

$placeholders

Strings to find/replace in subjects/headings.


    public
        array<string|int, mixed>
    $placeholders
     = array()

$plain_replace

List of pattern replacements corresponding to patterns searched.


    public
        mixed
    $plain_replace
     = array(
    '',
    // Non-legal carriage return.
    ' ',
    // Non-breaking space.
    '"',
    // Double quotes.
    "'",
    // Single quotes.
    '>',
    // Greater-than.
    '<',
    // Less-than.
    '&',
    // Ampersand.
    '&',
    // Ampersand.
    '(c)',
    // Copyright.
    '(tm)',
    // Trademark.
    '(R)',
    // Registered.
    '--',
    // mdash.
    '-',
    // ndash.
    '*',
    // Bullet.
    '£',
    // Pound sign.
    'EUR',
    // Euro sign. € ?.
    '$',
    // Dollar sign.
    '',
    // Unknown/unhandled entities.
    ' ',
)

@var array $plain_replace

$plain_search

List of preg* regular expression patterns to search for, used in conjunction with $plain_replace.


    public
        array<string|int, mixed>
    $plain_search
     = array(
    "/
/",
    // Non-legal carriage return.
    '/&(nbsp|#0*160);/i',
    // Non-breaking space.
    '/&(quot|rdquo|ldquo|#0*8220|#0*8221|#0*147|#0*148);/i',
    // Double quotes.
    '/&(apos|rsquo|lsquo|#0*8216|#0*8217);/i',
    // Single quotes.
    '/&gt;/i',
    // Greater-than.
    '/&lt;/i',
    // Less-than.
    '/&#0*38;/i',
    // Ampersand.
    '/&amp;/i',
    // Ampersand.
    '/&(copy|#0*169);/i',
    // Copyright.
    '/&(trade|#0*8482|#0*153);/i',
    // Trademark.
    '/&(reg|#0*174);/i',
    // Registered.
    '/&(mdash|#0*151|#0*8212);/i',
    // mdash.
    '/&(ndash|minus|#0*8211|#0*8722);/i',
    // ndash.
    '/&(bull|#0*149|#0*8226);/i',
    // Bullet.
    '/&(pound|#0*163);/i',
    // Pound sign.
    '/&(euro|#0*8364);/i',
    // Euro sign.
    '/&(dollar|#0*36);/i',
    // Dollar sign.
    '/&[^&\s;]+;/i',
    // Unknown/unhandled entities.
    '/[ ]{2,}/',
)

https://raw.github.com/ushahidi/wp-silcc/master/class.html2text.inc

$plugin_id

The plugin ID. Used for option names.


    public
        string
    $plugin_id
     = 'woocommerce_'

$recipient

Recipients for the email.


    public
        string
    $recipient

$replace

Strings to replace in subjects/headings.


    public
        array<string|int, mixed>
    $replace
     = array()

$sending

True when email is being sent.


    public
        bool
    $sending

$settings

Setting values.


    public
        array<string|int, mixed>
    $settings
     = array()

$subject

Default subject.


    public
        string
    $subject
     = ''

Supported for backwards compatibility but we recommend overloading the get_default_x methods instead so localization can be done when needed.

$template_base

Template path.


    public
        string
    $template_base

$template_block

Initial email block template path.


    public
        string
    $template_block

$template_block_content

Block content template path.


    public
        string
    $template_block_content
     = 'emails/block/general-block-email.php'

$template_html

HTML template path.


    public
        string
    $template_html

$template_plain

Plain text template path.


    public
        string
    $template_plain

$title

Email method title.


    public
        string
    $title

$customer_email

True when the email notification is sent to customers.


    protected
        bool
    $customer_email
     = alse

$data

The posted settings data. When empty, $_POST data will be used.


    protected
        array<string|int, mixed>
    $data
     = array()

$manual

True when the email notification is sent manually only.


    protected
        bool
    $manual
     = alse

__construct()

Constructor.


    public
                __construct() : mixed

Return values

mixed —

add_error()

Add an error message for display in admin on save.


    public
                add_error(string $error) : mixed

Parameters

$error : string: Error message.

Return values

mixed —

admin_options()

Output the admin options table.


    public
                admin_options() : mixed

Return values

mixed —

display_errors()

Display admin error messages.


    public
                display_errors() : mixed

Return values

mixed —

format_settings()

Format settings if needed.


    public
                format_settings(array<string|int, mixed> $value) : array<string|int, mixed>

Parameters

$value : array<string|int, mixed>: Value to format.

Return values

array<string|int, mixed> —

format_string()

Format email string.


    public
                format_string(mixed $string) : string

Parameters

$string : mixed: Text to replace placeholders in.

Return values

string —

generate_checkbox_html()

Generate Checkbox HTML.


    public
                generate_checkbox_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_color_html()

Generate Color Picker Input HTML.


    public
                generate_color_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_decimal_html()

Generate Decimal Input HTML.


    public
                generate_decimal_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_multiselect_html()

Generate Multiselect HTML.


    public
                generate_multiselect_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_password_html()

Generate Password Input HTML.


    public
                generate_password_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_price_html()

Generate Price Input HTML.


    public
                generate_price_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_safe_text_html()

Generates HTML for the 'safe_text' input type (mostly used for gateway-related settings).


    public
                generate_safe_text_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_select_html()

Generate Select HTML.


    public
                generate_select_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_settings_html()

Generate Settings HTML.


    public
                generate_settings_html([array<string|int, mixed> $form_fields = array() ][, bool $echo = true ]) : string

Generate the HTML for the fields on the "settings" screen.

Parameters

$form_fields : array<string|int, mixed> = array(): (default: array()) Array of form fields.
$echo : bool = true: Echo or return.

Return values

string — the html for the settings

generate_text_html()

Generate Text Input HTML.


    public
                generate_text_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_textarea_html()

Generate Textarea HTML.


    public
                generate_textarea_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

generate_title_html()

Generate Title HTML.


    public
                generate_title_html(string $key, array<string|int, mixed> $data) : string

Parameters

$key : string: Field key.
$data : array<string|int, mixed>: Field data.

Return values

string —

get_active_recovery_handlers()

Currently-active known recovery handlers, keyed by plugin file path with the display name as value.


    public
            static    get_active_recovery_handlers() : array<string, string>

Return values

array<string, string> — Map of plugin file path → display name for plugins that are active.

get_additional_content()

Return content from the additional_content field.


    public
                get_additional_content() : string


    public
                get_content_type([string $default_content_type = '' ]) : string

Parameters

$default_content_type : string = '': Default wp_mail() content type.

Return values

string —

get_custom_attribute_html()

Get custom attributes.


    public
                get_custom_attribute_html(array<string|int, mixed> $data) : string

Parameters

$data : array<string|int, mixed>: Field data.

Return values

string —

get_default_additional_content()

Default content to show below main email content.


    public
                get_default_additional_content() : string

Return values

string —

get_default_heading()

Get default email heading.


    public
                get_default_heading() : string

Return values

string —

get_default_subject()

Get default email subject.


    public
                get_default_subject() : string

Return values

string —

get_description()

Return the email's description


    public
                get_description() : string

Return values

string —

get_description_html()

Get HTML for descriptions.


    public
                get_description_html(array<string|int, mixed> $data) : string

Parameters

$data : array<string|int, mixed>: Data for the description.

Return values

string —

get_email_group_title()

Get the title for the current email group.


    public
                get_email_group_title() : string

Return values

string — The email group title. Falls back to the email group slug if not found.

get_email_groups()

Get available email groups with their titles.


    public
                get_email_groups() : array<string|int, mixed>

Return values

array<string|int, mixed> — Associative array of email group slugs => titles.

get_email_type()

Return email type.


    public
                get_email_type() : string

Return values

string —

get_email_type_options()

Email type options.


    public
                get_email_type_options() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_errors()

Get admin error messages.


    public
                get_errors() : mixed

Return values

mixed —

get_field_default()

Get a fields default value. Defaults to "" if not set.


    public
                get_field_default(array<string|int, mixed> $field) : string

Parameters

$field : array<string|int, mixed>: Field array.

Return values

string —

get_field_key()

Prefix key for settings.


    public
                get_field_key(string $key) : string

Parameters

$key : string: Field key.

Return values

string —

get_field_type()

Get a fields type. Defaults to "text" if not set.


    public
                get_field_type(array<string|int, mixed> $field) : string

Parameters

$field : array<string|int, mixed>: Field array.

Return values

string —

get_field_value()

Get a field's posted and validated value.


    public
                get_field_value(string $key, array<string|int, mixed> $field[, array<string|int, mixed> $post_data = array() ]) : string

Parameters

$key : string: Field key.
$field : array<string|int, mixed>: Field array.
$post_data : array<string|int, mixed> = array(): Posted data.

Return values

string —

get_form_fields()

Get the form fields after they are initialized.


    public
                get_form_fields() : array<string|int, mixed>

Return values

array<string|int, mixed> — of options

get_from_address()

Get the from address for outgoing emails.


    public
                get_from_address([string $from_email = '' ]) : string

Parameters

$from_email : string = '': Default wp_mail() email address to send from.

Return values

string —

get_from_name()

Get the from name for outgoing emails.


    public
                get_from_name([string $from_name = '' ]) : string

Parameters

$from_name : string = '': Default wp_mail() name associated with the "from" email address.

Return values

string —

get_headers()

Get email headers.


    public
                get_headers() : string

Return values

string —

get_heading()

Get email heading.


    public
                get_heading() : string

Return values

string —

get_option()

Get option from DB.


    public
                get_option(string $key[, mixed $empty_value = null ]) : string

Gets an option from the settings API, using defaults if necessary to prevent undefined notices.

Parameters

$key : string: Option key.
$empty_value : mixed = null: Value when empty.

Return values

string — The value specified for the option or a default value for the option.

get_option_key()

Return the name of the option in the WP DB.


    public
                get_option_key() : string

Return values

string —

get_post_data()

Returns the POSTed data, to be used to save the settings.


    public
                get_post_data() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_preheader()

Get email preheader.


    public
                get_preheader() : string

Return values

string —

get_recipient()

Get valid recipients.


    public
                get_recipient() : string

Return values

string —

get_recovery_url()

Get the URL the recovery email should send the customer to.


    public
                get_recovery_url() : string

Returns the order's pay endpoint, which resumes the checkout for the pending order. A future iteration may swap this for a single-use signed URL with explicit expiry (see woocommerce_abandoned_cart_recovery_url filter).

Return values

string —

get_reply_to_address()

Get the reply-to address for outgoing emails.


    public
                get_reply_to_address([string $reply_to_email = '' ]) : string

Parameters

$reply_to_email : string = '': Default reply-to email address.

Return values

string —

get_reply_to_enabled()

Check if reply-to is enabled for outgoing emails.


    public
                get_reply_to_enabled() : bool

Return values

bool —

get_reply_to_name()

Get the reply-to name for outgoing emails.


    public
                get_reply_to_name([string $reply_to_name = '' ]) : string

Parameters

$reply_to_name : string = '': Default reply-to name.

Return values

string —

get_subject()

Get email subject.


    public
                get_subject() : string

Return values

string —

get_template()

Get template.


    public
                get_template(string $type) : string

Parameters

$type : string: Template type. Can be either 'template_html', 'template_plain' or 'template_block'.

Return values

string —

get_theme_template_file()

Get the template file in the current theme.


    public
                get_theme_template_file(string $template) : string

Parameters

$template : string: Template name.

Return values

string —

get_title()

Return the email's title


    public
                get_title() : string

Return values

string —

Get HTML for tooltips.


    public
                get_tooltip_html(array<string|int, mixed> $data) : string

Parameters

$data : array<string|int, mixed>: Data for the tooltip.

Return values

string —

get_unsubscribe_url()

Get the unsubscribe URL for the currently-bound order's recipient.


    public
                get_unsubscribe_url() : string

Returns an HMAC-signed URL routed through Endpoint::QUERY_VAR (?wc-email-unsubscribe=…) and handled by UnsubscribesEndpoint. Empty when no order is bound or the order has no billing email — both states mean there's no recipient to unsubscribe and the template should suppress the footer link.

Return values

string —

handle_multipart()

Handle multipart mail.


    public
                handle_multipart(PHPMailer $mailer) : PHPMailer

Parameters

$mailer : PHPMailer: PHPMailer object.

Return values

PHPMailer —

handle_recovery_email_send()

Handle a merchant-initiated send from the order edit page.


    public
                handle_recovery_email_send(WC_Order $order) : void

Fired by woocommerce_order_action_send_abandoned_cart_recovery_email after the order metabox save flow has validated the request. We re-check the capability and order status as defense in depth in case the hook is invoked from a non-metabox path.

Parameters

$order : WC_Order: The order whose customer should receive the email.

Return values

void —

init_form_fields()

Initialise settings form fields.


    public
                init_form_fields() : void

Adds an automated field on top of the standard WC_Email fields so merchants can choose between scheduled automatic sends and manual-only dispatch.

Return values

void —

init_settings()

Initialise Settings.


    public
                init_settings() : mixed

Store all settings in a single database entry and make sure the $settings array is either the default or the settings stored in the database.

Return values

mixed —

is_automated()

Whether the merchant has opted into automated scheduling.


    public
                is_automated() : bool


    public
            static    is_recipient_unsubscribed(string $email) : bool

Static so the gate can be reused from the trigger-side check, the dropdown gate, and any future auto-send scheduler — without each caller needing to thread the repository through.

Parameters

$email : string: Raw recipient email.

Return values

bool —

is_suppressed()

Whether the recovery email should be skipped.


    public
            static    is_suppressed() : bool

The merchant's own opt-out lives on the enabled toggle in Settings → Emails, which trigger() checks via is_enabled(). This method is the additional gate partner plugins (AutomateWoo, MailPoet, etc.) can hook into to short-circuit the send without touching the merchant's saved settings. Static so the manual-send handler and the scheduler can call it without instantiating the email class.

Return values

bool —

prevent_lazy_loading_on_attachment()

Prevent lazy loading on attachment images in email context by adding skip classes.


    public
                prevent_lazy_loading_on_attachment(array<string|int, mixed> $attributes) : array<string|int, mixed>

This is hooked into the wp_get_attachment_image_attributes filter.

Parameters

$attributes : array<string|int, mixed>: The image attributes array.

Return values

array<string|int, mixed> — The modified image attributes array.

process_admin_options()

Processes and saves options.


    public
                process_admin_options() : bool

If there is an error thrown, will continue to save and validate fields, but will leave the erroring field out.

Return values

bool — was anything saved?

register_order_action()

Add the manual-send item to the order actions dropdown.


    public
                register_order_action(array<string|int, mixed> $actions, WC_Order|null $order) : array<string|int, mixed>

Surfaced for the statuses listed in ABANDONED_STATUSES (pending + checkout-draft) so merchants can't accidentally email a "pick up where you left off" prompt to a customer whose order has already moved past abandonment. A capability check guards against role configurations that grant the order edit page to users without edit_shop_orders.

Parameters

$actions : array<string|int, mixed>: Existing order actions keyed by action id.
$order : WC_Order|null: Order being rendered, or null in contexts without one.

Return values

array<string|int, mixed> —

restore_locale()

Restore the locale to the default locale. Use after finished with setup_locale.


    public
                restore_locale() : mixed

Return values

mixed —

send()

Send an email.


    public
                send(string $to, string $subject, string $message, string $headers, array<string|int, mixed> $attachments) : bool

Parameters

$to : string: Email to.
$subject : string: Email subject.
$message : string: Email message.
$headers : string: Email headers.
$attachments : array<string|int, mixed>: Email attachments.

Return values

bool — success

set_object()

Set the object for the outgoing email.


    public
                set_object(object $object) : void

Parameters

$object : object: Object this email is for, e.g. customer, or product.

Return values

void —

set_post_data()

Sets the POSTed data. This method can be used to set specific data, instead of taking it from the $_POST array.


    public
                set_post_data([array<string|int, mixed> $data = array() ]) : mixed

Parameters

$data : array<string|int, mixed> = array(): Posted data.

Return values

mixed —

setup_locale()

Set the locale to the store locale for customer emails to make sure emails are in the store language.


    public
                setup_locale() : mixed

Return values

mixed —

style_inline()

Apply inline styles to dynamic content.


    public
                style_inline(string|null $content) : string

We only inline CSS for html emails.

Parameters

$content : string|null: Content that will receive inline styles.

Return values

string —

trigger()

Trigger the sending of this email.


    public
                trigger(int $order_id) : bool

Called by Scheduler::handle_scheduled_send() after Action Scheduler dispatches woocommerce_send_abandoned_cart_recovery_notification, and directly by the manual-send action on the order edit page.

Parameters

$order_id : int: The order ID.

Return values

bool — True when an email was dispatched in this call, false when any gate (suppression, disabled, ineligible, unsubscribed, dedup) or the underlying `send()` rejected the request.

update_option()

Update a single option.


    public
                update_option(string $key[, mixed $value = '' ]) : bool

Parameters

$key : string: Option key.
$value : mixed = '': Value to set.

Return values

bool — was anything saved?

validate_checkbox_field()

Validate Checkbox Field.


    public
                validate_checkbox_field(string $key, string $value) : string

If not set, return "no", otherwise return "yes".

Parameters

$key : string: Field key.
$value : string: Posted Value.

Return values

string —

validate_decimal_field()

Validate Decimal Field.


    public
                validate_decimal_field(string $key, string $value) : string

Make sure the data is escaped correctly, etc.

Parameters

$key : string: Field key.
$value : string: Posted Value.

Return values

string —

validate_multiselect_field()

Validate Multiselect Field.


    public
                validate_multiselect_field(string $key, string $value) : string|array<string|int, mixed>

Parameters

$key : string: Field key.
$value : string: Posted Value.

Return values

string|array<string|int, mixed> —

validate_password_field()

Validate Password Field. No input sanitization is used to avoid corrupting passwords.


    public
                validate_password_field(string $key, string $value) : string

Parameters

$key : string: Field key.
$value : string: Posted Value.

Return values

string —

validate_price_field()

Validate Price Field.


    public
                validate_price_field(string $key, string $value) : string

Make sure the data is escaped correctly, etc.

Parameters

$key : string: Field key.
$value : string: Posted Value.

Return values

string —

validate_safe_text_field()

Sanitize 'Safe Text' fields.


    public
                validate_safe_text_field(string $key, string $value) : string

These fields are similar to regular text fields, but a much smaller set of HTML tags are allowed. By default, this means <br>, <img>, <p> and <span> tags.

Note: this is a sanitization method, rather than a validation method (the name is due to some historic naming choices).

Parameters

$key : string: Field key (currently unused).
$value : string: Posted Value.

Return values

string —

validate_select_field()

Validate Select Field.


    public
                validate_select_field(string $key, string $value) : string

Parameters

$key : string: Field key.
$value : string: Posted Value.

Return values

string —

validate_settings_fields()

Validate the data on the "Settings" form.


    public
                validate_settings_fields([array<string|int, mixed> $form_fields = array() ]) : mixed

Parameters

$form_fields : array<string|int, mixed> = array(): Array of fields.

Return values

mixed —

validate_text_field()

Validate Text Field.


    public
                validate_text_field(string $key, string $value) : string

Make sure the data is escaped correctly, etc.

Parameters

$key : string: Field key.
$value : string: Posted Value.

Return values

string —

validate_textarea_field()

Validate Textarea Field.


    public
                validate_textarea_field(string $key, string $value) : string

Parameters

$key : string: Field key.
$value : string: Posted Value.

Return values

string —

admin_actions()

Admin actions.


    protected
                admin_actions() : mixed

Return values

mixed —

delete_template_action()

Delete template action.


    protected
                delete_template_action(string $template_type) : mixed

Parameters

$template_type : string: Template type.

Return values

mixed —

get_bcc_field()

Get the bcc field definition.


    protected
                get_bcc_field() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_cc_field()

Get the cc field definition.


    protected
                get_cc_field() : array<string|int, mixed>

Return values

array<string|int, mixed> —

get_must_use_css_styles()

Returns CSS styles that should be included with all HTML e-mails, regardless of theme specific customizations.


    protected
                get_must_use_css_styles() : string

Return values

string —

get_option_or_transient()

Get an option or transient for email preview.


    protected
                get_option_or_transient(string $key[, mixed $empty_value = null ]) : mixed

Parameters

$key : string: Option key.
$empty_value : mixed = null: Value to use when option is empty.

Return values

mixed —

get_preheader_field()

Get the preheader field definition.


    protected
                get_preheader_field() : array<string|int, mixed>

Return values

array<string|int, mixed> —

is_order_eligible_for_recovery()

Whether an order is in a state that warrants a recovery email.


    protected
                is_order_eligible_for_recovery(WC_Order $order) : bool

The order must (a) be in one of the eligible statuses, (b) have lived in that state for at least ABANDONMENT_THRESHOLD_SECONDS (so we don't nudge customers who are actively still on the page), and (c) have a valid billing email — checkout-draft orders in particular can land in the eligible status without a recipient.

Single source of truth: called both by trigger() (defence-in-depth at send time) and by the manual-send dropdown gates. Partners can widen the eligible-status set via woocommerce_abandoned_cart_recovery_eligible_statuses and both paths will agree.

Parameters

$order : WC_Order: Order to evaluate.

Return values

bool —

move_template_action()

Move template action.


    protected
                move_template_action(string $template_type) : mixed

Parameters

$template_type : string: Template type.

Return values

mixed —

save_template()

Save the email templates.


    protected
                save_template(string $template_code, string $template_path) : mixed

Parameters

$template_code : string: Template code.
$template_path : string: Template path.

Return values

mixed —

send_if_recipient()

Send the email when a recipient is available, regardless of the enabled setting.


    protected
                send_if_recipient() : bool

This helper is intended for manually-triggered emails (e.g. invoice resend, POS receipts) that intentionally bypass the enabled/disabled check. It fires woocommerce_email_skipped with reason {@see} when no recipient is available so the outcome is still observable via the EmailLogger, and otherwise delegates to send().

Return values

bool — Whether the email was sent successfully.

send_notification()

Send the email notification when enabled and a recipient is available.


    protected
                send_notification() : bool

This is the standard helper used by trigger() methods. It checks whether the email is enabled and whether a recipient address exists, fires appropriate action hooks for the disabled or skipped outcome, and otherwise delegates to send() with the standard content parameters.

Subclasses that intentionally bypass the enabled check (e.g. manually-triggered invoice emails, POS receipts) should NOT call this method and should continue to call send() directly.

Return values

bool — Whether the email was sent successfully.

set_defaults()

Set default required properties for each field.


    protected
                set_defaults(array<string|int, mixed> $field) : array<string|int, mixed>

Parameters

$field : array<string|int, mixed>: Setting field array.

Return values

array<string|int, mixed> —

supports_emogrifier()

Return if emogrifier library is supported.


    protected
                supports_emogrifier() : bool

Return values

bool —

apply_inline_style()

Apply inline styles to dynamic content using Emogrifier library (if supported).


    private
                apply_inline_style(string|null $content) : string

Parameters

$content : string|null: Content that will receive inline styles.

Return values

string —

clear_alt_body_field()

Clears the PhpMailer AltBody field, to prevent that content from leaking across emails.


    private
                clear_alt_body_field() : void

Return values

void —

get_block_email_html_content()

Gerenerates the HTML content for the email from a block based email.


    private
                get_block_email_html_content() : string|null

and if so, it renders the block email content.

Return values

string|null —

WC_Email_Customer_Abandoned_Cart_Recovery extends WC_Email in package WooCommerce Classes Emails

Tags

Table of Contents

Constants

ABANDONMENT_THRESHOLD_SECONDS

AUTO_SEND_DELAY_SECONDS

Tags

EMAIL_ID

KNOWN_RECOVERY_HANDLERS

MANUAL_RECOVERY_EMAIL_SEND_ACTION

META_KEY_SENT_AT

SKIP_REASON_NO_RECIPIENT

Tags

ABANDONED_STATUSES

Tags

Properties

$bcc

$block_email_editor_enabled

$cc

$description

$email_group

$email_improvements_enabled

$email_type

$enabled

$errors

$find

Tags

$form_fields

$heading

$id

$mime_boundary

$mime_boundary_header

$object

$personalizer

$placeholders

$plain_replace

Tags

$plain_search

$plugin_id

$recipient

$replace

Tags

$sending

$settings

$subject

$template_base

$template_block

$template_block_content

$template_html

$template_plain

$title

$customer_email

$data

$manual

Methods

__construct()

Return values

add_error()

Parameters

Return values

admin_options()

Return values

display_errors()

Return values

format_settings()

Parameters

Tags

Return values

format_string()

Parameters

Return values

generate_checkbox_html()

Parameters

Tags

Return values

generate_color_html()

Parameters

Tags

Return values

generate_decimal_html()

WC_Email_Customer_Abandoned_Cart_Recovery extends WC_Email
in package

WooCommerce

Classes

Emails