Add totalValue filter

[nielslange]

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:

Closes #42004.
Closes #45172.

This PR adds the totalValue filter to wrap the total price on the Cart and Checkout blocks. This filter is needed for plugins such as Pre-Orders. It follows the same patterns of the following existing filters:

• cartItemPrice
• subtotalPriceFormat
• saleBadgePriceFormat

How to test the changes in this Pull Request:

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

1. Install and activate the Simple Custom CSS and JS plugin.
2. Go to /wp-admin/edit.php?post_type=custom-css-js and add the following code snippet:

const { registerCheckoutFilters } = window.wc.blocksCheckout;

const modifyTotalsPrice = ( defaultValue, extensions, args, validation ) => {
	return "Pay <price/> now";
};

registerCheckoutFilters( 'my-extension', {
	totalValue: modifyTotalsPrice,
} );

Important

Make sure to run the script in the footer as it requires other dependencies to load first.

3. Go to the frontend and add a product to the cart.
4. Go to the cart page and verify that the total price shows as Pay ... now.
5. Go to the checkout page and verify that the total price shows as Pay ... now.
6. Remove <price/> from the code snippet and repeat steps 4. and 5.
7. Verify that the error message Error: Returned value must include <price/>, you passed "Pay now" is visible.

Screenshots

Cart block:

Checkout block:

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

Add totalValue filter.

Comment

[github-actions]

Test Results Summary

Commit SHA: 28c20ef

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 39s
E2E Tests	335	0	0	16	0	351	8m 32s

---

To view the full API test report, click here.
To view the full E2E test report, click here.
To view all test reports, visit the WooCommerce Test Reports Dashboard.

[github-actions]

Hi @wavvves,

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

[wavvves]

Hi @nielslange, I'm seeing some failing tests related to Totals that seem related. In the meantime I'll start reviewing the changes 👍🏼

[nielslange]

Hi @nielslange, I'm seeing some failing tests related to Totals that seem related. In the meantime I'll start reviewing the changes 👍🏼

Thanks for reviewing this PR, @wavvves. I've looked into the failing JS unit tests, and it turned out they were related to some CSS classes and HTML markup changes. I've addressed these issues and all tests are now passing. Would you mind reviewing this PR again?

[wavvves]

Nice work @nielslange, tested out and everything seems to be working as expected!

[nielslange]

Nice work @nielslange, tested out and everything seems to be working as expected!

Thanks for reviewing this PR again, and thanks for calling out the failing JS unit tests. Somehow, I missed them initially, thinking they would be failing due to another PR, while this PR was causing them to fail. 🙈