adds skip links check for block themes by MaggieCabrera · Pull Request #457 · WordPress/theme-check

MaggieCabrera · 2024-09-03T10:35:19Z

This PR adds a check only for block themes to see if templates have a main tag present. If they don't they will be missing the skip links from said template.

I need to check when a template is made out of a pattern and the main tag will be inside the pattern instead of the template file

MaggieCabrera · 2024-09-03T11:05:27Z

We might want to check if there's multiple tags too

checks/class-skip-links.php

matiasbenedetto

the <main> tag is being rendered in the HTML instead of being printed as text:

matiasbenedetto · 2024-09-09T14:01:20Z

It would be nice to make the main tag search recusive for nested patterns.

MaggieCabrera · 2024-09-11T15:42:21Z

I fixed those! ready for another review

checks/class-skip-links.php

Co-authored-by: Matias Benedetto <matias.benedetto@gmail.com>

checks/class-skip-links.php

matiasbenedetto · 2024-09-16T15:05:37Z

checks/class-skip-links.php

+			return false;
+		}
+
+		$files = glob( $theme_dir . '/' . $directory . '/*.php' );


Same as in #457 (comment)

It looks like $php_files doesn't store the contents of the comment in the pattern, so I have no way of checking if the slug of the pattern is the one I'm trying to match

seems like that's done here so I will leave this part of the code as I implemented it:

theme-check/checkbase.php

Line 61 in b2b4cec

$php[ $filename ] = tc_strip_comments( $php[ $filename ] );

kafleg · 2024-09-17T07:24:34Z

I checked by removing "tagName":"main" from the template files in Twenty Twenty Four theme but this PR won't show anything.

Would you please let me know how did you test that?

kafleg · 2024-09-17T07:43:01Z

I checked by removing "tagName":"main" from the template files in Twenty Twenty Four theme but this PR won't show anything.

Would you please let me know how did you test that?

I find it. I was checking different PR. Sorry!

kafleg · 2024-09-17T07:54:24Z

REQUIRED Skip links are missing from the following templates: single.html, single.html Please make sure the templates have a

tag.

Why the message show single.html, single.html twice?

MaggieCabrera · 2024-09-17T08:02:52Z

REQUIRED Skip links are missing from the following templates: single.html, single.html Please make sure the templates have a
tag.

Why the message show single.html, single.html twice?

I haven't seen that on my tests, what did you try to get that to happen?

kafleg · 2024-09-17T08:14:16Z

In single.html file of TT4 theme, I simply changed <main class="wp-block-group alignfull"> to <div class="wp-block-group alignfull">

kafleg · 2024-09-17T08:21:10Z

I think I found the reason,
I changed on index.html and single.html in two files and it is happended.

checks/class-skip-links.php

MaggieCabrera · 2024-10-31T09:40:39Z

I think I found the reason, I changed on index.html and single.html in two files and it is happended.

I just fixed this

MaggieCabrera · 2024-10-31T10:31:10Z

Sorry, I have been super busy; I just caught up with the reviews. It should be ready to go now!

matiasbenedetto · 2024-11-06T13:53:01Z

checks/class-skip-links.php

