Missing support for latest Gutenberg blocks directory naming conventions #31518

sunyatasattva · 2021-12-27T23:02:43Z

Prerequisites

I have carried out troubleshooting steps and I believe I have found a bug.
I have searched for similar bugs in both open and closed issues and cannot find a duplicate.

Describe the bug

With WordPress/gutenberg#36647, Gutenberg 12.1.0 has changed the convention for the directory paths from block-templates and block-template-parts to templates and parts respectively.

WooCommerce does not yet support that, and so block-enabled themes on this newest convention might break.

At Team Rubik, we have patched this support here, but this is not the cleanest solution.

The culprit is here:

woocommerce/plugins/woocommerce/includes/class-wc-template-loader.php

Lines 110 to 126 in baadffe

    
           	private static function has_block_template( $template_name ) { 
        
           		if ( ! $template_name ) { 
        
           			return false; 
        
           		} 
        
           		$has_template = is_readable( get_stylesheet_directory() . '/block-templates/' . $template_name . '.html' ); 
        
           		/** 
        
           		 * Filters the value of the result of the block template check. 
        
           		 * 
        
           		 * @since x.x.x 
        
           		 * 
        
           		 * @param boolean $has_template value to be filtered. 
        
           		 * @param string $template_name The name of the template. 
        
           		 */ 
        
           		return (bool) apply_filters( 'woocommerce_has_block_template', $has_template, $template_name ); 
        
           	}

If you folks allow me, I could open a PR to fix this.

Expected behavior

Block templates get correctly loaded when available.

Actual behavior

Block templates don't get correctly loaded.

Steps to reproduce

Get a block theme using the new convention (e.g. Tove) or change your current block theme template directories to the new names.
Access a page which should load the block template.

WordPress Environment

