Feature: Block-based template parts for Classic themes #3234

Mamaduka · 2022-09-13T09:02:49Z

PR backports changes are required for using block-based template parts in classic themes - WordPress/gutenberg#42729.

Gutenberg tracking issue: WordPress/gutenberg#43440
Trac ticket: https://core.trac.wordpress.org/ticket/56467

Testing Instructions

Classic theme - TT1

The new "Template Parts" menu shouldn't appear in Appearance.
Users can't access the /wp-admin/site-editor.php path directly.

Block theme - TT2

The new "Template Parts" menu shouldn't appear in Appearance.
The "Editor" menu is accessible.
The Site Editor works as before.

Themes with block-based templates part enabled
You can grab the testing theme from this repo - https://github.com/Mamaduka/block-fragments

The new "Template Parts" menu is visible under Appearance.
The menu redirects to the "Template Parts" list view.
The "Site" and "Templates" navigation items aren't visible.

Warning
The last item will require the latest package update PR to be merged, and it might not be possible to test immediately.

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Mamaduka · 2022-09-13T09:03:36Z

src/wp-admin/site-editor.php

+	'styles'                    => get_block_editor_theme_styles(),
+	'defaultTemplateTypes'      => $indexed_template_types,
+	'defaultTemplatePartAreas'  => get_allowed_block_template_part_areas(),
+	'supportsLayout'            => WP_Theme_JSON_Resolver::theme_has_support(),


Before, the Site Editor always assumed layout support.

Mamaduka · 2022-09-13T09:04:16Z

src/wp-includes/functions.php

@@ -5261,7 +5261,7 @@ function wp_widgets_add_menu() {
 	}

 	$menu_name = __( 'Widgets' );
-	if ( wp_is_block_theme() ) {
+	if ( wp_is_block_theme() || current_theme_supports( 'block-template-parts' ) ) {


We need this to avoid conflicts between the Customize and Widgets menu positions.

ockham

Thanks a lot @Mamaduka! LGTM

hellofromtonya · 2022-09-14T12:48:33Z

@ockham what is the status of the Warning in the description?

The last item will require the latest package update PR to be merged, and it might not be possible to test immediately.

ockham · 2022-09-14T13:05:23Z

@ockham what is the status of the Warning in the description?

The last item will require the latest package update PR to be merged, and it might not be possible to test immediately.

Ah, my bad, I should've elaborated on that. I was indeed able to test and confirm everything except for

The "Site" and "Templates" navigation items aren't visible.

As @Mamaduka said, we'll only be able to verify this once we've synced @wordpress/ packages. That sync is still blocked. However, I don't think we need to hold off until that package sync, since part of the logic responsible for conditionally showing the "Site" and "Templates" menu items lives in JS (and can be considered part of those packages, rather than the PHP that this PR touches).

In any case, we can easily test this separately once we sync packages.

Does that sound okay?

hellofromtonya · 2022-09-14T16:54:09Z

Testing Report

Env:

WordPress: trunk
Plugins: none
Browser: Firefox
Localhost: wp-env

Results:

Classic theme - TT1

The new "Template Parts" menu shouldn't appear in Appearance ✅
Users can't access the /wp-admin/site-editor.php path directly ✅

Block theme - TT2

The new "Template Parts" menu shouldn't appear in Appearance ✅
The "Editor" menu is accessible ✅
The Site Editor works as before ✅

Themes with block-based templates part enabled
Theme: https://github.com/Mamaduka/block-fragments

The new "Template Parts" menu is visible under Appearance ✅
The menu redirects to the "Template Parts" list view ✅
The "Site" and "Templates" navigation items aren't visible ❌ (needs the JS packages updated - per notes in the description)

Observations:

With the block-fragments (classic theme with block-based templates) enabled, I am able to directly access /wp-admin/site-editor.php but it's a white screen. No errors in the browser's console or error logs.

@Mamaduka @ockham Is this something that will be fixed with another backport? Or a known issue?

fabiankaegy · 2022-09-14T18:35:17Z

src/wp-admin/site-editor.php

@@ -19,7 +19,7 @@
 	);
 }