+	/**
+	 * Returns true if the theme is a block theme.
+	 *
+	 * @var array $is_block_theme
+	 */
+	protected $is_block_theme = false;
+
+	/**
+	 * The WP_Theme instance being checked.
+	 *
+	 * @var WP_Theme $wp_theme
+	 */
+	protected $wp_theme = false;
+
+	function set_context( $data ) {
+		if ( isset( $data['theme'] ) ) {
+			$this->wp_theme       = $data['theme'];
+			$this->is_block_theme = wp_is_block_theme();
+		}


As far as I can see is_block_theme is not being used in this check class. Is it used somewhere?

matiasbenedetto

I think the Skip_Links_Check class needs to be added to the list of FSE specific checks here:

theme-check/checkbase.php

Lines 386 to 387 in dabaf1d

    
           // Add FSE specific checks. 
        
           $themechecks[] = new FSE_Required_Files_Check();

So this line needs to be removed:

theme-check/checks/class-skip-links.php

Line 152 in dabaf1d

$themechecks[] = new Skip_Links_Check();

See FSE_Required_Files_Check class as reference.

Copilot

Pull request overview

This PR introduces a new Theme Check rule intended to validate that block-theme templates include a <main> landmark (directly or via referenced patterns) so skip links can be present.

Changes:

Adds Skip_Links_Check to scan block template files for a main landmark.
Adds pattern parsing to detect <main> within referenced (including nested) block patterns.
Registers the new check in the global $themechecks list.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

checks/class-skip-links.php

+				$file_name    = tc_filename( $php_key );
+				$has_main_tag = strpos( $file, '<main' ) !== false;
+


checks/class-skip-links.php

+		$files = glob( $theme_dir . '/' . $directory . '/*.php' );
+
+		$has_tag = false;
+
+		foreach ( $files as $file ) {
+			if ( is_file( $file ) ) {
+				$contents = file_get_contents( $file );


checks/class-skip-links.php

+	function set_context( $data ) {
+		if ( isset( $data['theme'] ) ) {
+			$this->wp_theme       = $data['theme'];
+			$this->is_block_theme = wp_is_block_theme();
+		}


checks/class-skip-links.php

+
+		foreach ( $other_files as $php_key => $file ) {
+			// if the file is a template, print the name of the file
+			if ( strpos( $php_key, 'templates/' ) !== false ) {


checks/class-skip-links.php

+							$has_main_tag = $this->pattern_has_tag( $slug );
+							if ( ! $has_main_tag ) {
+								if ( ! in_array( $file_name, $templates_without_main_tag ) ) {
+									$templates_without_main_tag[] = $file_name;
+								}
+							}
+						}


checks/class-skip-links.php

+		foreach ( $files as $file ) {
+			if ( is_file( $file ) ) {
+				$contents = file_get_contents( $file );
+				$pattern  = '/\* Slug: ' . preg_quote( $slug, '/' ) . '\b/';
+				if ( preg_match( $pattern, $contents ) ) {
+					$has_tag = strpos( $contents, '<main' ) !== false;
+					if ( ! $has_tag ) {


checks/class-skip-links.php

+		$directory = 'patterns';
+		$theme_dir = $this->wp_theme->get_stylesheet_directory();
+
+		if ( ! is_dir( $theme_dir . '/' . $directory ) ) {
+			$directory = 'block-patterns';
+		}
+		if ( ! is_dir( $theme_dir . '/' . $directory ) ) {
+			return false;
+		}
+
+		$files = glob( $theme_dir . '/' . $directory . '/*.php' );


checks/class-skip-links.php

+					if ( ! $has_tag ) {
+						$nested_patterns_slugs = $this->template_has_patterns( $contents );
+						if ( $nested_patterns_slugs ) {
+							foreach ( $nested_patterns_slugs as $slug ) {
+								$has_tag = $this->pattern_has_tag( $slug );


checks/class-skip-links.php

+
+		$info                       = '';
+		$templates_without_main_tag = array();
+


MaggieCabrera added 2 commits September 3, 2024 12:35

adds skip links check for block themes

c8f16a3

fixed formatting

db23a46

MaggieCabrera marked this pull request as draft September 3, 2024 11:05

kafleg assigned MaggieCabrera Sep 3, 2024

kafleg added the enhancement label Sep 3, 2024

check inside patterns for a main tag

382d151

MaggieCabrera marked this pull request as ready for review September 5, 2024 15:10

fix formatting

0875502

matiasbenedetto reviewed Sep 6, 2024

View reviewed changes

checks/class-skip-links.php Show resolved Hide resolved

matiasbenedetto reviewed Sep 9, 2024

View reviewed changes

MaggieCabrera added 3 commits September 11, 2024 17:14

change is block theme check to use function

b630160

escape html tags

3b2ea37

check for nested patterns

1aa08ce

matiasbenedetto reviewed Sep 16, 2024

View reviewed changes

checks/class-skip-links.php Outdated Show resolved Hide resolved

Update checks/class-skip-links.php

17ee421

Co-authored-by: Matias Benedetto <matias.benedetto@gmail.com>

matiasbenedetto reviewed Sep 16, 2024

View reviewed changes

checks/class-skip-links.php Outdated Show resolved Hide resolved

matiasbenedetto reviewed Sep 16, 2024

View reviewed changes

matiasbenedetto reviewed Sep 17, 2024

View reviewed changes

checks/class-skip-links.php Show resolved Hide resolved

MaggieCabrera added 2 commits October 31, 2024 10:35

return false when check fails

508a151

avoid duplicated file names

ed39dbb

MaggieCabrera added 2 commits October 31, 2024 11:00

don't traverse file contents

e186040

fix format

dabaf1d

matiasbenedetto reviewed Nov 6, 2024

View reviewed changes

carolinan requested a review from Copilot March 19, 2026 09:50

Copilot AI reviewed Mar 19, 2026

View reviewed changes

	// Add FSE specific checks.
	$themechecks[] = new FSE_Required_Files_Check();

		$file_name = tc_filename( $php_key );
		$has_main_tag = strpos( $file, '<main' ) !== false;

Conversation

MaggieCabrera commented Sep 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MaggieCabrera commented Sep 3, 2024

Uh oh!

Uh oh!

matiasbenedetto left a comment

Choose a reason for hiding this comment

Uh oh!

matiasbenedetto commented Sep 9, 2024

Uh oh!

MaggieCabrera commented Sep 11, 2024

Uh oh!

Uh oh!

Uh oh!

matiasbenedetto Sep 16, 2024

Choose a reason for hiding this comment

Uh oh!

MaggieCabrera Oct 31, 2024

Choose a reason for hiding this comment

Uh oh!

MaggieCabrera Oct 31, 2024

Choose a reason for hiding this comment

Uh oh!

kafleg commented Sep 17, 2024

Uh oh!

kafleg commented Sep 17, 2024

Uh oh!

kafleg commented Sep 17, 2024

Uh oh!

MaggieCabrera commented Sep 17, 2024

Uh oh!

kafleg commented Sep 17, 2024

Uh oh!

kafleg commented Sep 17, 2024

Uh oh!

Uh oh!

MaggieCabrera commented Oct 31, 2024

Uh oh!

MaggieCabrera commented Oct 31, 2024

Uh oh!

matiasbenedetto Nov 6, 2024

Choose a reason for hiding this comment

Uh oh!

matiasbenedetto left a comment • 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!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

MaggieCabrera commented Sep 3, 2024 •

edited

Loading

matiasbenedetto left a comment •

edited

Loading