Skip to content

Template activation: improve back compat #72223

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ellatrix merged 19 commits into from
Oct 14, 2025
Merged

Template activation: improve back compat #72223

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
18797bb
Template activation: improve back compat
ellatrix Oct 9, 2025
115d1ad
lint
ellatrix Oct 9, 2025
3ab2657
fix override
ellatrix Oct 9, 2025
fd6350c
todo
ellatrix Oct 9, 2025
2532335
Add theme field to non db templates
ellatrix Oct 10, 2025
3c33645
Invalidate site setting on template update
ellatrix Oct 10, 2025
8d46498
make sure to only invalidate after updates
ellatrix Oct 10, 2025
c166ecb
Use old entities for site editor root
ellatrix Oct 10, 2025
47e3511
fix baseurl
ellatrix Oct 10, 2025
5db3f6c
typo
ellatrix Oct 10, 2025
6668287
get_block_templates and entity collection back compat
ellatrix Oct 13, 2025
d53b1c8
lint
ellatrix Oct 13, 2025
2945540
Don't filter when querying by wp_id
ellatrix Oct 13, 2025
5ebb1f5
Fix post editor query
ellatrix Oct 13, 2025
d405e56
Fix e2e test
ellatrix Oct 13, 2025
a2cb82b
backport
ellatrix Oct 13, 2025
272ac55
Try to stabilise dataviews search in e2e
ellatrix Oct 14, 2025
cd074ae
comments
ellatrix Oct 14, 2025
a6e06b2
typo
ellatrix Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions backport-changelog/6.9/8063.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ https://github.com/WordPress/wordpress-develop/pull/8063
* https://github.com/WordPress/gutenberg/pull/72049
* https://github.com/WordPress/gutenberg/pull/72011
* https://github.com/WordPress/gutenberg/pull/72141
* https://github.com/WordPress/gutenberg/pull/72223
271 changes: 270 additions & 1 deletion lib/compat/wordpress-6.9/template-activate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ function gutenberg_maintain_templates_routes() {
// templates controller, so we need to check if the id is an
// integer to make sure it's the proper post type endpoint.
if ( ! is_int( $post_arr['id'] ) ) {
return null;
// See _build_block_template_result_from_file, registered
// templates always set the theme to the active theme.
return get_stylesheet();
}
$terms = get_the_terms( $post_arr['id'], 'wp_theme' );
if ( is_wp_error( $terms ) || empty( $terms ) ) {
Expand Down Expand Up @@ -524,3 +526,270 @@ function gutenberg_migrate_existing_templates() {

update_option( 'active_templates', $active_templates );
}

add_action( 'save_post_wp_template', 'gutenberg_maybe_update_active_templates' );
function gutenberg_maybe_update_active_templates( $post_id ) {
$post = get_post( $post_id );
$is_inactive_by_default = get_post_meta( $post_id, 'is_inactive_by_default', true );
if ( $is_inactive_by_default ) {
return;
}
$active_templates = get_option( 'active_templates', array() );
$active_templates[ $post->post_name ] = $post->ID;
update_option( 'active_templates', $active_templates );
}

add_action( 'pre_get_block_template', 'gutenberg_get_block_template', 10, 3 );

///////////////////////////////////////////////////////////////////////
// This function is a copy of core's, except for the marked section. //
///////////////////////////////////////////////////////////////////////
function gutenberg_get_block_template( $output, $id, $template_type ) {
if ( 'wp_template' !== $template_type ) {
return $output;
}
$parts = explode( '//', $id, 2 );
if ( count( $parts ) < 2 ) {
return null;
}
list( $theme, $slug ) = $parts;

//////////////////////////////
// START CORE MODIFICATIONS //
//////////////////////////////
$active_templates = get_option( 'active_templates', array() );

if ( ! empty( $active_templates[ $slug ] ) ) {
if ( is_int( $active_templates[ $slug ] ) ) {
$post = get_post( $active_templates[ $slug ] );
if ( $post && 'publish' === $post->post_status ) {
$template = _build_block_template_result_from_post( $post );

if ( ! is_wp_error( $template ) && $theme === $template->theme ) {
return $template;
}
}
} elseif ( false === $active_templates[ $slug ] ) {
return null;
}
}
////////////////////////////
// END CORE MODIFICATIONS //
////////////////////////////

$wp_query_args = array(
'post_name__in' => array( $slug ),
'post_type' => $template_type,
'post_status' => array( 'auto-draft', 'draft', 'publish', 'trash' ),
'posts_per_page' => 1,
'no_found_rows' => true,
'tax_query' => array(
array(
'taxonomy' => 'wp_theme',
'field' => 'name',
'terms' => $theme,
),
),
);
$template_query = new WP_Query( $wp_query_args );
$posts = $template_query->posts;

if ( count( $posts ) > 0 ) {
$template = _build_block_template_result_from_post( $posts[0] );

//////////////////////////////
// START CORE MODIFICATIONS //
//////////////////////////////
// Custom templates don't need to be activated, so if it's a custom
// template, return it.
if ( ! is_wp_error( $template ) && $template->is_custom ) {
return $template;
}
////////////////////////////
// END CORE MODIFICATIONS //
////////////////////////////
}

$block_template = get_block_file_template( $id, $template_type );

/**
* Filters the queried block template object after it's been fetched.
*
* @since 5.9.0
*
* @param WP_Block_Template|null $block_template The found block template, or null if there isn't one.
* @param string $id Template unique identifier (example: 'theme_slug//template_slug').
* @param string $template_type Template type. Either 'wp_template' or 'wp_template_part'.
*/
return apply_filters( 'get_block_template', $block_template, $id, $template_type );
}

add_action( 'pre_get_block_templates', 'gutenberg_get_block_templates', 10, 3 );

///////////////////////////////////////////////////////////////////////
// This function is a copy of core's, except for the marked section. //
///////////////////////////////////////////////////////////////////////
function gutenberg_get_block_templates( $output, $query = array(), $template_type = 'wp_template' ) {
if ( 'wp_template' !== $template_type ) {
return $output;
}

$post_type = isset( $query['post_type'] ) ? $query['post_type'] : '';
$wp_query_args = array(
'post_status' => array( 'auto-draft', 'draft', 'publish' ),
'post_type' => $template_type,
'posts_per_page' => -1,
'no_found_rows' => true,
'lazy_load_term_meta' => false,
'tax_query' => array(
array(
'taxonomy' => 'wp_theme',
'field' => 'name',
'terms' => get_stylesheet(),
),
),
);

if ( ! empty( $query['slug__in'] ) ) {
$wp_query_args['post_name__in'] = $query['slug__in'];
$wp_query_args['posts_per_page'] = count( array_unique( $query['slug__in'] ) );
}

// This is only needed for the regular templates/template parts post type listing and editor.
if ( isset( $query['wp_id'] ) ) {
$wp_query_args['p'] = $query['wp_id'];
} else {
$wp_query_args['post_status'] = 'publish';
}

//////////////////////////////
// START CORE MODIFICATIONS //
//////////////////////////////
$active_templates = get_option( 'active_templates', array() );
////////////////////////////
// END CORE MODIFICATIONS //
////////////////////////////

$template_query = new WP_Query( $wp_query_args );
$query_result = array();
foreach ( $template_query->posts as $post ) {
$template = _build_block_template_result_from_post( $post );

if ( is_wp_error( $template ) ) {
continue;
}

if ( $post_type && ! $template->is_custom ) {
continue;
}

if (
$post_type &&
isset( $template->post_types ) &&
! in_array( $post_type, $template->post_types, true )
) {
continue;
}

//////////////////////////////
// START CORE MODIFICATIONS //
//////////////////////////////
if ( $template->is_custom || isset( $query['wp_id'] ) ) {
// Custom templates don't need to be activated, leave them be.
// Also don't filter out templates when querying by wp_id.
$query_result[] = $template;
} elseif ( isset( $active_templates[ $template->slug ] ) && $active_templates[ $template->slug ] === $post->ID ) {
// Only include active templates.
$query_result[] = $template;
}
////////////////////////////
// END CORE MODIFICATIONS //
////////////////////////////
}

if ( ! isset( $query['wp_id'] ) ) {
/*
* If the query has found some user templates, those have priority
* over the theme-provided ones, so we skip querying and building them.
*/
$query['slug__not_in'] = wp_list_pluck( $query_result, 'slug' );
/*
* We need to unset the post_type query param because some templates
* would be excluded otherwise, like `page.html` when looking for
* `page` templates. We need all templates so we can exclude duplicates
* from plugin-registered templates.
* See: https://github.com/WordPress/gutenberg/issues/65584
*/
$template_files_query = $query;
unset( $template_files_query['post_type'] );
$template_files = _get_block_templates_files( $template_type, $template_files_query );
foreach ( $template_files as $template_file ) {
// If the query doesn't specify a post type, or it does and the template matches the post type, add it.
if (
! isset( $query['post_type'] ) ||
(
isset( $template_file['postTypes'] ) &&
in_array( $query['post_type'], $template_file['postTypes'], true )
)
) {
$query_result[] = _build_block_template_result_from_file( $template_file, $template_type );
} elseif ( ! isset( $template_file['postTypes'] ) ) {
// The custom templates with no associated post types are available for all post types as long
// as they are not default templates.
$candidate = _build_block_template_result_from_file( $template_file, $template_type );
$default_template_types = get_default_block_template_types();
if ( ! isset( $default_template_types[ $candidate->slug ] ) ) {
$query_result[] = $candidate;
}
}
}

if ( 'wp_template' === $template_type ) {
// Add templates registered in the template registry. Filtering out the ones which have a theme file.
$registered_templates = WP_Block_Templates_Registry::get_instance()->get_by_query( $query );
$matching_registered_templates = array_filter(
$registered_templates,
function ( $registered_template ) use ( $template_files ) {
foreach ( $template_files as $template_file ) {
if ( $template_file['slug'] === $registered_template->slug ) {
return false;
}
}
return true;
}
);

$matching_registered_templates = array_map(
function ( $template ) {
$template->content = apply_block_hooks_to_content(
$template->content,
$template,
'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata'
);
return $template;
},
$matching_registered_templates
);

$query_result = array_merge( $query_result, $matching_registered_templates );
}
}

/**
* Filters the array of queried block templates array after they've been fetched.
*
* @since 5.9.0
*
* @param WP_Block_Template[] $query_result Array of found block templates.
* @param array $query {
* Arguments to retrieve templates. All arguments are optional.
*
* @type string[] $slug__in List of slugs to include.
* @type int $wp_id Post ID of customized template.
* @type string $area A 'wp_template_part_area' taxonomy value to filter by (for 'wp_template_part' template type only).
* @type string $post_type Post type to get the templates for.
* }
* @param string $template_type wp_template or wp_template_part.
*/
return apply_filters( 'get_block_templates', $query_result, $query, $template_type );
}
71 changes: 27 additions & 44 deletions packages/core-data/src/actions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,8 +323,20 @@ export const deleteEntityRecord =
} );

