Pass some context information to woocommerce_blocks_hook_compatibility_additional_data hook

[kmanijak]

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 #44447.

How to test the changes in this Pull Request:

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

1. In your theme's functions.php add a following code

function comp_layer_callback( $arr, $classname ) {
	echo $classname;
}

add_filter( 'woocommerce_blocks_hook_compatibility_additional_data', 'comp_layer_callback', 10, 3 );

2. Go to Editor and Clear Customisations on templates:

• Product Catalog
• Single Product

3. Visit each of them and make sure you use a blockified template. If it's a classic template, enter the efit mode and click "Transform into blocks"
4. Save if necessary
5. Go to frontend /shop
6. Expected: You should see at the top of the pageArchiveProductTemplatesCompatibility (it can be repeated multiple times)
7. Click one of the products
8. Expected: You should see at the top of the pageSingleProductTemplateCompatibility (it can be repeated multiple times)

Example:

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

Comment

[github-actions]

Hi @gigitux, @woocommerce/woo-fse

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 Results Summary

Commit SHA: 1964059

Test 🧪	Passed ✅	Failed 🚨	Broken 🚧	Skipped ⏭️	Unknown ❔	Total 📊	Duration ⏱️
API Tests	259	0	0	2	0	261	0m 37s
E2E Tests	303	0	0	44	0	347	7m 33s

---

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.

[gigitux]

Thanks, @kmanijak, for working on this!

While I may not be a PHP expert, I'd like to suggest considering the possibility of passing the entire instance of the class instead of just its name. This approach could offer developers greater flexibility and freedom in their implementations. Feel free to correct me if I'm mistaken, as my understanding of PHP might be limited.

[xristos3490]

Hey folks! Just wanted to add my two cents to the discussion.

Personally, I think it's best to avoid passing the object itself unless it's necessary.

This is because it could potentially lead to issues with calling public methods on the same instance (e.g., the init() method.) If there are further requirements in the future, we could consider passing the object and reviewing its public schema for any potential regressions.

[gigitux]

Thanks, @xristos3490, for sharing your thoughts! LGTM!

[kmanijak]

Hi @webmandesign, wanted to let you know this PR was merged and the change will be available in WooCommerce 8.8! Thanks for nice suggestion in #44447!