Expose the Patterns menu to the Classic theme #5201

t-hamano · 2023-09-13T13:00:29Z

Trac ticket: https://core.trac.wordpress.org/ticket/58827

Testing Instructions

In all theme variations, make sure that the appropriate submenus are displayed in the Appearance menu.
Confirm that access is granted or denied as appropriate when accessing each page of the Site Editor.

Block Theme

Activate Twenty Twenty-Three

Block theme with customizer

Activate Twenty Twenty-Three
Create functions.php in the theme directory and add the following code:
```
<?php 
add_action( 'customize_register', '__return_true' );
```

Classic Theme

Activate Twenty Twenty-One

Classic Theme with block-template-parts support

Activate Twenty Twenty-One

Add code to functions.php to opt-in to block template part support

function twenty_twenty_one_setup() {
	add_theme_support( 'block-template-parts' );
	// ...
}

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.

kevin940726

LGTM 👍

aaronrobertshaw

This is mostly testing as advertised for me @t-hamano.

I ran into an issue though when testing Twenty Twenty One with block-template-parts support added. I get the "The theme you are currently using is not compatible with the Site Editor." error.

kevin940726 · 2023-09-14T09:53:24Z

src/wp-admin/site-editor.php

+	if ( ! current_theme_supports( 'block-template-parts' ) && $is_template_part_editor ) {
+		wp_die( __( 'The theme you are currently using is not compatible with the Site Editor.' ) );
+	} elseif ( ! $is_patterns_editor ) {
+		wp_die( __( 'The theme you are currently using is not compatible with the Site Editor.' ) );
+	}


Oops, I think this is blocking classic themes with block-template-parts support to access the template part editor. I think we can adjust it to:

Suggested change

if ( ! current_theme_supports( 'block-template-parts' ) && $is_template_part_editor ) {

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

} elseif ( ! $is_patterns_editor ) {

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

}

if ( ! current_theme_supports( 'block-template-parts' ) || ! $is_template_part_editor && ! $is_patterns_editor ) {

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

}

This fix is almost identical to what I tried locally. With this applied, I can now access all the links as advertised in the PR description.

