Documentation for Order Status for WooCommerce Plugin

---

Settings

Order Status for WooCommerce plugin lets you add and manage custom order statuses in WooCommerce.

You can add any number of statuses and for each status you can set:

• Styling options – status text color, background color.
• General options – add status to order bulk actions, add status to reports.
• Action buttons options – icon, icon color & background color, add status to order list action buttons and/or admin order preview action buttons.
• Order options – is order editable and/or is order paid.
• Email options – email address, subject, heading and content.

You can view, edit, delete and create new custom statuses in “WooCommerce > Order Status”.[hide]similarly as you would create a simple post or a product.[/hide]

Custom Status Options

For each custom order status you can set:

• Status Title Options
• Styling Options
• General Options
• Action Buttons Options
• Order Options
• Email Options
• Admin Note
• Actions

Status Title Options

Title

Sets title for the custom order status.

Default: None

Slug

Slug is generated automatically and cannot be changed later.

Default: wc-{sanitized-title}

Styling Options

Text color

Sets custom status text color.

Default: #000000

Background color

Sets custom status background color.

Default: #999999

General Options

Add to order bulk actions

Adds custom status to order bulk actions.

Default: yes

Add to report

Adds custom status to reports.

Default: yes

Action Buttons Options

Add to order list action buttons

Adds custom status to order list action buttons.

Default: no

Order list icon

Sets status icon. You can get icon codes here.

Default: e011

Order list icon color

Sets status order list icon color.

Default: #999999

Order list icon background color

Sets status order list icon background color.

Default: #ffffff

Add to admin order preview action buttons

Adds status to admin order preview action buttons.

Default: no

Order Options

Is order editable

Sets if custom status order is editable.

Default: no

Is order paid

Sets if custom status order is paid.

Default: no

Email Options

Send email on status change

Enables/disables emails on status change.

Default: no

Email address

If empty, will send to site admin email.

Default: None

”Subject”

Order #{order_number} status changed to {status_to_title} – {order_date}”]Email subject.

Default: ”[{site_title}

Heading

Email content heading.

Default:

Order status changed to {status_to_title}

Content

Email content.

Default:

Order #{order_number} status changed from {status_from_title} to {status_to_title}

Placeholders in subject, heading and content:

• {order_id},
• {order_number},
• {order_date},
• {site_title},
• {status_to},
• {status_to_title},
• {status_from},
• {status_from_title}.

Additional placeholder in heading and content: {order_details}.

Placeholders in email address: %customer%, %admin%.

Admin Note

Note

Admin note is visible on custom status edit page only.

Default: None

Actions

• Delete status – Deletes custom order status.
• Delete status with fallback – Deletes custom order status and changes all corresponding orders status to “On hold”.
• View orders – Lists all orders with current status.

---

Changelog

1.4.6 - 07/02/2024

• Dev - PHP 8.2 compatibility - "Creation of dynamic property is deprecated" notice fixed.
• WC tested up to: 8.5.

1.4.5 - 20/11/2023

• WC tested up to: 8.3.
• Tested up to: 6.4.
• Plugin title updated.

1.4.4 - 01/11/2023

• Dev - Order Options - "Download permissions" option added (defaults to no).
• Dev - Minor code refactoring.
• WC tested up to: 8.2.

1.4.3 - 03/10/2023

• Fix - Declaring HPOS compatibility for the free plugin version, even if the Pro version is activated.

1.4.2 - 26/09/2023

• WC tested up to: 8.1.
• Tested up to: 6.3.
• Plugin icon, banner updated.

1.4.1 - 18/06/2023

• WC tested up to: 7.8.

1.4.0 - 09/06/2023

• Dev - Order Options - 'Set order "date paid" on status update' option added.
• Dev - "WooCommerce > Settings > Order Status" settings section added for global options.
• Dev - "Order status sorting" option added.
• Dev – "High-Performance Order Storage (HPOS)" compatibility.
• Dev - Admin settings descriptions updated.

1.3.0 - 06/06/2023

• Dev - Default WooCommerce status class property added (is_override).
• Dev - Emails - "Wrap in WooCommerce template" option added (defaults to yes).
• Dev - Emails - {completed_order} placeholder added.
• Dev - Admin settings descriptions updated.
• Dev - Code refactoring.
• WC tested up to: 7.7.
• Tested up to: 6.2.

1.2.0 - 21/10/2022

• Dev - Admin menu priority lowered from PHP_INT_MAX to 100.
• Deploy script added.
• Readme.txt updated.
• WC tested up to: 7.0.

1.1.1 - 26/05/2022

• Dev - Priorities lowered from 10 to 9 for load_plugin_textdomain, register_post_type and register_post_status (all in init action).
• Tested up to: 6.0.
• WC tested up to: 6.5.

1.1.0 - 10/02/2022

• Dev - Shortcodes - [alg_wc_os_order_meta] shortcode added.
• Dev - Emails - Placeholders (heading/content) - {order_billing_first_name} and {order_billing_last_name} placeholders added.
• Dev - Emails - Sending emails via WooCommerce WC_Email class now. Old method can be still enabled via the wfwp_wc_order_status_wc_email filter.
• Dev - Emails - wfwp_wc_order_status_email_content filter added.
• Dev - JS minified.
• Dev - Admin settings descriptions updated.
• Dev - Localization - load_plugin_textdomain() function moved to the to init action.
• Dev - Plugin is initialized on plugins_loaded action now.
• Dev - Code refactoring.
• Tested up to: 5.9.
• WC tested up to: 6.2.

1.0.0 - 19/12/2018

• Initial Release.