Prevent "woocommerce_new_order" from being triggered on orders with "checkout-draft" status

[wavvves]

Submission Review Guidelines:

• I have followed the WooCommerce Contributing Guidelines and the WordPress Coding Standards.
• I have checked to ensure there aren't other open Pull Requests for the same update/change.
• I have reviewed my code for security best practices.
• Following the above guidelines will result in quick merges and clear and detailed feedback when appropriate.

Changes proposed in this Pull Request:

This PR prevents "woocommerce_new_order" action from being triggered when visiting the Checkout Block page, while the order status is "checkout-draft".

Closes #45145 .

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

1. Install the Code Snippets extension and add the following snippet:

add_action("woocommerce_new_order","any",20,1);
function any($order_id){
    ob_get_clean();
    die("woocommerce_new_order was triggered");
}

3. If your cart has items make sure to place a new order
4. Add item(s) to your cart and visit the checkout blocks page
5. Verify the checkout page displays correctly and the text "woocommerce_new_order was triggered" is not displayed

Changelog entry

• Automatically create a changelog entry from the details below.

Significance

• Patch
• Minor
• Major

Type

• Fix - Fixes an existing bug
• Add - Adds functionality
• Update - Update existing functionality
• Dev - Development related task
• Tweak - A minor adjustment to the codebase
• Performance - Address performance issues
• Enhancement - Improvement to existing functionality

Message

Prevent "woocommerce_new_order" from being triggered on orders with "checkout-draft" status

Comment

[github-actions]

Hi @opr, @senadir, @vedanshujain,

Apart from reviewing the code changes, please make sure to review the testing instructions as well.

You can follow this guide to find out what good testing instructions should look like:
https://github.com/woocommerce/woocommerce/wiki/Writing-high-quality-testing-instructions

[github-actions]

Test using WordPress Playground

The changes in this pull request can be previewed and tested using a WordPress Playground instance.
WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Test this pull request with WordPress Playground.

Note that this URL is valid for 30 days from when this comment was last updated. You can update it by closing/reopening the PR or pushing a new commit.

[senadir]

Wanted to get this PR merged today but it's still missing too many things.

The code only applies to HPOS stores, not regular stores (see code).
It fails to trigger the new order hook for orders that were previously draft (see code and this code).

[wavvves]

Wanted to get this PR merged today but it's still missing too many things.

The code only applies to HPOS stores, not regular stores (see code). It fails to trigger the new order hook for orders that were previously draft (see code and this code).

Not sure I follow this, there's no consideration for status strings on the linked example (create order), and the new order action seems to be triggered disregarding the status.

For the other example (since one has a broken link, and there's no referenced lines if I try to fix it), I agree with you, it is not considering moving the order from checkout-draft, I added it 3f959f6

Can you please elaborate on the other two Nadir? Thanks in advance :)

[vedanshujain]

@wavvves I think what @senadir is referring to here is we would want two separate changes:

1. Not trigger the woocommerce_new_order hook when the status is one of the draft ones. You are already doing this for HPOS but not for CPT.
2. Do trigger this hook, when the status is changed from a draft one to a non draft one. You are doing this for CPT but not for HPOS.

Essentially, we should:

• Prevent triggering this hook for CPT when status is draft. See https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/includes/data-stores/class-wc-order-data-store-cpt.php#L103C15-L103C24
• Prevent triggering this hook for HPOS when status is draft. (You are already doing this)
• Trigger this hook when status is changed from draft to non draft for CPT. (You are already doing this).
• Trigger this hook when status is changed from draft to non draft for HPOS. See https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/src/Internal/DataStores/Orders/OrdersTableDataStore.php#L2626.

Additionally, we should probably make the list of draft statuses consistent, plus maybe add some unit tests around these flows. wdyt?

[senadir]

Yeah that's exactly what I had in mind @vedanshujain , just more elegantly from your side