`

WordPress Environment

WordPress address (URL): http://localhost:10003
Site address (URL): http://localhost:10003
WC Version: 6.0.0
REST API Version: ✔ 6.0.0
WC Blocks Version: ✔ 6.7.0-dev
Action Scheduler Version: ✔ 3.3.0
WC Admin Version: ✔ 2.9.4
Log Directory Writable: ✔
WP Version: 5.8.2
WP Multisite: –
WP Memory Limit: 256 MB
WP Debug Mode: ✔
WP Cron: ✔
Language: en_US
External object cache: –

Server Environment

Server Info: nginx/1.16.0
PHP Version: 7.3.5
PHP Post Max Size: 1,000 MB
PHP Time Limit: 1200
PHP Max Input Vars: 4000
cURL Version: 7.54.0
LibreSSL/2.6.5

SUHOSIN Installed: –
MySQL Version: 8.0.16
Max Upload Size: 300 MB
Default Timezone is UTC: ✔
fsockopen/cURL: ✔
SoapClient: ✔
DOMDocument: ✔
GZip: ✔
Multibyte String: ✔
Remote Post: ✔
Remote Get: ✔

Database

WC Database Version: 6.0.0
WC Database Prefix: wp_
Total Database Size: 10.85MB
Database Data Size: 7.76MB
Database Index Size: 3.09MB
wp_woocommerce_sessions: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_woocommerce_api_keys: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_woocommerce_attribute_taxonomies: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_woocommerce_downloadable_product_permissions: Data: 0.02MB + Index: 0.06MB + Engine InnoDB
wp_woocommerce_order_items: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_woocommerce_order_itemmeta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_woocommerce_tax_rates: Data: 0.02MB + Index: 0.06MB + Engine InnoDB
wp_woocommerce_tax_rate_locations: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_woocommerce_shipping_zones: Data: 0.02MB + Index: 0.00MB + Engine InnoDB
wp_woocommerce_shipping_zone_locations: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_woocommerce_shipping_zone_methods: Data: 0.02MB + Index: 0.00MB + Engine InnoDB
wp_woocommerce_payment_tokens: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_woocommerce_payment_tokenmeta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_woocommerce_log: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_actionscheduler_actions: Data: 0.02MB + Index: 0.13MB + Engine InnoDB
wp_actionscheduler_claims: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_actionscheduler_groups: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_actionscheduler_logs: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_automatewoo_abandoned_carts: Data: 0.02MB + Index: 0.08MB + Engine InnoDB
wp_automatewoo_customer_meta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_automatewoo_customers: Data: 0.02MB + Index: 0.09MB + Engine InnoDB
wp_automatewoo_events: Data: 0.02MB + Index: 0.05MB + Engine InnoDB
wp_automatewoo_guest_meta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_automatewoo_guests: Data: 0.02MB + Index: 0.06MB + Engine InnoDB
wp_automatewoo_log_meta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_automatewoo_logs: Data: 0.02MB + Index: 0.05MB + Engine InnoDB
wp_automatewoo_queue: Data: 0.02MB + Index: 0.05MB + Engine InnoDB
wp_automatewoo_queue_meta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_commentmeta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_comments: Data: 0.02MB + Index: 0.08MB + Engine InnoDB
wp_gla_budget_recommendations: Data: 0.22MB + Index: 0.14MB + Engine InnoDB
wp_gla_merchant_issues: Data: 0.02MB + Index: 0.00MB + Engine InnoDB
wp_gla_shipping_rates: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_gla_shipping_times: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_links: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_custom_fields: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_dynamic_segment_filters: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_feature_flags: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_forms: Data: 0.02MB + Index: 0.00MB + Engine InnoDB
wp_mailpoet_log: Data: 0.02MB + Index: 0.00MB + Engine InnoDB
wp_mailpoet_mapping_to_external_entities: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_newsletter_links: Data: 0.02MB + Index: 0.05MB + Engine InnoDB
wp_mailpoet_newsletter_option: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_newsletter_option_fields: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_newsletter_posts: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_newsletter_segment: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_newsletter_templates: Data: 2.52MB + Index: 0.00MB + Engine InnoDB
wp_mailpoet_newsletters: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_mailpoet_scheduled_task_subscribers: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_scheduled_tasks: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_mailpoet_segments: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_mailpoet_sending_queues: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_mailpoet_settings: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_statistics_bounces: Data: 0.02MB + Index: 0.00MB + Engine InnoDB
wp_mailpoet_statistics_clicks: Data: 0.02MB + Index: 0.05MB + Engine InnoDB
wp_mailpoet_statistics_forms: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_statistics_newsletters: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_mailpoet_statistics_opens: Data: 0.02MB + Index: 0.08MB + Engine InnoDB
wp_mailpoet_statistics_unsubscribes: Data: 0.02MB + Index: 0.05MB + Engine InnoDB
wp_mailpoet_statistics_woocommerce_purchases: Data: 0.02MB + Index: 0.06MB + Engine InnoDB
wp_mailpoet_stats_notifications: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_mailpoet_subscriber_custom_field: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_subscriber_ips: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_subscriber_segment: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_mailpoet_subscribers: Data: 0.02MB + Index: 0.13MB + Engine InnoDB
wp_mailpoet_user_agents: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_mailpoet_user_flags: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_options: Data: 3.03MB + Index: 0.06MB + Engine InnoDB
wp_postmeta: Data: 0.13MB + Index: 0.06MB + Engine InnoDB
wp_posts: Data: 0.13MB + Index: 0.06MB + Engine InnoDB
wp_term_relationships: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_term_taxonomy: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_termmeta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_terms: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_usermeta: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_users: Data: 0.02MB + Index: 0.05MB + Engine InnoDB
wp_wc_admin_note_actions: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_wc_admin_notes: Data: 0.05MB + Index: 0.00MB + Engine InnoDB
wp_wc_category_lookup: Data: 0.02MB + Index: 0.00MB + Engine InnoDB
wp_wc_customer_lookup: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_wc_download_log: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_wc_order_coupon_lookup: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_wc_order_product_lookup: Data: 0.02MB + Index: 0.06MB + Engine InnoDB
wp_wc_order_stats: Data: 0.02MB + Index: 0.05MB + Engine InnoDB
wp_wc_order_tax_lookup: Data: 0.02MB + Index: 0.03MB + Engine InnoDB
wp_wc_product_meta_lookup: Data: 0.02MB + Index: 0.09MB + Engine InnoDB
wp_wc_rate_limits: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_wc_reserved_stock: Data: 0.02MB + Index: 0.00MB + Engine InnoDB
wp_wc_tax_rate_classes: Data: 0.02MB + Index: 0.02MB + Engine InnoDB
wp_wc_webhooks: Data: 0.02MB + Index: 0.02MB + Engine InnoDB

Post Type Counts

attachment: 25
mailpoet_page: 1
page: 10
post: 3
product: 18
product_variation: 7
revision: 17
wp_global_styles: 2
wp_template: 1
wp_template_part: 2

Security

Secure connection (HTTPS): ❌
Your store is not using HTTPS. Learn more about HTTPS and SSL Certificates.
Hide errors from visitors: ❌Error messages should not be shown to visitors.

Active Plugins (4)

Gutenberg: by Gutenberg Team – 12.1.0
Jetpack: by Automattic – 10.4
WooCommerce Blocks: by Automattic – 6.7.0-dev
WooCommerce: by Automattic – 6.0.0

Inactive Plugins (7)

Google Listings and Ads: by WooCommerce – 1.9.0
Loco Translate: by Tim Whitlock – 2.5.5
MailPoet 3 (New): by MailPoet – 3.75.1
Query Monitor: by John Blackbourn – 3.7.1
WooCommerce Admin: by WooCommerce – 2.9.4
WooCommerce One Page Checkout: by Automattic – 1.9.0
WooCommerce Payments: by Automattic – 3.4.0

Settings

API Enabled: –
Force SSL: –
Currency: EUR (€)
Currency Position: right_space
Thousand Separator: .
Decimal Separator: ,
Number of Decimals: 2
Taxonomies: Product Types: external (external)
grouped (grouped)
simple (simple)
variable (variable)

Taxonomies: Product Visibility: exclude-from-catalog (exclude-from-catalog)
exclude-from-search (exclude-from-search)
featured (featured)
outofstock (outofstock)
rated-1 (rated-1)
rated-2 (rated-2)
rated-3 (rated-3)
rated-4 (rated-4)
rated-5 (rated-5)

Connected to WooCommerce.com: –

WC Pages

Shop base: #6 - /shop/
Cart: #7 - /cart/
Checkout: ❌ Page does not contain the [woocommerce_checkout] shortcode or the woocommerce/checkout block.
My account: #9 - /my-account/
Terms and conditions: ❌ Page not set

Theme

Name: TT1 Blocks
Version: 0.4.8
Author URL: https://wordpress.org/
Child Theme: ❌ – If you are modifying WooCommerce on a parent theme that you did not build personally we recommend using a child theme. See: How to create a child theme
WooCommerce Support: ❌ Not declared

Templates

Overrides: –

Action Scheduler

Complete: 37
Oldest: 2021-12-09 15:57:19 +0000
Newest: 2021-12-27 17:25:06 +0000

Pending: 1
Oldest: 2021-12-28 17:23:39 +0000
Newest: 2021-12-28 17:23:39 +0000

Status report information

Generated at: 2021-12-27 23:02:12 +00:00
`

