diff -r 7b1b88e27a20 -r 48c4eec2b7e6 wp/wp-includes/class-wp-block-patterns-registry.php --- a/wp/wp-includes/class-wp-block-patterns-registry.php Thu Sep 29 08:06:27 2022 +0200 +++ b/wp/wp-includes/class-wp-block-patterns-registry.php Fri Sep 05 18:40:08 2025 +0200 @@ -12,6 +12,7 @@ * * @since 5.5.0 */ +#[AllowDynamicProperties] final class WP_Block_Patterns_Registry { /** * Registered block patterns array. @@ -42,33 +43,46 @@ * * @since 5.5.0 * @since 5.8.0 Added support for the `blockTypes` property. + * @since 6.1.0 Added support for the `postTypes` property. + * @since 6.2.0 Added support for the `templateTypes` property. + * @since 6.5.0 Added support for the `filePath` property. * * @param string $pattern_name Block pattern name including namespace. * @param array $pattern_properties { * List of properties for the block pattern. * - * @type string $title Required. A human-readable title for the pattern. - * @type string $content Required. Block HTML markup for the pattern. - * @type string $description Optional. Visually hidden text used to describe the pattern in the - * inserter. A description is optional, but is strongly - * encouraged when the title does not fully describe what the - * pattern does. The description will help users discover the - * pattern while searching. - * @type int $viewportWidth Optional. The intended width of the pattern to allow for a scaled - * preview within the pattern inserter. - * @type array $categories Optional. A list of registered pattern categories used to group block - * patterns. Block patterns can be shown on multiple categories. - * A category must be registered separately in order to be used - * here. - * @type array $blockTypes Optional. A list of block names including namespace that could use - * the block pattern in certain contexts (placeholder, transforms). - * The block pattern is available in the block editor inserter - * regardless of this list of block names. - * Certain blocks support further specificity besides the block name - * (e.g. for `core/template-part` you can specify areas - * like `core/template-part/header` or `core/template-part/footer`). - * @type array $keywords Optional. A list of aliases or keywords that help users discover the - * pattern while searching. + * @type string $title Required. A human-readable title for the pattern. + * @type string $content Optional. Block HTML markup for the pattern. + * If not provided, the content will be retrieved from the `filePath` if set. + * If both `content` and `filePath` are not set, the pattern will not be registered. + * @type string $description Optional. Visually hidden text used to describe the pattern + * in the inserter. A description is optional, but is strongly + * encouraged when the title does not fully describe what the + * pattern does. The description will help users discover the + * pattern while searching. + * @type int $viewportWidth Optional. The intended width of the pattern to allow for a scaled + * preview within the pattern inserter. + * @type bool $inserter Optional. Determines whether the pattern is visible in inserter. + * To hide a pattern so that it can only be inserted programmatically, + * set this to false. Default true. + * @type string[] $categories Optional. A list of registered pattern categories used to group + * block patterns. Block patterns can be shown on multiple categories. + * A category must be registered separately in order to be used here. + * @type string[] $keywords Optional. A list of aliases or keywords that help users discover + * the pattern while searching. + * @type string[] $blockTypes Optional. A list of block names including namespace that could use + * the block pattern in certain contexts (placeholder, transforms). + * The block pattern is available in the block editor inserter + * regardless of this list of block names. + * Certain blocks support further specificity besides the block name + * (e.g. for `core/template-part` you can specify areas + * like `core/template-part/header` or `core/template-part/footer`). + * @type string[] $postTypes Optional. An array of post types that the pattern is restricted + * to be used with. The pattern will only be available when editing one + * of the post types passed on the array. For all the other post types + * not part of the array the pattern is not available at all. + * @type string[] $templateTypes Optional. An array of template types where the pattern fits. + * @type string $filePath Optional. The full path to the file containing the block pattern content. * } * @return bool True if the pattern was registered with success and false otherwise. */ @@ -91,19 +105,22 @@ return false; } - 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['filePath'] ) ) { + 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; + } } $pattern = array_merge( $pattern_properties, array( 'name' => $pattern_name ) ); + $this->registered_patterns[ $pattern_name ] = $pattern; // If the pattern is registered inside an action other than `init`, store it @@ -142,6 +159,55 @@ } /** + * Prepares the content of a block pattern. If hooked blocks are registered, they get injected into the pattern, + * when they met the defined criteria. + * + * @since 6.4.0 + * + * @param array $pattern Registered pattern properties. + * @param array $hooked_blocks The list of hooked blocks. + * @return string The content of the block pattern. + */ + private function prepare_content( $pattern, $hooked_blocks ) { + $content = $pattern['content']; + + $before_block_visitor = '_inject_theme_attribute_in_template_part_block'; + $after_block_visitor = null; + if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) { + $before_block_visitor = make_before_block_visitor( $hooked_blocks, $pattern, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); + $after_block_visitor = make_after_block_visitor( $hooked_blocks, $pattern, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); + } + $blocks = parse_blocks( $content ); + $content = traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor ); + + return $content; + } + + /** + * 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 ]['filePath'] ) ) { + ob_start(); + include $patterns[ $pattern_name ]['filePath']; + $patterns[ $pattern_name ]['content'] = ob_get_clean(); + unset( $patterns[ $pattern_name ]['filePath'] ); + } + return $patterns[ $pattern_name ]['content']; + } + + /** * Retrieves an array containing the properties of a registered block pattern. * * @since 5.5.0 @@ -154,7 +220,11 @@ return null; } - return $this->registered_patterns[ $pattern_name ]; + $pattern = $this->registered_patterns[ $pattern_name ]; + $pattern['content'] = $this->get_content( $pattern_name ); + $pattern['content'] = $this->prepare_content( $pattern, get_hooked_blocks() ); + + return $pattern; } /** @@ -167,11 +237,17 @@ * and per style. */ public function get_all_registered( $outside_init_only = false ) { - return 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 array_values( $patterns ); } /** @@ -186,6 +262,21 @@ return isset( $this->registered_patterns[ $pattern_name ] ); } + public function __wakeup() { + if ( ! $this->registered_patterns ) { + return; + } + if ( ! is_array( $this->registered_patterns ) ) { + throw new UnexpectedValueException(); + } + foreach ( $this->registered_patterns as $value ) { + if ( ! is_array( $value ) ) { + throw new UnexpectedValueException(); + } + } + $this->registered_patterns_outside_init = array(); + } + /** * Utility method to retrieve the main instance of the class. *