diff --git a/src/wp-includes/block-template-utils.php b/src/wp-includes/block-template-utils.php index f7a10ab672904..22ceb8323bbd9 100644 --- a/src/wp-includes/block-template-utils.php +++ b/src/wp-includes/block-template-utils.php @@ -606,17 +606,14 @@ function _build_block_template_result_from_file( $template_file, $template_type $template->area = $template_file['area']; } - $hooked_blocks = get_hooked_blocks(); - $has_hooked_blocks = ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ); $before_block_visitor = '_inject_theme_attribute_in_template_part_block'; $after_block_visitor = null; - - if ( $has_hooked_blocks ) { - $before_block_visitor = make_before_block_visitor( $hooked_blocks, $template, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); - $after_block_visitor = make_after_block_visitor( $hooked_blocks, $template, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); + if ( maybe_has_hooked_blocks() ) { + $before_block_visitor = make_before_block_visitor( null, $template, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); + $after_block_visitor = make_after_block_visitor( null, $template, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); } - if ( 'wp_template_part' === $template->type && $has_hooked_blocks ) { + if ( 'wp_template_part' === $template->type && maybe_has_hooked_blocks() ) { /* * In order for hooked blocks to be inserted at positions first_child and last_child in a template part, * we need to wrap its content a mock template part block and traverse it. @@ -1014,10 +1011,9 @@ function _build_block_template_result_from_post( $post ) { } } - $hooked_blocks = get_hooked_blocks(); - if ( ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ) ) { - $before_block_visitor = make_before_block_visitor( $hooked_blocks, $template, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); - $after_block_visitor = make_after_block_visitor( $hooked_blocks, $template, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); + if ( maybe_has_hooked_blocks() ) { + $before_block_visitor = make_before_block_visitor( null, $template, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); + $after_block_visitor = make_after_block_visitor( null, $template, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); if ( 'wp_template_part' === $template->type ) { $existing_ignored_hooked_blocks = get_post_meta( $post->ID, '_wp_ignored_hooked_blocks', true ); $attributes = ! empty( $existing_ignored_hooked_blocks ) ? array( 'metadata' => array( 'ignoredHookedBlocks' => json_decode( $existing_ignored_hooked_blocks, true ) ) ) : array(); @@ -1602,8 +1598,7 @@ function inject_ignored_hooked_blocks_metadata_attributes( $changes, $deprecated _deprecated_argument( __FUNCTION__, '6.5.3' ); } - $hooked_blocks = get_hooked_blocks(); - if ( empty( $hooked_blocks ) && ! has_filter( 'hooked_block_types' ) ) { + if ( ! maybe_has_hooked_blocks() ) { return $changes; } diff --git a/src/wp-includes/blocks.php b/src/wp-includes/blocks.php index 3b1fc25d48824..7713cb5304710 100644 --- a/src/wp-includes/blocks.php +++ b/src/wp-includes/blocks.php @@ -825,13 +825,18 @@ function get_dynamic_block_names() { } /** - * Retrieves block types hooked into the given block, grouped by anchor block type and the relative position. + * Retrieves block types hooked into the given block via the block.json file, grouped by anchor block type and the relative position. * * @since 6.4.0 * * @return array[] Array of block types grouped by anchor block type and the relative position. */ function get_hooked_blocks() { + static $cached_result = null; + if ( ! defined( 'WP_RUN_CORE_TESTS' ) && null !== $cached_result ) { + return $cached_result; + } + $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered(); $hooked_blocks = array(); foreach ( $block_types as $block_type ) { @@ -849,26 +854,39 @@ function get_hooked_blocks() { } } + $cached_result = $hooked_blocks; + return $hooked_blocks; } /** - * Returns the markup for blocks hooked to the given anchor block in a specific relative position. + * Determines whether there are any blocks hooked to other blocks. + * Prefixed with maybe_ because the filter might be used but not have any hooked blocks. * - * @since 6.5.0 - * @access private + * @since 6.7.0 * - * @param array $parsed_anchor_block The anchor block, in parsed block array format. - * @param string $relative_position The relative position of the hooked blocks. - * Can be one of 'before', 'after', 'first_child', or 'last_child'. - * @param array $hooked_blocks An array of hooked block types, grouped by anchor block and relative position. - * @param WP_Block_Template|WP_Post|array $context The block template, template part, or pattern that the anchor block belongs to. - * @return string + * @return bool */ -function insert_hooked_blocks( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) { - $anchor_block_type = $parsed_anchor_block['blockName']; - $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) - ? $hooked_blocks[ $anchor_block_type ][ $relative_position ] +function maybe_has_hooked_blocks() { + $hooked_blocks = get_hooked_blocks(); + return ! empty( $hooked_blocks ) || has_filter( 'hooked_block_types' ); +} + +/** + * For a given anchor block type and relative position, returns the list of block types hooked to it. + * + * @since 6.7.0 + * + * @param string $anchor_block_type The anchor block name. + * @param string $relative_position Relative position e.g. `before`, `after`, `first_child`, `last_child`. + * @param WP_Block_Template|WP_Post|array $context The block template, template part, `wp_navigation` post type, + * or pattern that the anchor block belongs to. + * @return array[] Array of block types grouped by anchor block type and the relative position. + */ +function get_hooked_blocks_by_anchor_block( $anchor_block_type, $relative_position, $context ) { + $hooked_json_blocks = get_hooked_blocks(); + $hooked_block_types = isset( $hooked_json_blocks[ $anchor_block_type ][ $relative_position ] ) + ? $hooked_json_blocks[ $anchor_block_type ][ $relative_position ] : array(); /** @@ -883,7 +901,34 @@ function insert_hooked_blocks( &$parsed_anchor_block, $relative_position, $hooke * @param WP_Block_Template|WP_Post|array $context The block template, template part, `wp_navigation` post type, * or pattern that the anchor block belongs to. */ - $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context ); + $hooked_blocks = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context ); + + if ( ! is_array( $hooked_blocks ) ) { + return array(); + } + + return $hooked_blocks; +} + +/** + * Returns the markup for blocks hooked to the given anchor block in a specific relative position. + * + * @since 6.5.0 + * @since 6.7.0 Added the $deprecated parameter to deprecated the $hooked_blocks parameter. + * @access private + * + * @param array $parsed_anchor_block The anchor block, in parsed block array format. + * @param string $relative_position The relative position of the hooked blocks. + * Can be one of 'before', 'after', 'first_child', or 'last_child'. + * @param WP_Block_Template|WP_Post|array $context The block template, template part, or pattern that the anchor block belongs to. + * @return string + */ +function insert_hooked_blocks( &$parsed_anchor_block, $relative_position, $deprecated = null, $context ) { + if ( null !== $deprecated ) { + _deprecated_argument( __FUNCTION__, '6.7.0' ); + } + $anchor_block_type = $parsed_anchor_block['blockName']; + $hooked_block_types = get_hooked_blocks_by_anchor_block( $anchor_block_type, $relative_position, $context ); $markup = ''; foreach ( $hooked_block_types as $hooked_block_type ) { @@ -947,23 +992,23 @@ function insert_hooked_blocks( &$parsed_anchor_block, $relative_position, $hooke * This function is meant for internal use only. * * @since 6.5.0 + * @since 6.7.0 Added the $deprecated parameter to deprecated the $hooked_blocks parameter. * @access private * * @param array $parsed_anchor_block The anchor block, in parsed block array format. * @param string $relative_position The relative position of the hooked blocks. * Can be one of 'before', 'after', 'first_child', or 'last_child'. - * @param array $hooked_blocks An array of hooked block types, grouped by anchor block and relative position. + * @param mixed $deprecated Deprecated. Not used. * @param WP_Block_Template|WP_Post|array $context The block template, template part, or pattern that the anchor block belongs to. * @return string Empty string. */ -function set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) { - $anchor_block_type = $parsed_anchor_block['blockName']; - $hooked_block_types = isset( $hooked_blocks[ $anchor_block_type ][ $relative_position ] ) - ? $hooked_blocks[ $anchor_block_type ][ $relative_position ] - : array(); +function set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_position, $deprecated = null, $context ) { + if ( null !== $deprecated ) { + _deprecated_argument( __FUNCTION__, '6.7.0' ); + } - /** This filter is documented in wp-includes/blocks.php */ - $hooked_block_types = apply_filters( 'hooked_block_types', $hooked_block_types, $relative_position, $anchor_block_type, $context ); + $anchor_block_type = $parsed_anchor_block['blockName']; + $hooked_block_types = get_hooked_blocks_by_anchor_block( $anchor_block_type, $relative_position, $context ); if ( empty( $hooked_block_types ) ) { return ''; } @@ -1017,15 +1062,14 @@ function set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_po * @return string The serialized markup. */ function apply_block_hooks_to_content( $content, $context, $callback = 'insert_hooked_blocks' ) { - $hooked_blocks = get_hooked_blocks(); - if ( empty( $hooked_blocks ) && ! has_filter( 'hooked_block_types' ) ) { + if ( ! maybe_has_hooked_blocks() ) { return $content; } $blocks = parse_blocks( $content ); - $before_block_visitor = make_before_block_visitor( $hooked_blocks, $context, $callback ); - $after_block_visitor = make_after_block_visitor( $hooked_blocks, $context, $callback ); + $before_block_visitor = make_before_block_visitor( null, $context, $callback ); + $after_block_visitor = make_after_block_visitor( null, $context, $callback ); return traverse_and_serialize_blocks( $blocks, $before_block_visitor, $after_block_visitor ); } @@ -1146,18 +1190,23 @@ function update_ignored_hooked_blocks_postmeta( $post ) { * This function is meant for internal use only. * * @since 6.6.0 + * @since 6.7.0 Added the `$deprecated` parameter to deprecated the $hooked_blocks parameter. * @access private * * @param array $parsed_anchor_block The anchor block, in parsed block array format. * @param string $relative_position The relative position of the hooked blocks. * Can be one of 'before', 'after', 'first_child', or 'last_child'. - * @param array $hooked_blocks An array of hooked block types, grouped by anchor block and relative position. + * @param mixed $deprecated Deprecated. Not used. * @param WP_Block_Template|WP_Post|array $context The block template, template part, or pattern that the anchor block belongs to. * @return string */ -function insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_position, $hooked_blocks, $context ) { - $markup = insert_hooked_blocks( $parsed_anchor_block, $relative_position, $hooked_blocks, $context ); - $markup .= set_ignored_hooked_blocks_metadata( $parsed_anchor_block, $relative_position, $hooked_blocks, $context ); +function insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( &$parsed_anchor_block, $relative_position, $deprecated = null, $context ) { + if ( null !== $deprecated ) { + _deprecated_function( __FUNCTION__, '6.7.0' ); + } + + $markup = insert_hooked_blocks( $parsed_anchor_block, $relative_position, $deprecated, $context ); + $markup .= set_ignored_hooked_blocks_metadata( $parsed_anchor_block, $relative_position, $deprecated, $context ); return $markup; } @@ -1214,9 +1263,10 @@ function insert_hooked_blocks_into_rest_response( $response, $post ) { * * @since 6.4.0 * @since 6.5.0 Added $callback argument. + * @since 6.7.0 Added the $deprecated parameter to deprecated the $hooked_blocks parameter. * @access private * - * @param array $hooked_blocks An array of blocks hooked to another given block. + * @param mixed $deprecated Deprecated. Not used. * @param WP_Block_Template|WP_Post|array $context A block template, template part, `wp_navigation` post object, * or pattern that the blocks belong to. * @param callable $callback A function that will be called for each block to generate @@ -1225,7 +1275,10 @@ function insert_hooked_blocks_into_rest_response( $response, $post ) { * @return callable A function that returns the serialized markup for the given block, * including the markup for any hooked blocks before it. */ -function make_before_block_visitor( $hooked_blocks, $context, $callback = 'insert_hooked_blocks' ) { +function make_before_block_visitor( $deprecated = null, $context, $callback = 'insert_hooked_blocks' ) { + if ( null !== $deprecated ) { + _deprecated_argument( __FUNCTION__, '6.7.0' ); + } /** * Injects hooked blocks before the given block, injects the `theme` attribute into Template Part blocks, and returns the serialized markup. * @@ -1238,7 +1291,7 @@ function make_before_block_visitor( $hooked_blocks, $context, $callback = 'inser * @param array $prev The previous sibling block of the given block. Default null. * @return string The serialized markup for the given block, with the markup for any hooked blocks prepended to it. */ - return function ( &$block, &$parent_block = null, $prev = null ) use ( $hooked_blocks, $context, $callback ) { + return function ( &$block, &$parent_block = null, $prev = null ) use ( $deprecated, $context, $callback ) { _inject_theme_attribute_in_template_part_block( $block ); $markup = ''; @@ -1247,13 +1300,13 @@ function make_before_block_visitor( $hooked_blocks, $context, $callback = 'inser // Candidate for first-child insertion. $markup .= call_user_func_array( $callback, - array( &$parent_block, 'first_child', $hooked_blocks, $context ) + array( &$parent_block, 'first_child', $deprecated, $context ) ); } $markup .= call_user_func_array( $callback, - array( &$block, 'before', $hooked_blocks, $context ) + array( &$block, 'before', $deprecated, $context ) ); return $markup; @@ -1271,9 +1324,10 @@ function make_before_block_visitor( $hooked_blocks, $context, $callback = 'inser * * @since 6.4.0 * @since 6.5.0 Added $callback argument. + * @since 6.7.0 Added the $deprecated parameter to deprecated the $hooked_blocks parameter. * @access private * - * @param array $hooked_blocks An array of blocks hooked to another block. + * @param mixed $deprecated Deprecated. Not used. * @param WP_Block_Template|WP_Post|array $context A block template, template part, `wp_navigation` post object, * or pattern that the blocks belong to. * @param callable $callback A function that will be called for each block to generate @@ -1282,7 +1336,10 @@ function make_before_block_visitor( $hooked_blocks, $context, $callback = 'inser * @return callable A function that returns the serialized markup for the given block, * including the markup for any hooked blocks after it. */ -function make_after_block_visitor( $hooked_blocks, $context, $callback = 'insert_hooked_blocks' ) { +function make_after_block_visitor( $deprecated = null, $context, $callback = 'insert_hooked_blocks' ) { + if ( null !== $deprecated ) { + _deprecated_argument( __FUNCTION__, '6.7.0' ); + } /** * Injects hooked blocks after the given block, and returns the serialized markup. * @@ -1294,17 +1351,17 @@ function make_after_block_visitor( $hooked_blocks, $context, $callback = 'insert * @param array $next The next sibling block of the given block. Default null. * @return string The serialized markup for the given block, with the markup for any hooked blocks appended to it. */ - return function ( &$block, &$parent_block = null, $next = null ) use ( $hooked_blocks, $context, $callback ) { + return function ( &$block, &$parent_block = null, $next = null ) use ( $deprecated, $context, $callback ) { $markup = call_user_func_array( $callback, - array( &$block, 'after', $hooked_blocks, $context ) + array( &$block, 'after', $deprecated, $context ) ); if ( $parent_block && ! $next ) { // Candidate for last-child insertion. $markup .= call_user_func_array( $callback, - array( &$parent_block, 'last_child', $hooked_blocks, $context ) + array( &$parent_block, 'last_child', $deprecated, $context ) ); } diff --git a/src/wp-includes/class-wp-block-patterns-registry.php b/src/wp-includes/class-wp-block-patterns-registry.php index 6317bc81e51b1..e9c0c397b620f 100644 --- a/src/wp-includes/class-wp-block-patterns-registry.php +++ b/src/wp-includes/class-wp-block-patterns-registry.php @@ -165,17 +165,16 @@ public function unregister( $pattern_name ) { * @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 ) { + private function prepare_content( $pattern ) { $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' ); + if ( maybe_has_hooked_blocks() ) { + $before_block_visitor = make_before_block_visitor( null, $pattern, 'insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata' ); + $after_block_visitor = make_after_block_visitor( null, $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 ); @@ -222,7 +221,7 @@ public function get_registered( $pattern_name ) { $pattern = $this->registered_patterns[ $pattern_name ]; $pattern['content'] = $this->get_content( $pattern_name ); - $pattern['content'] = $this->prepare_content( $pattern, get_hooked_blocks() ); + $pattern['content'] = $this->prepare_content( $pattern ); return $pattern; } @@ -237,14 +236,13 @@ public function get_registered( $pattern_name ) { * and per style. */ public function get_all_registered( $outside_init_only = false ) { - $patterns = $outside_init_only + $patterns = $outside_init_only ? $this->registered_patterns_outside_init : $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 ); + $patterns[ $index ]['content'] = $this->prepare_content( $pattern ); } return array_values( $patterns ); diff --git a/tests/phpunit/tests/blocks/getHookedBlocksByAnchorBlock.php b/tests/phpunit/tests/blocks/getHookedBlocksByAnchorBlock.php new file mode 100644 index 0000000000000..130c747ba91d7 --- /dev/null +++ b/tests/phpunit/tests/blocks/getHookedBlocksByAnchorBlock.php @@ -0,0 +1,329 @@ +get_all_registered(); + foreach ( $block_types as $block_type ) { + $block_name = $block_type->name; + if ( str_starts_with( $block_name, 'tests/' ) ) { + unregister_block_type( $block_name ); + } + } + + // Removes test block patterns registered with the test theme. + $patterns = WP_Block_Patterns_Registry::get_instance()->get_all_registered(); + foreach ( $patterns as $pattern ) { + if ( empty( $pattern['slug'] ) ) { + continue; + } + $pattern_name = $pattern['slug']; + if ( str_starts_with( $pattern_name, self::TEST_THEME_NAME ) ) { + unregister_block_pattern( $pattern_name ); + } + } + + parent::tear_down(); + } + + private function switch_to_block_theme_hooked_blocks() { + switch_theme( self::TEST_THEME_NAME ); + + _register_theme_block_patterns(); + + $theme_blocks_dir = wp_normalize_path( realpath( get_theme_file_path( 'blocks' ) ) ); + register_block_type( $theme_blocks_dir . '/hooked-before' ); + register_block_type( $theme_blocks_dir . '/hooked-after' ); + register_block_type( $theme_blocks_dir . '/hooked-first-child' ); + register_block_type( $theme_blocks_dir . '/hooked-last-child' ); + } + + private static function create_block_template_object() { + $template = new WP_Block_Template(); + $template->type = 'wp_template'; + $template->theme = 'test-theme'; + $template->slug = 'single'; + $template->id = $template->theme . '//' . $template->slug; + $template->title = 'Single'; + $template->content = ''; + $template->description = 'Description of my template'; + + return $template; + } + + /** + * @ticket 60769 + * + * @covers ::get_hooked_blocks_by_anchor_block + */ + public function test_get_hooked_blocks_by_anchor_block_no_match_found() { + $result = get_hooked_blocks_by_anchor_block( 'core/test-block', 'before', array() ); + + $this->assertSame( array(), $result ); + } + + /** + * @ticket 60769 + * + * @covers ::get_hooked_blocks_by_anchor_block + */ + public function test_get_hooked_blocks_by_anchor_block_matches_found_block_json() { + register_block_type( + 'tests/injected-one', + array( + 'block_hooks' => array( + 'tests/hooked-at-before' => 'before', + 'tests/hooked-at-after' => 'after', + 'tests/hooked-at-before-and-after' => 'before', + ), + ) + ); + register_block_type( + 'tests/injected-two', + array( + 'block_hooks' => array( + 'tests/hooked-at-before' => 'before', + 'tests/hooked-at-after' => 'after', + 'tests/hooked-at-before-and-after' => 'after', + 'tests/hooked-at-first-child' => 'first_child', + 'tests/hooked-at-last-child' => 'last_child', + ), + ) + ); + + $this->assertSame( + array( 'tests/injected-one', 'tests/injected-two' ), + get_hooked_blocks_by_anchor_block( 'tests/hooked-at-before', 'before', array() ) + ); + + $this->assertSame( + array( 'tests/injected-two' ), + get_hooked_blocks_by_anchor_block( 'tests/hooked-at-first-child', 'first_child', array() ) + ); + + $this->assertSame( + array( 'tests/injected-two' ), + get_hooked_blocks_by_anchor_block( 'tests/hooked-at-last-child', 'last_child', array() ) + ); + + $this->assertSame( + array( 'tests/injected-two' ), + get_hooked_blocks_by_anchor_block( 'tests/hooked-at-before-and-after', 'after', array() ) + ); + } + + /** + * @ticket 60769 + * + * @covers ::get_hooked_blocks_by_anchor_block + */ + public function test_get_hooked_blocks_by_anchor_block_matches_found_filter() { + $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type, $context ) { + if ( + ! $context instanceof WP_Block_Template || + ! property_exists( $context, 'slug' ) || + 'single' !== $context->slug + ) { + return $hooked_block_types; + } + + if ( 'tests/anchor-block' === $anchor_block_type && 'after' === $relative_position ) { + $hooked_block_types[] = 'tests/hooked-block-added-by-filter'; + } + + return $hooked_block_types; + }; + + $template = self::create_block_template_object(); + + add_filter( 'hooked_block_types', $filter, 10, 4 ); + $hooked_blocks = get_hooked_blocks_by_anchor_block( 'tests/anchor-block', 'after', $template ); + remove_filter( 'hooked_block_types', $filter, 10 ); + + $this->assertSame( array( 'tests/hooked-block-added-by-filter' ), $hooked_blocks ); + } + + /** + * @ticket 60769 + * + * @covers ::get_hooked_blocks_by_anchor_block + */ + public function test_get_hooked_blocks_by_anchor_block_corrupt_filter() { + $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type, $context ) { + $hooked_block_types = 'corrupt'; + return $hooked_block_types; + }; + + $template = self::create_block_template_object(); + + add_filter( 'hooked_block_types', $filter, 10, 4 ); + $hooked_blocks = get_hooked_blocks_by_anchor_block( 'tests/anchor-block', 'after', $template ); + remove_filter( 'hooked_block_types', $filter, 10 ); + + $this->assertSame( array(), $hooked_blocks ); + } + + /** + * @ticket 60769 + * + * @covers ::get_hooked_blocks_by_anchor_block + */ + public function test_get_hooked_blocks_by_anchor_block_matches_found_filter_and_block_json() { + register_block_type( + 'tests/block-json-block', + array( + 'block_hooks' => array( + 'tests/anchor-block' => 'after', + ), + ) + ); + + $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type, $context ) { + if ( + ! $context instanceof WP_Block_Template || + ! property_exists( $context, 'slug' ) || + 'single' !== $context->slug + ) { + return $hooked_block_types; + } + + if ( 'tests/anchor-block' === $anchor_block_type && 'after' === $relative_position ) { + $hooked_block_types[] = 'tests/hooked-block-added-by-filter'; + } + + return $hooked_block_types; + }; + + $template = self::create_block_template_object(); + + add_filter( 'hooked_block_types', $filter, 10, 4 ); + $hooked_blocks = get_hooked_blocks_by_anchor_block( 'tests/anchor-block', 'after', $template ); + remove_filter( 'hooked_block_types', $filter, 10 ); + + $this->assertSame( array( 'tests/block-json-block', 'tests/hooked-block-added-by-filter' ), $hooked_blocks ); + } + + /** + * @ticket 60769 + * @ticket 59313 + * @ticket 60008 + * @ticket 60506 + * + * @covers ::get_hooked_blocks_by_anchor_block + * @covers ::get_hooked_blocks + * @covers ::get_block_file_template + */ + public function test_loading_template_with_hooked_blocks() { + $this->switch_to_block_theme_hooked_blocks(); + + $template = get_block_file_template( get_stylesheet() . '//single' ); + + $this->assertStringNotContainsString( + '', + $template->content + ); + $this->assertStringContainsString( + '' + . '', + $template->content + ); + $this->assertStringNotContainsString( + '', + $template->content + ); + $this->assertStringNotContainsString( + '', + $template->content + ); + } + + /** + * @ticket 60769 + * @ticket 59313 + * @ticket 60008 + * @ticket 60506 + * + * @covers ::get_hooked_blocks_by_anchor_block + * @covers ::get_hooked_blocks + * @covers ::get_block_file_template + */ + public function test_loading_template_part_with_hooked_blocks() { + $this->switch_to_block_theme_hooked_blocks(); + + $template = get_block_file_template( get_stylesheet() . '//header', 'wp_template_part' ); + + $this->assertStringContainsString( + '' + . '', + $template->content + ); + $this->assertStringNotContainsString( + '', + $template->content + ); + $this->assertStringNotContainsString( + '', + $template->content + ); + $this->assertStringNotContainsString( + '', + $template->content + ); + } + + /** + * @ticket 60769 + * @ticket 59313 + * @ticket 60008 + * @ticket 60506 + * + * @covers ::get_hooked_blocks_by_anchor_block + * @covers ::get_hooked_blocks + * @covers ::get_block_file_template + */ + public function test_loading_pattern_with_hooked_blocks() { + $this->switch_to_block_theme_hooked_blocks(); + + $pattern = WP_Block_Patterns_Registry::get_instance()->get_registered( + get_stylesheet() . '/hidden-comments' + ); + + $this->assertStringNotContainsString( + '', + $pattern['content'] + ); + $this->assertStringNotContainsString( + '', + $pattern['content'] + ); + $this->assertStringContainsString( + '' + . '
' + . '', + str_replace( array( "\n", "\t" ), '', $pattern['content'] ) + ); + $this->assertStringContainsString( + '' + . '', + str_replace( array( "\n", "\t" ), '', $pattern['content'] ) + ); + } +} diff --git a/tests/phpunit/tests/blocks/insertHookedBlocks.php b/tests/phpunit/tests/blocks/insertHookedBlocks.php index cf99b213e518c..86761beb11258 100644 --- a/tests/phpunit/tests/blocks/insertHookedBlocks.php +++ b/tests/phpunit/tests/blocks/insertHookedBlocks.php @@ -15,12 +15,46 @@ class Tests_Blocks_InsertHookedBlocks extends WP_UnitTestCase { const HOOKED_BLOCK_TYPE = 'tests/hooked-block'; const OTHER_HOOKED_BLOCK_TYPE = 'tests/other-hooked-block'; - const HOOKED_BLOCKS = array( - self::ANCHOR_BLOCK_TYPE => array( - 'after' => array( self::HOOKED_BLOCK_TYPE ), - 'before' => array( self::OTHER_HOOKED_BLOCK_TYPE ), - ), - ); + /** + * Tear down after each test. + */ + public function tear_down() { + // Removes test block types registered by test cases. + $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered(); + foreach ( $block_types as $block_type ) { + $block_name = $block_type->name; + if ( str_starts_with( $block_name, 'tests/' ) ) { + unregister_block_type( $block_name ); + } + } + + parent::tear_down(); + } + + /** + * Set up before each test. + */ + public function set_up() { + parent::set_up(); + + register_block_type( + self::HOOKED_BLOCK_TYPE, + array( + 'block_hooks' => array( + self::ANCHOR_BLOCK_TYPE => 'after', + ), + ) + ); + + register_block_type( + self::OTHER_HOOKED_BLOCK_TYPE, + array( + 'block_hooks' => array( + self::ANCHOR_BLOCK_TYPE => 'before', + ), + ) + ); + } /** * @ticket 59572 @@ -34,7 +68,7 @@ public function test_insert_hooked_blocks_returns_correct_markup() { 'blockName' => self::ANCHOR_BLOCK_TYPE, ); - $actual = insert_hooked_blocks( $anchor_block, 'after', self::HOOKED_BLOCKS, array() ); + $actual = insert_hooked_blocks( $anchor_block, 'after', null, array() ); $this->assertSame( '', $actual, @@ -59,7 +93,7 @@ public function test_insert_hooked_blocks_if_block_is_ignored() { ), ); - $actual = insert_hooked_blocks( $anchor_block, 'after', self::HOOKED_BLOCKS, array() ); + $actual = insert_hooked_blocks( $anchor_block, 'after', null, array() ); $this->assertSame( '', $actual, @@ -84,7 +118,7 @@ public function test_insert_hooked_blocks_if_other_block_is_ignored() { ), ); - $actual = insert_hooked_blocks( $anchor_block, 'before', self::HOOKED_BLOCKS, array() ); + $actual = insert_hooked_blocks( $anchor_block, 'before', null, array() ); $this->assertSame( '', $actual, @@ -125,7 +159,7 @@ public function test_insert_hooked_blocks_filter_can_set_attributes() { return $parsed_hooked_block; }; add_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 4 ); - $actual = insert_hooked_blocks( $anchor_block, 'after', self::HOOKED_BLOCKS, array() ); + $actual = insert_hooked_blocks( $anchor_block, 'after', null, array() ); remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter ); $this->assertSame( @@ -171,7 +205,7 @@ public function test_insert_hooked_blocks_filter_can_wrap_block() { ); }; add_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 3 ); - $actual = insert_hooked_blocks( $anchor_block, 'after', self::HOOKED_BLOCKS, array() ); + $actual = insert_hooked_blocks( $anchor_block, 'after', null, array() ); remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter ); $this->assertSame( @@ -213,7 +247,7 @@ public function test_insert_hooked_blocks_filter_can_suppress_hooked_block() { return $parsed_hooked_block; }; add_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 4 ); - $actual = insert_hooked_blocks( $anchor_block, 'after', self::HOOKED_BLOCKS, array() ); + $actual = insert_hooked_blocks( $anchor_block, 'after', null, array() ); remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter ); $this->assertSame( '', $actual, "No markup should've been generated for hooked block suppressed by filter." ); diff --git a/tests/phpunit/tests/blocks/insertHookedBlocksAndSetIgnoredHookedBlocksMetadata.php b/tests/phpunit/tests/blocks/insertHookedBlocksAndSetIgnoredHookedBlocksMetadata.php index 8e88719fee262..16f12aff98c52 100644 --- a/tests/phpunit/tests/blocks/insertHookedBlocksAndSetIgnoredHookedBlocksMetadata.php +++ b/tests/phpunit/tests/blocks/insertHookedBlocksAndSetIgnoredHookedBlocksMetadata.php @@ -23,6 +23,24 @@ class Tests_Blocks_InsertHookedBlocksAndSetIgnoredHookedBlocksMetadata extends W ), ); + /** + * Tear down after each test. + * + * @since 6.7.0 + */ + public function tear_down() { + // Removes test block types registered by test cases. + $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered(); + foreach ( $block_types as $block_type ) { + $block_name = $block_type->name; + if ( str_starts_with( $block_name, 'tests/' ) ) { + unregister_block_type( $block_name ); + } + } + + parent::tear_down(); + } + /** * @ticket 59574 */ @@ -47,7 +65,16 @@ public function test_insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata 'blockName' => self::ANCHOR_BLOCK_TYPE, ); - $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', self::HOOKED_BLOCKS, array() ); + register_block_type( + self::HOOKED_BLOCK_TYPE, + array( + 'block_hooks' => array( + self::ANCHOR_BLOCK_TYPE => 'after', + ), + ) + ); + + $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, array() ); $this->assertSame( '', $actual, @@ -73,7 +100,7 @@ public function test_insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata ), ); - $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', self::HOOKED_BLOCKS, array() ); + $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, array() ); $this->assertSame( '', $actual, @@ -99,13 +126,16 @@ public function test_insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata ), ); - $hooked_blocks = array( - 'tests/anchor-block' => array( - 'after' => array( 'tests/hooked-block' ), - ), + register_block_type( + 'tests/hooked-block', + array( + 'block_hooks' => array( + 'tests/anchor-block' => 'after', + ), + ) ); - $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', $hooked_blocks, array() ); + $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, array() ); $this->assertSame( '', $actual, @@ -147,13 +177,13 @@ public function test_insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata return $parsed_hooked_block; }; add_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter, 10, 4 ); - $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', self::HOOKED_BLOCKS, array() ); + $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, array() ); remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter ); $this->assertSame( '', $actual, "No markup should've been generated for hooked block suppressed by filter." ); $this->assertSame( - array(), - $anchor_block['attrs']['metadata']['ignoredHookedBlocks'], + false, + isset( $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ), "No block should've been added to ignoredHookedBlocks metadata." ); } @@ -186,7 +216,7 @@ public function test_insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata $template = self::create_block_template_object(); add_filter( 'hooked_block_types', $filter, 10, 4 ); - $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', array(), $template ); + $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, $template ); remove_filter( 'hooked_block_types', $filter, 10 ); $this->assertSame( @@ -205,17 +235,21 @@ public function test_insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata * @ticket 59574 */ public function test_insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata_for_block_suppressed_by_filter() { + register_block_type( + 'tests/hooked-block', + array( + 'block_hooks' => array( + 'tests/anchor-block' => 'after', + 'tests/hooked-block-suppressed-by-filter' => 'after', + ), + ) + ); + $anchor_block = array( 'blockName' => 'tests/anchor-block', 'attrs' => array(), ); - $hooked_blocks = array( - 'tests/anchor-block' => array( - 'after' => array( 'tests/hooked-block', 'tests/hooked-block-suppressed-by-filter' ), - ), - ); - $filter = function ( $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block ) { if ( 'tests/hooked-block-suppressed-by-filter' === $hooked_block_type && @@ -229,7 +263,7 @@ public function test_insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata }; add_filter( 'hooked_block', $filter, 10, 4 ); - $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', $hooked_blocks, null ); + $actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, null ); remove_filter( 'hooked_block', $filter ); $this->assertSame( diff --git a/tests/phpunit/tests/blocks/setIgnoredHookedBlocksMetadata.php b/tests/phpunit/tests/blocks/setIgnoredHookedBlocksMetadata.php index 7145e56cdeef8..dacbeb9b43461 100644 --- a/tests/phpunit/tests/blocks/setIgnoredHookedBlocksMetadata.php +++ b/tests/phpunit/tests/blocks/setIgnoredHookedBlocksMetadata.php @@ -11,6 +11,22 @@ * @group block-hooks */ class Tests_Blocks_SetIgnoredHookedBlocksMetadata extends WP_UnitTestCase { + /** + * Tear down after each test. + */ + public function tear_down() { + // Removes test block types registered by test cases. + $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered(); + foreach ( $block_types as $block_type ) { + $block_name = $block_type->name; + if ( str_starts_with( $block_name, 'tests/' ) ) { + unregister_block_type( $block_name ); + } + } + + parent::tear_down(); + } + /** * @ticket 60506 */ @@ -37,13 +53,16 @@ public function test_set_ignored_hooked_blocks_metadata() { 'blockName' => 'tests/anchor-block', ); - $hooked_blocks = array( - 'tests/anchor-block' => array( - 'after' => array( 'tests/hooked-block' ), - ), + register_block_type( + 'tests/hooked-block', + array( + 'block_hooks' => array( + 'tests/anchor-block' => 'after', + ), + ) ); - set_ignored_hooked_blocks_metadata( $anchor_block, 'after', $hooked_blocks, null ); + set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, null ); $this->assertSame( array( 'tests/hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] ); } @@ -62,13 +81,16 @@ public function test_set_ignored_hooked_blocks_metadata_retains_existing_items() ), ); - $hooked_blocks = array( - 'tests/anchor-block' => array( - 'after' => array( 'tests/hooked-block' ), - ), + register_block_type( + 'tests/hooked-block', + array( + 'block_hooks' => array( + 'tests/anchor-block' => 'after', + ), + ) ); - set_ignored_hooked_blocks_metadata( $anchor_block, 'after', $hooked_blocks, null ); + set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, null ); $this->assertSame( array( 'tests/other-ignored-block', 'tests/hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] @@ -86,8 +108,6 @@ public function test_set_ignored_hooked_blocks_metadata_for_block_added_by_filte 'attrs' => array(), ); - $hooked_blocks = array(); - $filter = function ( $hooked_block_types, $relative_position, $anchor_block_type ) { if ( 'tests/anchor-block' === $anchor_block_type && 'after' === $relative_position ) { $hooked_block_types[] = 'tests/hooked-block-added-by-filter'; @@ -97,7 +117,7 @@ public function test_set_ignored_hooked_blocks_metadata_for_block_added_by_filte }; add_filter( 'hooked_block_types', $filter, 10, 3 ); - set_ignored_hooked_blocks_metadata( $anchor_block, 'after', $hooked_blocks, null ); + set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, null ); remove_filter( 'hooked_block_types', $filter, 10 ); $this->assertSame( @@ -136,7 +156,7 @@ public function test_set_ignored_hooked_blocks_metadata_for_block_added_by_conte $template = self::create_block_template_object(); add_filter( 'hooked_block_types', $filter, 10, 4 ); - set_ignored_hooked_blocks_metadata( $anchor_block, 'after', array(), $template ); + set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, $template ); remove_filter( 'hooked_block_types', $filter, 10 ); $this->assertSame( @@ -156,10 +176,14 @@ public function test_set_ignored_hooked_blocks_metadata_for_block_suppressed_by_ 'attrs' => array(), ); - $hooked_blocks = array( - 'tests/anchor-block' => array( - 'after' => array( 'tests/hooked-block', 'tests/hooked-block-suppressed-by-filter' ), - ), + register_block_type( + 'tests/hooked-block', + array( + 'block_hooks' => array( + 'tests/anchor-block' => 'after', + 'tests/hooked-block-suppressed-by-filter' => 'after', + ), + ) ); $filter = function ( $parsed_hooked_block, $hooked_block_type, $relative_position, $parsed_anchor_block ) { @@ -175,7 +199,7 @@ public function test_set_ignored_hooked_blocks_metadata_for_block_suppressed_by_ }; add_filter( 'hooked_block', $filter, 10, 4 ); - set_ignored_hooked_blocks_metadata( $anchor_block, 'after', $hooked_blocks, null ); + set_ignored_hooked_blocks_metadata( $anchor_block, 'after', null, null ); remove_filter( 'hooked_block', $filter ); $this->assertSame( array( 'tests/hooked-block' ), $anchor_block['attrs']['metadata']['ignoredHookedBlocks'] );