Isolating the problem

I have deactivated other plugins and confirmed this bug occurs when only WooCommerce plugin is active.
This bug happens with a default WordPress theme active, or Storefront.
I can reproduce this bug consistently using the steps above.

The text was updated successfully, but these errors were encountered:

zhongruige · 2021-12-28T15:45:44Z

Hi @sunyatasattva,

Thank you for opening the issue! It requires further feedback from the WooCommerce Core team. I am adding the needs developer feedback label to this issue so that the Core team could take a look.

Please note it may take a few days for them to get to this issue. Thank you for your patience.

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. Fixes #31518

sunyatasattva · 2021-12-28T18:34:34Z

Hey @zhongruige thanks a lot for the response. I had opened a Slack thread and received the go ahead there this morning, I hope that's ok with you.

I have opened a PR here: #31522

zhongruige · 2021-12-28T18:36:26Z

Thanks for the update @sunyatasattva! I'll go ahead and remove the needs developer feedback label.

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. Fixes #31518

sunyatasattva mentioned this issue Dec 27, 2021

Check block templates and parts directories to the Gutenberg 12.1.0 convention woocommerce/woocommerce-blocks#5455

Merged

1 task

zhongruige added the needs: developer feedback Issues that need feedback from one of the WooCommerce Core developers. label Dec 28, 2021

sunyatasattva mentioned this issue Dec 28, 2021

Add support for Gutenberg 12.1.0 block template naming convention #31522

Merged

7 tasks

sunyatasattva self-assigned this Dec 28, 2021

zhongruige removed the needs: developer feedback Issues that need feedback from one of the WooCommerce Core developers. label Dec 28, 2021

vedanshujain closed this as completed in #31522 Jan 4, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Missing support for latest Gutenberg blocks directory naming conventions #31518

Missing support for latest Gutenberg blocks directory naming conventions #31518

sunyatasattva commented Dec 27, 2021

zhongruige commented Dec 28, 2021

sunyatasattva commented Dec 28, 2021

zhongruige commented Dec 28, 2021

Missing support for latest Gutenberg blocks directory naming conventions #31518

Missing support for latest Gutenberg blocks directory naming conventions #31518

Comments

sunyatasattva commented Dec 27, 2021

Prerequisites

Describe the bug

Expected behavior

Actual behavior

Steps to reproduce

WordPress Environment

WordPress Environment

Server Environment

Database

Post Type Counts

Security

Active Plugins (4)

Inactive Plugins (7)

Settings

WC Pages

Theme

Templates

Action Scheduler

Status report information

Isolating the problem

zhongruige commented Dec 28, 2021

sunyatasattva commented Dec 28, 2021

zhongruige commented Dec 28, 2021