Skip to content

Commit a9df7c5

Browse files
ellatrixellatrix
committed
initial changes
1 parent 7ad8e49 commit a9df7c5

File tree

7 files changed

+243
-8
lines changed

7 files changed

+243
-8
lines changed

‎src/wp-includes/block-template-utils.php‎

Lines changed: 102 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1074,6 +1074,46 @@ function _build_block_template_result_from_post( $post ) {
10741074
return $template;
10751075
}
10761076

1077+
function get_registered_block_templates( $query ) {
1078+
$template_files = _get_block_templates_files( 'wp_template', $query );
1079+
$query_result = array();
1080+
1081+
// _get_block_templates_files seems broken, it does not obey the query.
1082+
if ( isset( $query['slug__in'] ) && is_array( $query['slug__in'] ) ) {
1083+
$template_files = array_filter(
1084+
$template_files,
1085+
function ( $template_file ) use ( $query ) {
1086+
return in_array( $template_file['slug'], $query['slug__in'], true );
1087+
}
1088+
);
1089+
}
1090+
1091+
foreach ( $template_files as $template_file ) {
1092+
$query_result[] = _build_block_template_result_from_file( $template_file, 'wp_template' );
1093+
}
1094+
1095+
// Add templates registered through the template registry. Filtering out the
1096+
// ones which have a theme file.
1097+
$registered_templates = WP_Block_Templates_Registry::get_instance()->get_by_query( $query );
1098+
$matching_registered_templates = array_filter(
1099+
$registered_templates,
1100+
function ( $registered_template ) use ( $template_files ) {
1101+
foreach ( $template_files as $template_file ) {
1102+
if ( $template_file['slug'] === $registered_template->slug ) {
1103+
return false;
1104+
}
1105+
}
1106+
return true;
1107+
}
1108+
);
1109+
1110+
$query_result = array_merge( $query_result, $matching_registered_templates );
1111+
1112+
// Templates added by PHP filter also count as registered templates.
1113+
/** This filter is documented in wp-includes/block-template-utils.php */
1114+
return apply_filters( 'get_block_templates', $query_result, $query, 'wp_template' );
1115+
}
1116+
10771117
/**
10781118
* Retrieves a list of unified template objects based on a query.
10791119
*
@@ -1152,6 +1192,8 @@ function get_block_templates( $query = array(), $template_type = 'wp_template' )
11521192
$wp_query_args['post_status'] = 'publish';
11531193
}
11541194

1195+
$active_templates = get_option( 'active_templates', array() );
1196+
11551197
$template_query = new WP_Query( $wp_query_args );
11561198
$query_result = array();
11571199
foreach ( $template_query->posts as $post ) {
@@ -1173,7 +1215,14 @@ function get_block_templates( $query = array(), $template_type = 'wp_template' )
11731215
continue;
11741216
}
11751217

1176-
$query_result[] = $template;
1218+
if ( $template->is_custom || isset( $query['wp_id'] ) ) {
1219+
// Custom templates don't need to be activated, leave them be.
1220+
// Also don't filter out templates when querying by wp_id.
1221+
$query_result[] = $template;
1222+
} elseif ( isset( $active_templates[ $template->slug ] ) && $active_templates[ $template->slug ] === $post->ID ) {
1223+
// Only include active templates.
1224+
$query_result[] = $template;
1225+
}
11771226
}
11781227

11791228
if ( ! isset( $query['wp_id'] ) ) {
@@ -1296,6 +1345,24 @@ function get_block_template( $id, $template_type = 'wp_template' ) {
12961345
return null;
12971346
}
12981347
list( $theme, $slug ) = $parts;
1348+
1349+
$active_templates = get_option( 'active_templates', array() );
1350+
1351+
if ( ! empty( $active_templates[ $slug ] ) ) {
1352+
if ( is_int( $active_templates[ $slug ] ) ) {
1353+
$post = get_post( $active_templates[ $slug ] );
1354+
if ( $post && 'publish' === $post->post_status ) {
1355+
$template = _build_block_template_result_from_post( $post );
1356+
1357+
if ( ! is_wp_error( $template ) && $theme === $template->theme ) {
1358+
return $template;
1359+
}
1360+
}
1361+
} elseif ( false === $active_templates[ $slug ] ) {
1362+
return null;
1363+
}
1364+
}
1365+
12991366
$wp_query_args = array(
13001367
'post_name__in' => array( $slug ),
13011368
'post_type' => $template_type,
@@ -1316,6 +1383,12 @@ function get_block_template( $id, $template_type = 'wp_template' ) {
13161383
if ( count( $posts ) > 0 ) {
13171384
$template = _build_block_template_result_from_post( $posts[0] );
13181385

1386+
// Custom templates don't need to be activated, so if it's a custom
1387+
// template, return it.
1388+
if ( ! is_wp_error( $template ) && $template->is_custom ) {
1389+
return $template;
1390+
}
1391+
13191392
if ( ! is_wp_error( $template ) ) {
13201393
return $template;
13211394
}
@@ -1779,3 +1852,31 @@ function inject_ignored_hooked_blocks_metadata_attributes( $changes, $deprecated
17791852

17801853
return $changes;
17811854
}
1855+
1856+
function wp_assign_new_template_to_theme( $changes, $request ) {
1857+
// Do not run this for templates created through the old enpoint.
1858+
$template = $request['id'] ? get_block_template( $request['id'], 'wp_template' ) : null;
1859+
if ( $template ) {
1860+
return $changes;
1861+
}
1862+
$changes->tax_input = array(
1863+
'wp_theme' => isset( $request['theme'] ) ? $request['theme'] : get_stylesheet(),
1864+
);
1865+
// All new templates saved will receive meta so we can distinguish between
1866+
// templates created the old way as edits and templates created the new way.
1867+
$changes->meta_input = array(
1868+
'is_inactive_by_default' => true,
1869+
);
1870+
return $changes;
1871+
}
1872+
1873+
function wp_maybe_activate_template( $post_id ) {
1874+
$post = get_post( $post_id );
1875+
$is_inactive_by_default = get_post_meta( $post_id, 'is_inactive_by_default', true );
1876+
if ( $is_inactive_by_default ) {
1877+
return;
1878+
}
1879+
$active_templates = get_option( 'active_templates', array() );
1880+
$active_templates[ $post->post_name ] = $post->ID;
1881+
update_option( 'active_templates', $active_templates );
1882+
}

‎src/wp-includes/block-template.php‎

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,11 +164,77 @@ function resolve_block_template( $template_type, $template_hierarchy, $fallback_
164164
$template_hierarchy
165165
);
166166

167-
// Find all potential templates 'wp_template' post matching the hierarchy.
167+
$object = get_queried_object();
168+
$specific_template = $object ? get_page_template_slug( $object ) : null;
169+
$active_templates = (array) get_option( 'active_templates', array() );
170+
171+
// Remove templates slugs that are deactivated, except if it's the specific
172+
// template or index.
173+
$slugs = array_filter(
174+
$slugs,
175+
function ( $slug ) use ( $specific_template, $active_templates ) {
176+
$should_ignore = $slug === $specific_template || 'index' === $slug;
177+
return $should_ignore || ( ! isset( $active_templates[ $slug ] ) || false !== $active_templates[ $slug ] );
178+
}
179+
);
180+
181+
// We expect one template for each slug. Use the active template if it is
182+
// set and exists. Otherwise use the static template.
183+
$templates = array();
184+
$remaining_slugs = array();
185+
186+
foreach ( $slugs as $slug ) {
187+
if ( $slug === $specific_template || empty( $active_templates[ $slug ] ) ) {
188+
$remaining_slugs[] = $slug;
189+
continue;
190+
}
191+
192+
// TODO: it need to be possible to set a static template as active.
193+
$post = get_post( $active_templates[ $slug ] );
194+
if ( ! $post || 'publish' !== $post->post_status ) {
195+
$remaining_slugs[] = $slug;
196+
continue;
197+
}
198+
199+
$template = _build_block_template_result_from_post( $post );
200+
201+
// Ensure the active templates are associated with the active theme.
202+
// See _build_block_template_object_from_post_object.
203+
if ( get_stylesheet() !== $template->theme ) {
204+
$remaining_slugs[] = $slug;
205+
continue;
206+
}
207+
208+
$templates[] = $template;
209+
}
210+
211+
// Apply the filter to the active templates for backward compatibility.
212+
/** This filter is documented in wp-includes/block-template-utils.php */
213+
if ( ! empty( $templates ) ) {
214+
$templates = apply_filters(
215+
'get_block_templates',
216+
$templates,
217+
array(
218+
'slug__in' => array_map(
219+
function ( $template ) {
220+
return $template->slug;
221+
},
222+
$templates
223+
),
224+
),
225+
'wp_template'
226+
);
227+
}
228+
229+
// For any remaining slugs, use the static template.
168230
$query = array(
169-
'slug__in' => $slugs,
231+
'slug__in' => $remaining_slugs,
170232
);
171-
$templates = get_block_templates( $query );
233+
$templates = array_merge( $templates, gutenberg_get_registered_block_templates( $query ) );
234+
235+
if ( $specific_template ) {
236+
$templates = array_merge( $templates, get_block_templates( array( 'slug__in' => array( $specific_template ) ) ) );
237+
}
172238

