Only add skip-link for block themes & templates on the frontend by aristath · Pull Request #32451 · WordPress/gutenberg

aristath · 2021-06-04T08:15:55Z

Description

The problem is that we're checking with current_theme_supports( 'block-templates' ) which is by opt-out, and as a result, it's not a good way to detect a block theme or template.
To get around that, this PR adds a check to make sure that the $_wp_current_template_content global is set. That global var is only set when a block template gets rendered, so it's a way to detect if we're on a block template/theme or not.

How has this been tested?

Tested a block theme - skip-link gets added ✔️
Tested a classic theme - skip-link doesn't get added ✔️
Tested a classic theme with a block template, content inside a group block using <main> - skip-link gets added ✔️

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
I've tested my changes with keyboard and screen readers.
My code has proper inline documentation.
I've included developer documentation if appropriate.
I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

aristath · 2021-06-09T08:32:24Z

Trac ticket - including patch for core: https://core.trac.wordpress.org/ticket/53368

youknowriad · 2021-06-10T08:21:20Z

lib/full-site-editing/templates.php

+
+	// Early exit if not a block template.
+	global $_wp_current_template_content;
+	if ( ! $_wp_current_template_content ) {


how confident are you about the future-proof aspect of that check? Is there a way we can add a test for this?

Well... Ideally we'd have an is_block_template() function or something similar, but since we don't have something like that, checking for $_wp_current_template_content seems like the safest option.
That global var is only set in https://github.com/WordPress/WordPress/blob/4ae0e4220f0c01005afa0dcbb74979c0d5cb9abc/wp-includes/block-template.php#L45-L58 in WordPress Core, and

gutenberg/lib/full-site-editing/template-loader.php

Lines 61 to 74 in c746132

if ( $block_template ) {

if ( empty( $block_template->content ) && is_user_logged_in() ) {

$_wp_current_template_content =

sprintf(

/* translators: %s: Template title */

__( 'Empty template: %s', 'gutenberg' ),

$block_template->title

);

} elseif ( ! empty( $block_template->content ) ) {

$_wp_current_template_content = $block_template->content;

}

if ( isset( $_GET['_wp-find-template'] ) ) {

wp_send_json_success( $block_template );

}

in Gutenberg.
So in both cases it's only not-null when we're in a block template.

Even if we had a function is_block_template(), I can't think of any other way to do it except checking for that var 🤔

I'm pretty sure it's safe to use and future-proof - unless we change the implementation for block-templates completely

youknowriad

LGTM 👍

Maybe @mcsf could take a look as well.

mcsf · 2021-06-11T15:15:50Z

Thanks for the cc. This makes sense.

…ta 2. This includes: **Various** - Fix multi selection for nested blocks WordPress/gutenberg#32536 - Consistently show the drop indicator while dragging blocks WordPress/gutenberg#31896 - Fix horizontal drop indicator WordPress/gutenberg#32589 - Fix Safari flickering issue WordPress/gutenberg#32581 - Silence useSelect zombie bug errors WordPress/gutenberg#32088 **Template Editor** - Clarify the template creation modal WordPress/gutenberg#32427 - Only add skip links for block templates WordPress/gutenberg#32451 **Widgets Editor** - Add block breadcrumb WordPress/gutenberg#32498 WordPress/gutenberg#32528 WordPress/gutenberg#32569 - Saved deleted and restored widgets. WordPress/gutenberg#32534 - Fix unsaved changes detection WordPress/gutenberg#32573 - Fix button spacing in the header WordPress/gutenberg#32585 - Avoid extra undo levels WordPress/gutenberg#32572 - Move Legacy Widget block to the `@wordpress/widgets` package WordPress/gutenberg#32501 - Fix Social Links color inheritance WordPress/gutenberg#32625 - Use Button appender WordPress/gutenberg#32580 **Global Styles (theme.json)** - Separate the presets per origin in the block editor settings WordPress/gutenberg#32358 WordPress/gutenberg#32622 - Use CSS Custom Properties for the preset styles WordPress/gutenberg#32627 **Performance** - Remove is-typing classname to improve typing performance WordPress/gutenberg#32567 Props nosolosw, jorgefilipecosta, aristath, ntsekouras, peterwilsoncc, mcsf. See #53397. git-svn-id: https://develop.svn.wordpress.org/trunk@51149 602fd350-edb4-49c9-b593-d223f7449a82

…ta 2. This includes: **Various** - Fix multi selection for nested blocks WordPress/gutenberg#32536 - Consistently show the drop indicator while dragging blocks WordPress/gutenberg#31896 - Fix horizontal drop indicator WordPress/gutenberg#32589 - Fix Safari flickering issue WordPress/gutenberg#32581 - Silence useSelect zombie bug errors WordPress/gutenberg#32088 **Template Editor** - Clarify the template creation modal WordPress/gutenberg#32427 - Only add skip links for block templates WordPress/gutenberg#32451 **Widgets Editor** - Add block breadcrumb WordPress/gutenberg#32498 WordPress/gutenberg#32528 WordPress/gutenberg#32569 - Saved deleted and restored widgets. WordPress/gutenberg#32534 - Fix unsaved changes detection WordPress/gutenberg#32573 - Fix button spacing in the header WordPress/gutenberg#32585 - Avoid extra undo levels WordPress/gutenberg#32572 - Move Legacy Widget block to the `@wordpress/widgets` package WordPress/gutenberg#32501 - Fix Social Links color inheritance WordPress/gutenberg#32625 - Use Button appender WordPress/gutenberg#32580 **Global Styles (theme.json)** - Separate the presets per origin in the block editor settings WordPress/gutenberg#32358 WordPress/gutenberg#32622 - Use CSS Custom Properties for the preset styles WordPress/gutenberg#32627 **Performance** - Remove is-typing classname to improve typing performance WordPress/gutenberg#32567 Props nosolosw, jorgefilipecosta, aristath, ntsekouras, peterwilsoncc, mcsf. See #53397. Built from https://develop.svn.wordpress.org/trunk@51149 git-svn-id: http://core.svn.wordpress.org/trunk@50758 1a063a9b-81f0-0310-95a4-ce76da25c4cd

…ta 2. This includes: **Various** - Fix multi selection for nested blocks WordPress/gutenberg#32536 - Consistently show the drop indicator while dragging blocks WordPress/gutenberg#31896 - Fix horizontal drop indicator WordPress/gutenberg#32589 - Fix Safari flickering issue WordPress/gutenberg#32581 - Silence useSelect zombie bug errors WordPress/gutenberg#32088 **Template Editor** - Clarify the template creation modal WordPress/gutenberg#32427 - Only add skip links for block templates WordPress/gutenberg#32451 **Widgets Editor** - Add block breadcrumb WordPress/gutenberg#32498 WordPress/gutenberg#32528 WordPress/gutenberg#32569 - Saved deleted and restored widgets. WordPress/gutenberg#32534 - Fix unsaved changes detection WordPress/gutenberg#32573 - Fix button spacing in the header WordPress/gutenberg#32585 - Avoid extra undo levels WordPress/gutenberg#32572 - Move Legacy Widget block to the `@wordpress/widgets` package WordPress/gutenberg#32501 - Fix Social Links color inheritance WordPress/gutenberg#32625 - Use Button appender WordPress/gutenberg#32580 **Global Styles (theme.json)** - Separate the presets per origin in the block editor settings WordPress/gutenberg#32358 WordPress/gutenberg#32622 - Use CSS Custom Properties for the preset styles WordPress/gutenberg#32627 **Performance** - Remove is-typing classname to improve typing performance WordPress/gutenberg#32567 Props nosolosw, jorgefilipecosta, aristath, ntsekouras, peterwilsoncc, mcsf. See #53397. Built from https://develop.svn.wordpress.org/trunk@51149 git-svn-id: https://core.svn.wordpress.org/trunk@50758 1a063a9b-81f0-0310-95a4-ce76da25c4cd

…ta 2. This includes: **Various** - Fix multi selection for nested blocks WordPress/gutenberg#32536 - Consistently show the drop indicator while dragging blocks WordPress/gutenberg#31896 - Fix horizontal drop indicator WordPress/gutenberg#32589 - Fix Safari flickering issue WordPress/gutenberg#32581 - Silence useSelect zombie bug errors WordPress/gutenberg#32088 **Template Editor** - Clarify the template creation modal WordPress/gutenberg#32427 - Only add skip links for block templates WordPress/gutenberg#32451 **Widgets Editor** - Add block breadcrumb WordPress/gutenberg#32498 WordPress/gutenberg#32528 WordPress/gutenberg#32569 - Saved deleted and restored widgets. WordPress/gutenberg#32534 - Fix unsaved changes detection WordPress/gutenberg#32573 - Fix button spacing in the header WordPress/gutenberg#32585 - Avoid extra undo levels WordPress/gutenberg#32572 - Move Legacy Widget block to the `@wordpress/widgets` package WordPress/gutenberg#32501 - Fix Social Links color inheritance WordPress/gutenberg#32625 - Use Button appender WordPress/gutenberg#32580 **Global Styles (theme.json)** - Separate the presets per origin in the block editor settings WordPress/gutenberg#32358 WordPress/gutenberg#32622 - Use CSS Custom Properties for the preset styles WordPress/gutenberg#32627 **Performance** - Remove is-typing classname to improve typing performance WordPress/gutenberg#32567 Props nosolosw, jorgefilipecosta, aristath, ntsekouras, peterwilsoncc, mcsf. See #53397. Built from https://develop.svn.wordpress.org/trunk@51149 git-svn-id: http://core.svn.wordpress.org/trunk@50758 1a063a9b-81f0-0310-95a4-ce76da25c4cd

aristath added the [Type] Bug An existing feature does not function as intended label Jun 4, 2021

aristath requested review from carolinan and youknowriad June 4, 2021 08:15

aristath requested review from TimothyBJacobs and spacedmonkey as code owners June 4, 2021 08:15

aristath changed the title ~~Only add skip-link on the frontend for block themes & templates~~ Only add skip-link for block themes & templates on the frontend Jun 4, 2021

youknowriad added the Backport to WP Beta/RC label Jun 4, 2021

fix conditionally adding skipLink

45525b3

aristath force-pushed the fix/32433 branch from c27606f to 45525b3 Compare June 7, 2021 13:47

aristath mentioned this pull request Jun 9, 2021

Conditionally add skip-link for block-based templates only. WordPress/wordpress-develop#1357

Closed

youknowriad reviewed Jun 10, 2021

View reviewed changes

youknowriad requested a review from mcsf June 10, 2021 08:21

youknowriad approved these changes Jun 10, 2021

View reviewed changes

youknowriad merged commit 79cfaf9 into trunk Jun 14, 2021

youknowriad deleted the fix/32433 branch June 14, 2021 08:01

youknowriad removed the Backport to WP Beta/RC label Jun 14, 2021

youknowriad pushed a commit that referenced this pull request Jun 14, 2021

Only add the content skip link for block templates (#32451)

d7754fc

youknowriad mentioned this pull request Jun 14, 2021

First patch of backports/fixes for WordPress 5.8 beta 2 #32653

Merged

youknowriad pushed a commit that referenced this pull request Jun 14, 2021

Only add the content skip link for block templates (#32451)

ba70233

aristath mentioned this pull request Jun 15, 2021

fix conditionally adding skipLink youknowriad/wordpress-develop#3

Merged

talldan added this to the Gutenberg 10.9 milestone Jun 16, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Only add skip-link for block themes & templates on the frontend#32451

Only add skip-link for block themes & templates on the frontend#32451
youknowriad merged 1 commit intotrunkfrom
fix/32433

aristath commented Jun 4, 2021

Uh oh!

aristath commented Jun 9, 2021

Uh oh!

youknowriad Jun 10, 2021

Uh oh!

aristath Jun 10, 2021 •

edited

Loading

Uh oh!

youknowriad left a comment

Uh oh!

mcsf commented Jun 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	if ( $block_template ) {
	if ( empty( $block_template->content ) && is_user_logged_in() ) {
	$_wp_current_template_content =
	sprintf(
	/* translators: %s: Template title */
	__( 'Empty template: %s', 'gutenberg' ),
	$block_template->title
	);
	} elseif ( ! empty( $block_template->content ) ) {
	$_wp_current_template_content = $block_template->content;
	}
	if ( isset( $_GET['_wp-find-template'] ) ) {
	wp_send_json_success( $block_template );
	}

Conversation

aristath commented Jun 4, 2021

Description

How has this been tested?

Checklist:

Uh oh!

aristath commented Jun 9, 2021

Uh oh!

youknowriad Jun 10, 2021

Choose a reason for hiding this comment

Uh oh!

aristath Jun 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

youknowriad left a comment

Choose a reason for hiding this comment

Uh oh!

mcsf commented Jun 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

aristath Jun 10, 2021 •

edited

Loading