Skip to content

Template activation: call get_block_templates filter when short-circuiting#71840

Merged
ellatrix merged 3 commits intotrunkfrom
add/template-activation-compat-filter
Oct 7, 2025
Merged

Template activation: call get_block_templates filter when short-circuiting#71840
ellatrix merged 3 commits intotrunkfrom
add/template-activation-compat-filter

Conversation

@ellatrix
Copy link
Copy Markdown
Member

@ellatrix ellatrix commented Sep 23, 2025

What?

Closes #71770

Why?

Some plugins expect get_block_templates to always be called, which no longer happens when we return a template through pre_get_block_templates.

How?

Run the get_block_templates filter ourselves before returning the new template.

Testing Instructions

add_filter(
	'get_block_templates',
	function ( $templates, $query ) {
		do_action( 'qm/debug', $query );
		array_map(
			function ( $template ) {
				do_action( 'qm/debug', $template ); // use any method to log data
			},
			$templates
		);
		return $templates;
	},
	10,
	2
);

Run this code to log when get_block_templates is called. For example, when activating a custom 404 template, it should still log a call with the 404 template, not just the index template.

Testing Instructions for Keyboard

Screenshots or screencast

Before After

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Sep 23, 2025

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.

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: ellatrix <ellatrix@git.wordpress.org>
Co-authored-by: kmanijak <karolmanijak@git.wordpress.org>

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

kmanijak
kmanijak approved these changes Sep 23, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@kmanijak kmanijak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confirm the hook is fired and so it's always called allowing plugins like WooCommerce to react on it and update templates. 🙌

@ellatrix ellatrix force-pushed the add/template-activation-compat-filter branch 2 times, most recently from e245cd9 to 4ea6042 Compare October 1, 2025 17:40
@ellatrix ellatrix added this to the Gutenberg 21.8 milestone Oct 1, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 1, 2025

Flaky tests detected in 4ea6042.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/18170683104
📝 Reported issues:

@ellatrix ellatrix added the [Type] Bug An existing feature does not function as intended label Oct 2, 2025
@ellatrix ellatrix force-pushed the add/template-activation-compat-filter branch from 4ea6042 to 098a18c Compare October 7, 2025 19:02
@ellatrix ellatrix enabled auto-merge (squash) October 7, 2025 19:03
@ellatrix ellatrix merged commit 5c20c7b into trunk Oct 7, 2025
112 of 114 checks passed
@ellatrix ellatrix deleted the add/template-activation-compat-filter branch October 7, 2025 20:15
@ellatrix ellatrix added the Backport to Gutenberg RC Pull request that needs to be backported to a Gutenberg release candidate (RC) label Oct 7, 2025
@kmanijak kmanijak mentioned this pull request Oct 8, 2025
Closed
cbravobernal pushed a commit that referenced this pull request Oct 8, 2025
@ellatrix @cbravobernal
Template activation: call get_block_templates filter when short-circu…
dc60d4e 
…iting (#71840)

Co-authored-by: ellatrix <ellatrix@git.wordpress.org>
Co-authored-by: kmanijak <karolmanijak@git.wordpress.org>
@cbravobernal
Copy link
Copy Markdown
Contributor

cbravobernal commented Oct 8, 2025

I just cherry-picked this PR to the release/21.8 branch to get it included in the next release: dc60d4e

@cbravobernal cbravobernal removed the Backport to Gutenberg RC Pull request that needs to be backported to a Gutenberg release candidate (RC) label Oct 8, 2025
sidharthpandita1 pushed a commit to sidharthpandita1/gutenberg that referenced this pull request Oct 10, 2025
@ellatrix @sidharthpandita1
Template activation: call get_block_templates filter when short-circu…
64dac6a 
…iting (WordPress#71840)

Co-authored-by: ellatrix <ellatrix@git.wordpress.org>
Co-authored-by: kmanijak <karolmanijak@git.wordpress.org>
@github-actions github-actions Bot mentioned this pull request Oct 16, 2025
Closed
@ellatrix ellatrix mentioned this pull request Oct 20, 2025
Closed
ellatrix added a commit that referenced this pull request Nov 5, 2025
@ellatrix
Revert "Template activation: call get_block_templates filter when sho…
1bb3abc 
…rt-circuiting (#71840)"

This reverts commit 5c20c7b.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kmanijak kmanijak kmanijak approved these changes

@spacedmonkey spacedmonkey Awaiting requested review from spacedmonkey spacedmonkey is a code owner

Assignees

No one assigned

Labels

[Type] Bug An existing feature does not function as intended

Projects

None yet

Milestone

Gutenberg 21.8

Development

Successfully merging this pull request may close these issues.

[Template Activation] get_block_templates returns edited template as index

3 participants

@ellatrix @cbravobernal @kmanijak