173239
// Order these templates per slug priority.
174240
// Build map of template slugs to their priority in the current hierarchy.

‎src/wp-includes/default-filters.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -738,6 +738,7 @@
738738
// Block templates post type and rendering.
739739
add_filter( 'render_block_context', '_block_template_render_without_post_block_context' );
740740
add_filter( 'pre_wp_unique_post_slug', 'wp_filter_wp_template_unique_post_slug', 10, 5 );
741+
add_action( 'save_post_wp_template', 'wp_maybe_activate_template' );
741742
add_action( 'save_post_wp_template_part', 'wp_set_unique_slug_on_create_template_part' );
742743
add_action( 'wp_enqueue_scripts', 'wp_enqueue_block_template_skip_link' );
743744
add_action( 'wp_footer', 'the_block_template_skip_link' ); // Retained for backwards-compatibility. Unhooked by wp_enqueue_block_template_skip_link().
@@ -778,6 +779,10 @@
778779
add_filter( 'rest_pre_insert_wp_template', 'inject_ignored_hooked_blocks_metadata_attributes' );
779780
add_filter( 'rest_pre_insert_wp_template_part', 'inject_ignored_hooked_blocks_metadata_attributes' );
780781

782+
// Assign the wp_theme term to any newly created wp_template with the new endpoint.
783+
// Must run before `inject_ignored_hooked_blocks_metadata_attributes`.
784+
add_action( 'rest_pre_insert_wp_template', 'wp_assign_new_template_to_theme', 9, 2 );
785+
781786
// Update ignoredHookedBlocks postmeta for some post types.
782787
add_filter( 'rest_pre_insert_page', 'update_ignored_hooked_blocks_postmeta' );
783788
add_filter( 'rest_pre_insert_post', 'update_ignored_hooked_blocks_postmeta' );