-if ( ! wp_is_block_theme() ) {
+if ( ! ( current_theme_supports( 'block-template-parts' ) || wp_is_block_theme() ) ) {
 	wp_die( __( 'The theme you are currently using is not compatible with Full Site Editing.' ) );
 }



@hellofromtonya I belive something like this would solve the case you uncovered in your testing here: #3234 (comment)

With the block-fragments (classic theme with block-based templates) enabled, I am able to directly access /wp-admin/site-editor.php but it's a white screen. No errors in the browser's console or error logs.

Suggested change

$is_template_part_editor = isset( $_GET['postType'] ) && 'wp_template_part' === sanitize_key( $_GET['postType'] );

if ( ! wp_is_block_theme() && ! $is_template_part_editor ) {

wp_die( __( 'The theme you are currently using is not compatible with the Site Editor.' ) );

}

As far as I'm aware that was not a known issue and no patch for it had been created.

@Mamaduka asked me to keep an eye on this PR since he is out traveling. I will create a PR on the Gutenberg Repo to fix the issue there aswell.

Actually in looking at the code in Gutenberg it was handled as a completely separate admin page. So this issue only exists in this PR and only needs to get fixed here. No backport to Gutenberg is needed.

https://github.com/WordPress/gutenberg/blob/d19258cb5b85cea52e85a3e86c9550dd48d44fca/lib/compat/wordpress-6.1/template-parts-screen.php#L5

In order to make it easier to test, I have also created a separate PR against @Mamaduka's branch which applies the same fix as the one I have shown in the suggestion above: Mamaduka#48

Yes, that does resolve it. Well done @fabiankaegy - thank you!

non block themes that support block based template parts should only be allowed to access the site-editor.php file if the query parameter to access the template part editor is set correctly

…-parts-mode-fix fix prevent unwanted access of site-editor.php

ockham · 2022-09-15T09:46:05Z

tests/phpunit/tests/rest-api/rest-themes-controller.php

@@ -406,7 +407,7 @@ public function test_get_item_schema() {
 		$this->assertArrayHasKey( 'responsive-embeds', $theme_supports );
 		$this->assertArrayHasKey( 'title-tag', $theme_supports );
 		$this->assertArrayHasKey( 'wp-block-styles', $theme_supports );
-		$this->assertCount( 21, $theme_supports );
+		$this->assertCount( 22, $theme_supports );


This was bumped to 22 by 72380e3 (#3205):

wordpress-develop/tests/phpunit/tests/rest-api/rest-themes-controller.php

Line 410 in 0b2f05a

$this->assertCount( 22, $theme_supports );

So we'll need to rebase and increment it again:

Suggested change

$this->assertCount( 22, $theme_supports );

$this->assertCount( 23, $theme_supports );

ockham · 2022-09-15T09:46:44Z

Thanks a lot, @fabiankaegy! Looks like this PR is good to go, except for failing unit tests, which I think are due to this: https://github.com/WordPress/wordpress-develop/pull/3234/files#r971773508.

@Mamaduka If you're around, could you rebase and change that number to 23? 🙏

ockham · 2022-09-15T10:10:50Z

@Mamaduka is currently AFK -- I've forked this PR and applied my fix: #3258

hellofromtonya · 2022-09-15T12:21:57Z

Thank you everyone for your contributions! Committed PR 3258 (finalization of this PR) via https://core.trac.wordpress.org/ticket/56467.

Feature: Block-based template parts for Classic themes

0200cfd

Mamaduka commented Sep 13, 2022

View reviewed changes

Mamaduka mentioned this pull request Sep 13, 2022

Plugin: Backport PHP changes for WordPress 6.1 release WordPress/gutenberg#43440

Closed

37 tasks

Update unit tests

b4de22f

ockham approved these changes Sep 14, 2022

View reviewed changes

hellofromtonya self-assigned this Sep 14, 2022

fabiankaegy reviewed Sep 14, 2022

View reviewed changes

fix prevent unwanted access of site-editor.php

ecd664a

non block themes that support block based template parts should only be allowed to access the site-editor.php file if the query parameter to access the template part editor is set correctly

fabiankaegy mentioned this pull request Sep 14, 2022

fix prevent unwanted access of site-editor.php Mamaduka/wordpress-develop#48

Merged

Merge pull request #48 from fabiankaegy/backport/site-editor-template…

040c485

…-parts-mode-fix fix prevent unwanted access of site-editor.php

ockham reviewed Sep 15, 2022

View reviewed changes

ockham mentioned this pull request Sep 15, 2022

Feature: Block-based template parts for Classic themes #3258

Closed

hellofromtonya closed this Sep 15, 2022

Mamaduka deleted the backport/site-editor-template-parts-mode branch May 9, 2023 09:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature: Block-based template parts for Classic themes #3234

Feature: Block-based template parts for Classic themes #3234

Mamaduka commented Sep 13, 2022

Mamaduka Sep 13, 2022

Mamaduka Sep 13, 2022

ockham left a comment

hellofromtonya commented Sep 14, 2022

ockham commented Sep 14, 2022

hellofromtonya commented Sep 14, 2022 •

edited

Loading

fabiankaegy Sep 14, 2022 •

edited

Loading

fabiankaegy Sep 14, 2022

fabiankaegy Sep 14, 2022

hellofromtonya Sep 14, 2022

Mamaduka Sep 15, 2022

ockham Sep 15, 2022

ockham commented Sep 15, 2022

ockham commented Sep 15, 2022

hellofromtonya commented Sep 15, 2022

+$is_template_part_editor = isset( $_GET['postType'] ) && 'wp_template_part' === sanitize_key( $_GET['postType'] );
+if ( ! wp_is_block_theme() && ! $is_template_part_editor ) {
+	wp_die( __( 'The theme you are currently using is not compatible with the Site Editor.' ) );
+}

	$this->assertCount( 22, $theme_supports );
	$this->assertCount( 23, $theme_supports );

Feature: Block-based template parts for Classic themes #3234

Feature: Block-based template parts for Classic themes #3234

Conversation

Mamaduka commented Sep 13, 2022

Testing Instructions

Mamaduka Sep 13, 2022

Choose a reason for hiding this comment

Mamaduka Sep 13, 2022

Choose a reason for hiding this comment

ockham left a comment

Choose a reason for hiding this comment

hellofromtonya commented Sep 14, 2022

ockham commented Sep 14, 2022

hellofromtonya commented Sep 14, 2022 • edited Loading

fabiankaegy Sep 14, 2022 • edited Loading

Choose a reason for hiding this comment

fabiankaegy Sep 14, 2022

Choose a reason for hiding this comment

fabiankaegy Sep 14, 2022

Choose a reason for hiding this comment

hellofromtonya Sep 14, 2022

Choose a reason for hiding this comment

Mamaduka Sep 15, 2022

Choose a reason for hiding this comment

ockham Sep 15, 2022

Choose a reason for hiding this comment

ockham commented Sep 15, 2022

ockham commented Sep 15, 2022

hellofromtonya commented Sep 15, 2022

hellofromtonya commented Sep 14, 2022 •

edited

Loading

fabiankaegy Sep 14, 2022 •

edited

Loading