Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Block Hooks: Respect "multiple": false #7296

Closed
wants to merge 7 commits into from
Closed

Block Hooks: Respect "multiple": false #7296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
20e160c
Tests: Register hooked blocks
ockham Sep 5, 2024
083c5fc
Make setup/teardown static
ockham Sep 5, 2024
277ee61
Infer hooked blocks via get_hooked_blocks()
ockham Sep 5, 2024
f94e9f4
Fix setup and teardown in other test
ockham Sep 5, 2024
67ad648
Don't insert block if multiple:false and another instance is already …
ockham Sep 5, 2024
29fbae6
Whitespace
ockham Sep 5, 2024
b75c0eb
Add unit test coverage for subsequent insertion
ockham Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/wp-includes/blocks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,6 +916,29 @@ function insert_hooked_blocks( &$parsed_anchor_block, $relative_position, $hooke

$markup = '';
foreach ( $hooked_block_types as $hooked_block_type ) {
$hooked_block_type_definition = WP_Block_Type_Registry::get_instance()->get_registered( $hooked_block_type );
if ( ! $hooked_block_type_definition ) {
continue;
}
if ( false === block_has_support( $hooked_block_type_definition, 'multiple', true ) ) {
if ( $context instanceof WP_Block_Template ) {
// Template or template part.
$content = $context->content;
} elseif ( $context instanceof WP_Post ) {
// wp_navigation post.
$content = $context->post_content;
} elseif ( is_array( $context ) && isset( $context['content'] ) ) {
// Pattern.
$content = $context['content'];
} else {
$content = '';
}

if ( ! empty( $content ) && has_block( $hooked_block_type, $content ) ) {
continue;
}
}

$parsed_hooked_block = array(
'blockName' => $hooked_block_type,
'attrs' => array(),
Expand Down
115 changes: 103 additions & 12 deletions tests/phpunit/tests/blocks/insertHookedBlocks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,45 @@ 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 ),
),
);
/**
* Set up.
*
* @ticket 61902.
*/
public static function wpSetUpBeforeClass() {
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',
),
'supports' => array(
'multiple' => false,
),
)
);
}

/**
* Tear down.
*
* @ticket 61902.
*/
public static function wpTearDownAfterClass() {
$registry = WP_Block_Type_Registry::get_instance();

$registry->unregister( self::HOOKED_BLOCK_TYPE );
$registry->unregister( self::OTHER_HOOKED_BLOCK_TYPE );
}

/**
* @ticket 59572
Expand All @@ -34,7 +67,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', get_hooked_blocks(), array() );
$this->assertSame(
'<!-- wp:' . self::HOOKED_BLOCK_TYPE . ' /-->',
$actual,
Expand All @@ -59,7 +92,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', get_hooked_blocks(), array() );
$this->assertSame(
'',
$actual,
Expand All @@ -84,14 +117,72 @@ 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', get_hooked_blocks(), array() );
$this->assertSame(
'<!-- wp:' . self::OTHER_HOOKED_BLOCK_TYPE . ' /-->',
$actual,
"Markup for newly hooked block should've been generated."
);
}

/**
* @ticket 61902
*
* @covers ::insert_hooked_blocks
*/
public function test_insert_hooked_blocks_if_block_has_multiple_false_and_is_already_present() {
$anchor_block = array(
'blockName' => 'tests/anchor-block',
);

$context = new WP_Block_Template();
$context->content = '<!-- wp:' . self::ANCHOR_BLOCK_TYPE . ' /-->';
$context->content .= '<!-- wp:' . self::OTHER_HOOKED_BLOCK_TYPE . ' /-->';

$actual = insert_hooked_blocks( $anchor_block, 'before', get_hooked_blocks(), $context );
$this->assertSame(
'',
$actual,
'Hooked block with "multiple": false should not be inserted if another instance is already present.'
);
$actual = insert_hooked_blocks( $anchor_block, 'before', get_hooked_blocks(), $context );
$this->assertSame(
'',
$actual,
'Hooked block with "multiple": false should not be inserted if another instance is already present.'
);
}

/**
* @ticket 61902
*
* @covers ::insert_hooked_blocks
*/
public function test_insert_hooked_blocks_if_block_has_multiple_false_but_is_not_yet_present() {
$anchor_block = array(
'blockName' => 'tests/anchor-block',
);

$context = new WP_Block_Template();
$context->content = '<!-- wp:' . self::ANCHOR_BLOCK_TYPE . ' /-->';

$expected = '<!-- wp:' . self::OTHER_HOOKED_BLOCK_TYPE . ' /-->';
$actual = insert_hooked_blocks( $anchor_block, 'before', get_hooked_blocks(), $context );
$this->assertSame(
$expected,
$actual,
'Hooked block with "multiple": false should be inserted if another instance is not present.'
);

$context->content = $expected . $context->content; // Simulate result of first insertion.
$actual = insert_hooked_blocks( $anchor_block, 'before', get_hooked_blocks(), $context );
$this->assertSame(
'',
$actual,
'Hooked block with "multiple": false should not be inserted if another instance is already present.'
);
}

/**
* @ticket 59572
* @ticket 60126
Expand Down Expand Up @@ -125,7 +216,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', get_hooked_blocks(), array() );
remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter );

$this->assertSame(
Expand Down Expand Up @@ -171,7 +262,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', get_hooked_blocks(), array() );
remove_filter( 'hooked_block_' . self::HOOKED_BLOCK_TYPE, $filter );

$this->assertSame(
Expand Down Expand Up @@ -213,7 +304,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', get_hooked_blocks(), 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." );
Expand Down
53 changes: 44 additions & 9 deletions tests/phpunit/tests/blocks/insertHookedBlocksAndSetIgnoredHookedBlocksMetadata.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,47 @@ class Tests_Blocks_InsertHookedBlocksAndSetIgnoredHookedBlocksMetadata extends W
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 ),
),
);
/**
* Set up.
*
* @ticket 61902.
*/
public static function wpSetUpBeforeClass() {
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',
),
)
);

register_block_type( 'tests/hooked-block-added-by-filter' );
register_block_type( 'tests/hooked-block-suppressed-by-filter' );
}

/**
* Tear down.
*
* @ticket 61902.
*/
public static function wpTearDownAfterClass() {
$registry = WP_Block_Type_Registry::get_instance();

$registry->unregister( self::HOOKED_BLOCK_TYPE );
$registry->unregister( self::OTHER_HOOKED_BLOCK_TYPE );
$registry->unregister( 'tests/hooked-block-added-by-filter' );
$registry->unregister( 'tests/hooked-block-suppressed-by-filter' );
}

/**
* @ticket 59574
Expand All @@ -47,7 +82,7 @@ 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() );
$actual = insert_hooked_blocks_and_set_ignored_hooked_blocks_metadata( $anchor_block, 'after', get_hooked_blocks(), array() );
$this->assertSame(
'<!-- wp:' . self::HOOKED_BLOCK_TYPE . ' /-->',
$actual,
Expand All @@ -73,7 +108,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', get_hooked_blocks(), array() );
$this->assertSame(
'',
$actual,
Expand Down Expand Up @@ -147,7 +182,7 @@ 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', get_hooked_blocks(), 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." );
Expand Down
Loading