‎src/wp-includes/option.php‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2959,6 +2959,25 @@ function register_initial_settings() {
29592959
'description' => __( 'Allow people to submit comments on new posts.' ),
29602960
)
29612961
);
2962+
2963+
register_setting(
2964+
'reading',
2965+
'active_templates',
2966+
array(
2967+
'type' => 'object',
2968+
// Do not set the default value to an empty array! For some reason
2969+
// that will prevent the option from being set to an empty array.
2970+
'show_in_rest' => array(
2971+
'schema' => array(
2972+
'type' => 'object',
2973+
// Properties can be integers, strings, or false
2974+
// (deactivated).
2975+
'additionalProperties' => true,
2976+
),
2977+
),
2978+
'label' => 'Active Templates',
2979+
)
2980+
);
29622981
}
29632982

29642983
/**

‎src/wp-includes/post.php‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -378,10 +378,8 @@ function create_initial_post_types() {
378378
'show_in_menu' => false,
379379
'show_in_rest' => true,
380380
'rewrite' => false,
381-
'rest_base' => 'templates',
382-
'rest_controller_class' => 'WP_REST_Templates_Controller',
383-
'autosave_rest_controller_class' => 'WP_REST_Template_Autosaves_Controller',
384-
'revisions_rest_controller_class' => 'WP_REST_Template_Revisions_Controller',
381+
'rest_base' => 'wp_template',
382+
'rest_controller_class' => 'WP_REST_Posts_Controller',
385383
'late_route_registration' => true,
386384
'capability_type' => array( 'template', 'templates' ),
387385
'capabilities' => array(
@@ -406,6 +404,7 @@ function create_initial_post_types() {
406404
'editor',
407405
'revisions',
408406
'author',
407+
'custom-fields',
409408
),
410409
)
411410
);
@@ -8610,4 +8609,16 @@ function wp_create_initial_post_meta() {
86108609
),
86118610
)
86128611
);
8612+
8613+
// Allow setting the is_wp_suggestion meta field, which partly determines if
8614+
// a template is a custom template.
8615+
register_post_meta(
8616+
'wp_template',
8617+
'is_wp_suggestion',
8618+
array(
8619+
'type' => 'boolean',
8620+
'show_in_rest' => true,
8621+
'single' => true,
8622+
)
8623+
);
86138624
}

‎src/wp-includes/rest-api.php‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,6 +289,34 @@ function create_initial_rest_routes() {
289289
}
290290
}
291291

292+
// Register the old templates endpoint.
293+
global $wp_post_types;
294+
$wp_post_types['wp_template']->rest_base = 'templates';
295+
$controller = new WP_REST_Templates_Controller( 'wp_template' );
296+
$wp_post_types['wp_template']->rest_base = 'wp_template';
297+
$controller->register_routes();
298+
299+
register_rest_field(
300+
'wp_template',
301+
'theme',
302+
array(
303+
'get_callback' => function ( $post_arr ) {
304+
// add_additional_fields_to_object is also called for the old
305+
// templates controller, so we need to check if the id is an
306+
// integer to make sure it's the proper post type endpoint.
307+
if ( ! is_int( $post_arr['id'] ) ) {
308+
$template = get_block_template( $post_arr['id'], 'wp_template' );
309+
return $template ? $template->theme : null;
310+
}
311+
$terms = get_the_terms( $post_arr['id'], 'wp_theme' );
312+
if ( is_wp_error( $terms ) || empty( $terms ) ) {
313+
return null;
314+
}
315+
return $terms[0]->slug;
316+
},
317+
)
318+
);
319+
292320
// Post types.
293321
$controller = new WP_REST_Post_Types_Controller();
294322
$controller->register_routes();

‎src/wp-includes/theme-templates.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ function wp_filter_wp_template_unique_post_slug( $override_slug, $slug, $post_id
4949
return $override_slug;
5050
}
5151

52+
// For wp_template, slugs no longer have to be unique within the same theme.
53+
if ( 'wp_template' !== $post_type ) {
54+
return $override_slug;
55+
}
56+
5257
if ( ! $override_slug ) {
5358
$override_slug = $slug;
5459
}

0 commit comments

Comments
 (0)