Update the block theme folders to templates and parts by youknowriad · Pull Request #36647 · WordPress/gutenberg

youknowriad · 2021-11-19T12:01:16Z

This PR updates the block themes to use templates and parts instead of block-templates and block-template-parts.
It also keeps backward compatibility, that said a theme can not have "templates" and "block-template-parts" or "block-templates" and "parts". I also updated all the documentation we have.

Notes

The issue also mentions the future of patterns and styles, I think these are not requirements for 5.9

Testing instructions

Make sure themes with "block-templates" and "block-template-parts" folders work properly.
Make sure themes with "templates" and "parts" folders work properly.

carolinan · 2021-11-19T12:30:52Z

Theme Check also needs to be updated, otherwise themes will not be able to be uploaded to WordPress.org
https://github.com/WordPress/theme-check/blob/master/checks/class-fse-required-files-check.php

youknowriad · 2021-11-19T13:10:13Z

@ockham Do you think you can help with the php unit failures here? I'm not sure I understand the results I'm having and the previous assertions.

Mamaduka · 2021-11-19T13:21:49Z

lib/compat/wordpress-5.9/block-template-utils.php

+	 *
+	 * @return array Folder names used by block themes.
+	 */
+	function get_block_theme_folders( $theme_stylesheet = null ) {


Why not accept theme_dir directly and remove calculation logic?

From an API point of view, I felt that accepting a them stylesheet (or id) is a bit better.

No strong preference. I was just curious :)

ockham · 2021-11-19T13:41:19Z

@ockham Do you think you can help with the php unit failures here? I'm not sure I understand the results I'm having and the previous assertions.

@youknowriad I'll have a look!

ockham · 2021-11-19T14:21:55Z

All of the *_block_template_takes_precedence_over_* tests are failing, which means that the template resolution algorithm thinks that the PHP templates always take precedence -- probably because it can't locate the block templates. So something in template resolution seems to be a bit off still...

ockham · 2021-11-19T14:48:38Z

Is it possible that the reason for this issue is that the test (end dev) env is using Core trunk, and thus the original versions of the template resolution algorithm that we already backported (since it finds those functions and doesn't need GB's 5.9 compat layer)?

The reason why I think this might be the case is as follows: If I move the text fixture files back from phpunit/fixtures/themes/test-theme/templates/ to phpunit/fixtures/themes/test-theme/block-templates/, the lines that assert that the template resolution algorithm finds the block template no longer fail. In other words, the template resolution algorithm expects to find the templates in block-templates/ (rather than templates/).

ockham · 2021-11-19T14:51:46Z

Specifically, I think that GB is picking up Core's versions of _get_block_template_file and _get_block_templates_files, respectively, which are hard-wired to block-templates and block-template-parts.

youknowriad · 2021-11-19T14:56:26Z

@ockham that makes sense, I guess we need to make the fix in both places at the same time.

youknowriad · 2021-11-19T14:56:53Z

I think actually that we should remove the unit test from here, now that these functions are just in Gutenberg to support old versions.

ockham · 2021-11-19T15:00:07Z

I think actually that we should remove the unit test from here, now that these functions are just in Gutenberg to support old versions.

Let's just make sure that we've carried them over to wordpress-develop so we don't lose test coverage for some of these cases 👍

ockham · 2021-11-19T15:03:10Z

I think actually that we should remove the unit test from here, now that these functions are just in Gutenberg to support old versions.

Let's just make sure that we've carried them over to wordpress-develop so we don't lose test coverage for some of these cases 👍

Looks like we still have to backport them: https://github.com/WordPress/wordpress-develop/blob/d87196b560203345b385bef6bef9666e7147bb46/tests/phpunit/tests/block-template.php

ockham · 2021-11-19T19:48:08Z

I think actually that we should remove the unit test from here, now that these functions are just in Gutenberg to support old versions.

Let's just make sure that we've carried them over to wordpress-develop so we don't lose test coverage for some of these cases 👍

Looks like we still have to backport them: https://github.com/WordPress/wordpress-develop/blob/d87196b560203345b385bef6bef9666e7147bb46/tests/phpunit/tests/block-template.php

I've started a PR: WordPress/wordpress-develop#1920

ockham · 2021-11-25T11:09:45Z