let hasError = false;
let { baseURL } = entityConfig;
if (
kind === 'postType' &&
name === 'wp_template' &&
recordId &&
typeof recordId === 'string' &&
! /^\d+$/.test( recordId )
) {
baseURL =
baseURL.slice( 0, baseURL.lastIndexOf( '/' ) ) +
'/templates';
Copy link
Member Author

@ellatrix ellatrix Oct 10, 2025

Choose a reason for hiding this comment

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

I thought about moving this to the entity config, but that's only called once on init so it's not possible to have a dynamic baseURL without creating a new API, so I think it might be better left here.

Copy link
Contributor

@mcsf mcsf Oct 14, 2025

Choose a reason for hiding this comment

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

Worth encapsulating as a function of (baseURL, kind, name, recordId) -> baseURL? That way we can document the rationale right in that function. I'm just thinking of what will make this less of a burden for maintainers and reviewers in the long term.

}
try {
let path = `${ entityConfig.baseURL }/${ recordId }`;
let path = `${ baseURL }/${ recordId }`;

if ( query ) {
path = addQueryArgs( path, query );
Expand Down Expand Up @@ -521,46 +533,6 @@ export const saveEntityRecord =
const entityIdKey = entityConfig.key || DEFAULT_ENTITY_KEY;
const recordId = record[ entityIdKey ];

// When called with a theme template ID, trigger the compatibility
// logic.
if (
kind === 'postType' &&
name === 'wp_template' &&
typeof recordId === 'string' &&
! /^\d+$/.test( recordId )
) {
// Get the theme template.
const template = await select.getEntityRecord(
'postType',
'wp_registered_template',
recordId
);
// Duplicate the theme template and make the edit.
const newTemplate = await dispatch.saveEntityRecord(
'postType',
'wp_template',
{
...template,
...record,
id: undefined,
type: 'wp_template',
status: 'publish',
}
);
// Make the new template active.
const activeTemplates = await select.getEntityRecord(
'root',
'site'
);
await dispatch.saveEntityRecord( 'root', 'site', {
active_templates: {
...activeTemplates.active_templates,
[ newTemplate.slug ]: newTemplate.id,
},
} );
return newTemplate;
}

const lock = await dispatch.__unstableAcquireStoreLock(
STORE_NAME,
[ 'entities', 'records', kind, name, recordId || uuid() ],
Expand Down Expand Up @@ -598,10 +570,21 @@ export const saveEntityRecord =
let updatedRecord;
let error;
let hasError = false;
let { baseURL } = entityConfig;
// For "string" IDs, use the old templates endpoint.
if (
kind === 'postType' &&
name === 'wp_template' &&
recordId &&
typeof recordId === 'string' &&
! /^\d+$/.test( recordId )
) {
baseURL =
baseURL.slice( 0, baseURL.lastIndexOf( '/' ) ) +
'/templates';
}
try {
const path = `${ entityConfig.baseURL }${
recordId ? '/' + recordId : ''
}`;
const path = `${ baseURL }${ recordId ? '/' + recordId : '' }`;
const persistedRecord = select.getRawEntityRecord(
kind,
name,
Expand Down
Loading
Loading