Changeset 57683

Timestamp:

02/21/2024 06:48:30 PM (3 years ago)

Author:

joemcgill

Message:

Editor: Load pattern content only when used.

Previously, the content for all registered patterns would get loaded on each request when the patterns are registered. Instead, this stores the path the pattern file during registration and reads the content the first time the pattern is used, which is a performance optimization.

Props thekt12, spacedmonkey, gziolo, aristath, joemcgill.
Fixes #59532.

Location:

trunk/src/wp-includes

Files:

• block-patterns.php (modified) (1 diff)
• class-wp-block-patterns-registry.php (modified) (4 diffs)

trunk/src/wp-includes/block-patterns.php

@@ -392 +392 @@
                         }
 
-                        // The actual pattern content is the output of the file.
-                        ob_start();
-                        include $file_path;
-                        $pattern_data['content'] = ob_get_clean();
-                        if ( ! $pattern_data['content'] ) {
-                                continue;
-                        }
+                        $pattern_data['file_path'] = $file_path;
 
                         // Translate the pattern metadata.

trunk/src/wp-includes/class-wp-block-patterns-registry.php

@@ -102 +102 @@
                 }
 
-                if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) {
-                        _doing_it_wrong(
-                                __METHOD__,
-                                __( 'Pattern content must be a string.' ),
-                                '5.5.0'
-                        );
-                        return false;
+                if ( ! isset( $pattern_properties['file_path'] ) ) {
+                        if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) {
+                                _doing_it_wrong(
+                                        __METHOD__,
+                                        __( 'Pattern content must be a string.' ),
+                                        '5.5.0'
+                                );
+                                return false;
+                        }
                 }
 
@@ -179 +181 @@
 
         /**
+         * Retrieves the content of a registered block pattern.
+         *
+         * @since 6.5.0
+         *
+         * @param string $pattern_name      Block pattern name including namespace.
+         * @param bool   $outside_init_only Optional. Return only patterns registered outside the `init` action. Default false.
+         * @return string The content of the block pattern.
+         */
+        private function get_content( $pattern_name, $outside_init_only = false ) {
+                if ( $outside_init_only ) {
+                        $patterns = &$this->registered_patterns_outside_init;
+                } else {
+                        $patterns = &$this->registered_patterns;
+                }
+                if ( ! isset( $patterns[ $pattern_name ]['content'] ) && isset( $patterns[ $pattern_name ]['file_path'] ) ) {
+                        ob_start();
+                        include $patterns[ $pattern_name ]['file_path'];
+                        $patterns[ $pattern_name ]['content'] = ob_get_clean();
+                        unset( $patterns[ $pattern_name ]['file_path'] );
+                }
+                return $patterns[ $pattern_name ]['content'];
+        }
+
+        /**
          * Retrieves an array containing the properties of a registered block pattern.
          *
@@ -192 +218 @@
 
                 $pattern            = $this->registered_patterns[ $pattern_name ];
+                $pattern['content'] = $this->get_content( $pattern_name );
                 $pattern['content'] = $this->prepare_content( $pattern, get_hooked_blocks() );
 
@@ -207 +234 @@
          */
         public function get_all_registered( $outside_init_only = false ) {
-                $patterns      = array_values(
-                        $outside_init_only
+                $patterns      = $outside_init_only
                                 ? $this->registered_patterns_outside_init
-                                : $this->registered_patterns
-                );
+                                : $this->registered_patterns;
                 $hooked_blocks = get_hooked_blocks();
+
                 foreach ( $patterns as $index => $pattern ) {
+                        $pattern['content']            = $this->get_content( $pattern['name'], $outside_init_only );
                         $patterns[ $index ]['content'] = $this->prepare_content( $pattern, $hooked_blocks );
                 }
-                return $patterns;
+
+                return array_values( $patterns );
         }