Add support for Gutenberg 12.1.0 block template naming convention

[sunyatasattva]

All Submissions:

• Have you followed the WooCommerce Contributing guideline?
• Does your code follow the WordPress' coding standards?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Gutenberg 12.1.0 has changed the convention for the directory paths from block-templates and block-template-parts to templates and parts respectively.

Previously, WooCommerce was checking whether block templates were available, only in the block-templates directory.

This commit adds support for both older and newer naming conventions, as well as parents and child themes.

Closes #31518

How to test the changes in this Pull Request:

Using WP 5.8

1. Install Gutenberg plugin and a block theme which is using the old template directory names such as TT1 Blocks.
2. Check that the WC block templates render/are available in the Site Editor (under Appearance), and on the frontend.
3. Activate a block theme which is using the new template directory names such as the latest version of Tove)
4. Check that the WC block templates still render/are available in the Site Editor (under Appearance), and on the frontend.

Using WP 5.9, replicate the steps above with the Gutenberg plugin deactivated.

Other information:

• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes, as applicable?
• Have you successfully run tests with your changes locally?

Changelog entry

Add support for Gutenberg 12.1.0 block template naming convention in themes

FOR PR REVIEWER ONLY:

• I have reviewed that everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities. I made sure Linting is not ignored or disabled.

[Aljullu]

Thanks for upstreaming this change @sunyatasattva! I left a couple of suggestions, but pre-approving from the WC Blocks side.

Just to clarify, do you think this needs to be included in a future patch release? My understanding is that we need either this fix or woocommerce/woocommerce-blocks#5455 to be included in WC core 6.1 if possible. Am I understanding that right?

[sunyatasattva]

Just to clarify, do you think this needs to be included in a future patch release? My understanding is that we need either this fix or woocommerce/woocommerce-gutenberg-products-block#5455 to be included in WC core 6.1 if possible. Am I understanding that right?

I think we'd need both to be included for full functionality. Either won't be enough :/

So yea, if possible, this should be included ASAP.

[Aljullu]

Thanks for updating the PR @sunyatasattva!

I think we'd need both to be included for full functionality. Either won't be enough :/

I'm unable to reproduce the original issue (#31518). From my investigation, it seems to be because we add a filter to woocommerce_has_block_template:

https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/2635445c5d303eba4dfef12efbde0f29667f2673/src/BlockTemplatesController.php#L406-L439

Which in woocommerce/woocommerce-blocks#5455 was already updated to account for the new directory structure.

Don't get me wrong, I agree this should be upstreamed to WC core, but I would like to make sure if this needs to go into WC core 6.1 or it can wait for WC core 6.2.

In any case, cc'ing @jonathansadowski as the release lead of WC 6.1 for awareness.

[jonathansadowski]

Don't get me wrong, I agree this should be upstreamed to WC core, but I would like to make sure if this needs to go into WC core 6.1 or it can wait for WC core 6.2.

Thanks for the ping. If I'm understanding the issue correctly, it seems reasonable to me that this support could wait until 6.2, as it wouldn't break any existing theme, and that a work-around for supporting the newer convention until 6.2 would be to install a version of blocks that includes woocommerce/woocommerce-blocks#5455. Does that seem reasonable or is there something that I'm missing?

[tjcafferkey]

Works great! LGTM

[tjcafferkey]

Does that seem reasonable or is there something that I'm missing?

@jonathansadowski we could fix this in Woo Blocks temporarily however this means that WooCommerce Block Templates will not be fully compatible with WordPress 5.9 unless users have WooCommerce Blocks installed as well.

I realise this request is beyond the current code freeze but I think it's important to include this fix to ensure compatibility with WP 5.9.

[vedanshujain]

LGTM as well. I am going to merge to trunk, and leaving the decision for when to include to release lead.

[github-actions]

Hi @vedanshujain, thanks for merging this pull request. Please take a look at these follow-up tasks you may need to perform:

• Add the status: needs changelog label
• Add the status: needs testing instructions label

[jonathansadowski]

Yep, I agree with the importance. Thanks for flagging. I'll make sure this gets cherry-picked into 6.1