I think actually that we should remove the unit test from here, now that these functions are just in Gutenberg to support old versions.

#36855

youknowriad · 2021-11-25T11:11:20Z

The tests here are passing, so this should be good to land now.

Update the block theme folders to templates and parts

a8138f6

youknowriad added Backport to WP Beta/RC [Feature] Themes Questions or issues with incorporating or styling blocks in a theme. labels Nov 19, 2021

youknowriad requested review from a team and mtias November 19, 2021 12:01

youknowriad self-assigned this Nov 19, 2021

youknowriad requested review from TimothyBJacobs, ajitbohra, ajlende, mkaz and spacedmonkey as code owners November 19, 2021 12:01

carolinan mentioned this pull request Nov 19, 2021

FSE theme check- allow for new folder names WordPress/theme-check#404

Closed

Mamaduka reviewed Nov 19, 2021

View reviewed changes

ockham mentioned this pull request Nov 19, 2021

Backport block template resolution algorithm unit tests WordPress/wordpress-develop#1920

Closed

overclokk mentioned this pull request Nov 20, 2021

Revise folder structure on themes made with blocks #36548

Closed

youknowriad mentioned this pull request Nov 22, 2021

Update the FSE theme folders to the new proposed structure WordPress/theme-check#406

Merged

This was referenced Nov 23, 2021

Update the block theme folders to be templates and parts WordPress/wordpress-develop#1932

Closed

Full Site Editing: Remove block template resolution unit tests #36855

Merged

Fix phpcs

8cb6055

aristath approved these changes Nov 25, 2021

View reviewed changes

youknowriad merged commit c6b83c1 into trunk Nov 25, 2021

youknowriad deleted the update/block-theme-folders branch November 25, 2021 11:39

github-actions bot added this to the Gutenberg 12.1 milestone Nov 25, 2021

This was referenced Nov 26, 2021

Templates: Search for old template names in the parent theme too #36910

Merged

Blockbase: Update template directories Automattic/themes#5105

Closed

This was referenced Nov 26, 2021

Update template and parts directories Automattic/themes#5107

Closed

Git moving templates and parts directories Automattic/themes#5108

Closed

noisysocks removed the Backport to WP Beta/RC label Nov 28, 2021

noisysocks pushed a commit that referenced this pull request Nov 29, 2021

Update the block theme folders to templates and parts (#36647)

387f6a8

noisysocks mentioned this pull request Nov 29, 2021

Update @wordpress packages WordPress/wordpress-develop#1967

Closed

kjellr mentioned this pull request Nov 29, 2021

Update theme folders to "templates" and "parts" WordPress/twentytwentytwo#264

Closed

Aljullu mentioned this pull request Dec 9, 2021

Update the path of WooCommerce templates to match the new Gutenberg folders woocommerce/woocommerce-blocks#5343

Closed

bobbingwide mentioned this pull request Dec 12, 2021

Add support for Full Site Editing (FSE) themes bobbingwide/oik-themes#11

Open

7 tasks

pbking mentioned this pull request Jan 13, 2022

Added a temp script to move block theme folder locations Automattic/themes#5311

Merged

Conversation

youknowriad commented Nov 19, 2021

Uh oh!

carolinan commented Nov 19, 2021

Uh oh!

youknowriad commented Nov 19, 2021

Uh oh!

Mamaduka Nov 19, 2021

Choose a reason for hiding this comment

Uh oh!

youknowriad Nov 19, 2021

Choose a reason for hiding this comment

Uh oh!

Mamaduka Nov 19, 2021

Choose a reason for hiding this comment

Uh oh!

ockham commented Nov 19, 2021

Uh oh!

ockham commented Nov 19, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ockham commented Nov 19, 2021

Uh oh!

ockham commented Nov 19, 2021

Uh oh!

youknowriad commented Nov 19, 2021

Uh oh!

youknowriad commented Nov 19, 2021

Uh oh!

ockham commented Nov 19, 2021

Uh oh!

ockham commented Nov 19, 2021

Uh oh!

ockham commented Nov 19, 2021

Uh oh!

ockham commented Nov 25, 2021

Uh oh!

youknowriad commented Nov 25, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ockham commented Nov 19, 2021 •

edited

Loading