Changeset 55687 for trunk/src/wp-includes/block-template-utils.php

Timestamp:

04/26/2023 02:38:43 PM (18 months ago)

Author:

oandregal

Message:

Themes: improve performance of get_block_templates().

get_block_templates() is responsible for finding block templates that match a given search. The function receives a query parameter with the relevant metadata (slugs of the templates, areas of the template parts, etc) to find the user templates (database) and theme templates (file directory).

This function can be made more performant by changing how it works. Before this change, it processed all the block templates and discarded the ones that didn't match the query after it occurred. This commit makes it so it discards the templates that don't match the query before processing them. As a result, it only has to process the subset of templates that will be used, instead of all of them.

This change impacts any theme with block templates. TwentyTwentyThree reports a 15% improvement in Time To First Byte.

Props spacedmonkey, jorgefilipecosta, youknowriad, flixos90, mukesh27.
Fixes #57756.

File:

• trunk/src/wp-includes/block-template-utils.php (modified) (5 diffs)

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

@@ -291 +291 @@
  *
  * @since 5.9.0
+ * @since 6.3.0 Added the `$query` parameter.
  * @access private
  *
  * @param string $template_type 'wp_template' or 'wp_template_part'.
- * @return array Template.
- */
-function _get_block_templates_files( $template_type ) {
+ * @param array  $query {
+ *     Arguments to retrieve templates. Optional, empty by default.
+ *
+ *     @type array  $slug__in     List of slugs to include.
+ *     @type array  $slug__not_in List of slugs to skip.
+ *     @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.
+ * }
+ *
+ * @return array Template
+ */
+function _get_block_templates_files( $template_type, $query = array() ) {
     if ( 'wp_template' !== $template_type && 'wp_template_part' !== $template_type ) {
         return null;
     }
 
-    $themes         = array(
-        get_stylesheet() => get_stylesheet_directory(),
-        get_template()   => get_template_directory(),
-    );
+    // Prepare metadata from $query.
+    $slugs_to_include = isset( $query['slug__in'] ) ? $query['slug__in'] : array();
+    $slugs_to_skip    = isset( $query['slug__not_in'] ) ? $query['slug__not_in'] : array();
+    $area             = isset( $query['area'] ) ? $query['area'] : null;
+    $post_type        = isset( $query['post_type'] ) ? $query['post_type'] : '';
+
+    $stylesheet = get_stylesheet();
+    $template   = get_template();
+    $themes     = array(
+        $stylesheet => get_stylesheet_directory(),
+    );
+    // Add the parent theme if it's not the same as the current theme.
+    if ( $stylesheet !== $template ) {
+        $themes[ $template ] = get_template_directory();
+    }
     $template_files = array();
     foreach ( $themes as $theme_slug => $theme_dir ) {
@@ -318 +339 @@
                 -5
             );
+
+            // Skip this item if its slug doesn't match any of the slugs to include.
+            if ( ! empty( $slugs_to_include ) && ! in_array( $template_slug, $slugs_to_include, true ) ) {
+                continue;
+            }
+
+            // Skip this item if its slug matches any of the slugs to skip.
+            if ( ! empty( $slugs_to_skip ) && in_array( $template_slug, $slugs_to_skip, true ) ) {
+                continue;
+            }
+
             $new_template_item = array(
                 'slug'  => $template_slug,
@@ -326 +358 @@
 
             if ( 'wp_template_part' === $template_type ) {
-                $template_files[] = _add_block_template_part_area_info( $new_template_item );
+                /*
+                 * Structure of a wp_template_part item:
+                 *
+                 * - slug
+                 * - path
+                 * - theme
+                 * - type
+                 * - area
+                 * - title (optional)
+                 */
+                $candidate = _add_block_template_part_area_info( $new_template_item );
+                if ( ! isset( $area ) || ( isset( $area ) && $area === $candidate['area'] ) ) {
+                    $template_files[] = $candidate;
+                }
             }
 
             if ( 'wp_template' === $template_type ) {
-                $template_files[] = _add_block_template_info( $new_template_item );
+                /*
+                 * Structure of a wp_template item:
+                 *
+                 * - slug
+                 * - path
+                 * - theme
+                 * - type
+                 * - title (optional)
+                 * - postTypes (optional)
+                 */
+                $candidate = _add_block_template_info( $new_template_item );
+                if (
+                    ! $post_type ||
+                    ( $post_type && isset( $candidate['postTypes'] ) && in_array( $post_type, $candidate['postTypes'], true ) )
+                ) {
+                    $template_files[] = $candidate;
+                }
             }
         }
@@ -922 +983 @@
     }
 
-    if ( isset( $query['slug__in'] ) ) {
-        $wp_query_args['post_name__in'] = $query['slug__in'];
+    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'] ) );
     }
 
@@ -958 +1020 @@
 
     if ( ! isset( $query['wp_id'] ) ) {
-        $template_files = _get_block_templates_files( $template_type );
+        /*
+         * If the query has found some use 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' );
+        $template_files        = _get_block_templates_files( $template_type, $query );
         foreach ( $template_files as $template_file ) {
-            $template = _build_block_template_result_from_file( $template_file, $template_type );
-
-            if ( $post_type && ! $template->is_custom ) {
-                continue;
-            }
-
-            if ( $post_type &&
-                isset( $template->post_types ) &&
-                ! in_array( $post_type, $template->post_types, true )
-            ) {
-                continue;
-            }
-
-            $is_not_custom   = false === array_search(
-                get_stylesheet() . '//' . $template_file['slug'],
-                wp_list_pluck( $query_result, 'id' ),
-                true
-            );
-            $fits_slug_query =
-                ! isset( $query['slug__in'] ) || in_array( $template_file['slug'], $query['slug__in'], true );
-            $fits_area_query =
-                ! isset( $query['area'] ) || $template_file['area'] === $query['area'];
-            $should_include  = $is_not_custom && $fits_slug_query && $fits_area_query;
-            if ( $should_include ) {
-                $query_result[] = $template;
-            }
+            $query_result[] = _build_block_template_result_from_file( $template_file, $template_type );
         }
     }