if ( ! current_theme_supports( 'block-template-parts' ) || ! $is_template_part_editor && ! $is_patterns_editor ) {

In the case of this conditional statement, I think classic themes that do not support block-templates-parts will not be able to access the Patterns page. I think I was able to control all cases correctly with the update using 879cb3b.

aaronrobertshaw

This tests well for me now however I think there is some test code we need to remove before it's ready to land.

src/wp-content/themes/twentytwentyone/functions.php

Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>

t-hamano · 2023-09-20T05:24:17Z

Please let me know if there are any other considerations or potential issues in order to ship this patch and ~~Gutenberg PR~~ Gutenberg PR with WordPress 6.4. Should we also ask someone on the core team for feedback?

aaronrobertshaw · 2023-09-20T05:30:51Z

Should we also ask someone on the core team for feedback?

That would be a wise move I think. I'm caught up on other patterns issues/PRs at the moment but will try and organise another review for this one.

Thanks for the nudge 👍

aaronrobertshaw · 2023-09-20T07:22:16Z

Please let me know if there are any other considerations or potential issues in order to ship this patch and WordPress/gutenberg#54066 with WordPress 6.4. Should we also ask someone on the core team for feedback?

I believe this patch is fine and good to go.

The Gutenberg PR though still has an unaddressed issue that I'd flagged previously. The command palette change in that PR needs reverting so that the user is taken to the same location as the links introduced in this patch for classic themes.

t-hamano · 2023-09-20T08:12:32Z

Update: The Gutenberg PR that corresponds to this core patch is actually #54422. Sorry for causing confusion.

Once this core patch is applied, the classic theme can access the Site Editor's Patterns page by typing site-editor.php?path=/patterns directly. #54422 fixes unintended behavior in such cases.

aaronrobertshaw · 2023-10-03T00:18:52Z

Just noting here that this enhancement has been slated for WP 6.5 as it missed the 6.4 beta
(See https://core.trac.wordpress.org/ticket/58827#comment:9)

getdave · 2024-01-18T14:01:11Z

👋 Hello team. Whats the update on this feature for WP 6.5? Is it likely to land and if so which features (as originally outlined in the roadmap) will make it. Thanks in advance 🙏

t-hamano · 2024-01-19T01:31:32Z

By merging this PR, the following will be achieved in the classic theme as of WP6.5.

Internally allows classic themes direct access to the Site Editor's pattern page (/wp-admin/site-editor.php?path=%2Fpatterns)
Add a link pointing to the pattern post type list page (/wp-admin/edit.php?post_type=wp_block) under Appearance -> Patterns for classic themes.

More details can be found in this comment.

aaronrobertshaw · 2024-01-19T06:44:46Z

@t-hamano's comment covers nicely what will be delivered via this PR. I believe this should be good to go but we might want a quick sanity check review and approval with fresh eyes before doing so.

github-actions · 2024-01-27T02:12:10Z

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

The Plugin and Theme Directories cannot be accessed within Playground.
All changes will be lost when closing a tab with a Playground instance.
All changes will be lost when refreshing the page.
A fresh instance is created each time the link below is clicked.
Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

fabiankaegy

I tested this and it works as expected. I think this is a great feature and I don't see any blockers for it to go into WordPress 6.5.

It's approved from my end 👍

getdave · 2024-02-06T09:37:03Z

I reached out for clarification on this feature in WP Slack as I've heard different things about what the actual experience will be for users of WP 6.5.

github-actions · 2024-02-06T09:37:16Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core SVN

Core Committers: Use this line as a base for the props when committing in SVN:

Props wildworks, kevin940726, aaronrobertshaw, fabiankaegy, swissspidy, get_dave, kebbet.

GitHub Merge commits

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: t-hamano <wildworks@git.wordpress.org>
Co-authored-by: kevin940726 <kevin940726@git.wordpress.org>
Co-authored-by: aaronrobertshaw <aaronrobertshaw@git.wordpress.org>
Co-authored-by: fabiankaegy <fabiankaegy@git.wordpress.org>
Co-authored-by: swissspidy <swissspidy@git.wordpress.org>
Co-authored-by: getdave <get_dave@git.wordpress.org>
Co-authored-by: kebbet <kebbet@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

swissspidy

Just did some testing and it seems to work fine.

This just exposes a page in the menu that was already accessible anyway.

kebbet · 2024-02-06T18:00:44Z

Just tested the PR. It does not work as expected.

My classic theme uses remove_theme_support( 'core-block-pattern' ) to disable patterns. I therefor expected the menu to be hidden. Now the menu is still visible with patterns disabled.

fabiankaegy · 2024-02-06T18:09:13Z

@kebbet the theme support you are removing is only removing the core pattern library. It does not prevent users from being able to create pattern using the UI, nor does it remove any patterns added via plugins or themes.

I'm not aware of any method to remove the patterns functionality as a whole.

So I don't think what you are describing is a blocker for merging this at it is unrelated.

I would recommend you create a new issue for adding the ability to disable patterns altogether if that is what you are hoping to accomplish.

getdave · 2024-02-06T19:11:11Z

@youknowriad Based on x2 approving reviews can we commit this one?

youknowriad · 2024-02-06T19:40:41Z

Commit https://core.trac.wordpress.org/changeset/57543

Expose the Patterns menu to the Classic theme

6a048df

t-hamano marked this pull request as ready for review September 13, 2023 13:15

This was referenced Sep 13, 2023

Site Editor: Allow all classic themes to access Patterns page WordPress/gutenberg#54066

Closed

Site Editor: Consider compatibility regarding non-block themes and the Library menu WordPress/gutenberg#52150

Open

kevin940726 approved these changes Sep 14, 2023

View reviewed changes

aaronrobertshaw reviewed Sep 14, 2023

View reviewed changes

kevin940726 reviewed Sep 14, 2023

View reviewed changes

t-hamano added 2 commits September 14, 2023 19:39

Update if conditional statement

879cb3b

Merge branch 'trunk' into 58827-patterns-menu-classic-theme

e165a3d

aaronrobertshaw reviewed Sep 15, 2023

View reviewed changes

src/wp-content/themes/twentytwentyone/functions.php Outdated Show resolved Hide resolved

Update src/wp-content/themes/twentytwentyone/functions.php

2b5a2b9

Co-authored-by: Aaron Robertshaw <60436221+aaronrobertshaw@users.noreply.github.com>

t-hamano mentioned this pull request Sep 22, 2023

Site Editor: Prevent unintended actions on the classic theme WordPress/gutenberg#54422

Merged

aaronrobertshaw mentioned this pull request Oct 12, 2023

Patterns: Consider a more streamlined way to convert sync status WordPress/gutenberg#53320

Closed

t-hamano added 2 commits November 10, 2023 20:53

Merge branch 'trunk' into 58827-patterns-menu-classic-theme

1562737

Merge branch 'trunk' into 58827-patterns-menu-classic-theme

1404c7a

Merge branch 'trunk' into 58827-patterns-menu-classic-theme

f916fd0

fabiankaegy approved these changes Feb 5, 2024

View reviewed changes

swissspidy approved these changes Feb 6, 2024

View reviewed changes

youknowriad closed this Feb 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose the Patterns menu to the Classic theme #5201

Expose the Patterns menu to the Classic theme #5201

t-hamano commented Sep 13, 2023 •

edited

kevin940726 left a comment

aaronrobertshaw left a comment

kevin940726 Sep 14, 2023

aaronrobertshaw Sep 14, 2023

t-hamano Sep 14, 2023

aaronrobertshaw left a comment

t-hamano commented Sep 20, 2023 •

edited

aaronrobertshaw commented Sep 20, 2023

aaronrobertshaw commented Sep 20, 2023

t-hamano commented Sep 20, 2023 •

edited

aaronrobertshaw commented Oct 3, 2023 •

edited

getdave commented Jan 18, 2024

t-hamano commented Jan 19, 2024

aaronrobertshaw commented Jan 19, 2024

github-actions bot commented Jan 27, 2024

fabiankaegy left a comment

getdave commented Feb 6, 2024

github-actions bot commented Feb 6, 2024 •

edited

swissspidy left a comment

kebbet commented Feb 6, 2024 •

edited

fabiankaegy commented Feb 6, 2024

getdave commented Feb 6, 2024

youknowriad commented Feb 6, 2024

Expose the Patterns menu to the Classic theme #5201

Expose the Patterns menu to the Classic theme #5201

Conversation

t-hamano commented Sep 13, 2023 • edited

Testing Instructions

Block Theme

Block theme with customizer

Classic Theme

Classic Theme with block-template-parts support

kevin940726 left a comment

Choose a reason for hiding this comment

aaronrobertshaw left a comment

Choose a reason for hiding this comment

kevin940726 Sep 14, 2023

Choose a reason for hiding this comment

aaronrobertshaw Sep 14, 2023

Choose a reason for hiding this comment

t-hamano Sep 14, 2023

Choose a reason for hiding this comment

aaronrobertshaw left a comment

Choose a reason for hiding this comment

t-hamano commented Sep 20, 2023 • edited

aaronrobertshaw commented Sep 20, 2023

aaronrobertshaw commented Sep 20, 2023

t-hamano commented Sep 20, 2023 • edited

aaronrobertshaw commented Oct 3, 2023 • edited

getdave commented Jan 18, 2024

t-hamano commented Jan 19, 2024

aaronrobertshaw commented Jan 19, 2024

github-actions bot commented Jan 27, 2024

Test using WordPress Playground

Some things to be aware of

fabiankaegy left a comment

Choose a reason for hiding this comment

getdave commented Feb 6, 2024

github-actions bot commented Feb 6, 2024 • edited

Core SVN

GitHub Merge commits

swissspidy left a comment

Choose a reason for hiding this comment

kebbet commented Feb 6, 2024 • edited

fabiankaegy commented Feb 6, 2024

getdave commented Feb 6, 2024

youknowriad commented Feb 6, 2024

t-hamano commented Sep 13, 2023 •

edited

t-hamano commented Sep 20, 2023 •

edited

t-hamano commented Sep 20, 2023 •

edited

aaronrobertshaw commented Oct 3, 2023 •

edited

github-actions bot commented Feb 6, 2024 •

edited

kebbet commented Feb 6, 2024 •

edited