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

Jump to bottom

render_block_context another approach that solve the context issue #7522

Open
wants to merge 31 commits into
base: trunk
Choose a base branch
from
+167 −8
Open

render_block_context another approach that solve the context issue #7522

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
3bf219c
Introduce update_available_context()
mukeshpanchal27 Oct 7, 2024
7b54206
Apply suggestions from code review
mukeshpanchal27 Oct 7, 2024
dbd6126
Add unit tests
mukeshpanchal27 Oct 7, 2024
c229a57
Apply suggestions from code review
mukeshpanchal27 Oct 7, 2024
a95ca1d
Pull latest tests
mukeshpanchal27 Oct 8, 2024
976d7d6
Update renderBlock.php
mukeshpanchal27 Oct 8, 2024
adf52a7
Unexpected error
mukeshpanchal27 Oct 8, 2024
d410a3c
Commaaaa
mukeshpanchal27 Oct 8, 2024
b0af042
Add get_block_type_uses_context filter
mukeshpanchal27 Oct 8, 2024
a6db0fd
Remove stale condition
mukeshpanchal27 Oct 9, 2024
5cbb114
Call function if filter change the context value
mukeshpanchal27 Oct 9, 2024
898d29c
Address review feedbacks and add function docblock
mukeshpanchal27 Oct 9, 2024
fc76e2c
Remove whitespace
mukeshpanchal27 Oct 9, 2024
40bfc5e
Update docblock.
mukeshpanchal27 Oct 9, 2024
f50736d
Spaceee
mukeshpanchal27 Oct 9, 2024
ec2c0ab
Merge branch 'WordPress:trunk' into fix/62046-test-approach
mukeshpanchal27 Oct 10, 2024
e1203be
Apply suggestions from code review
mukeshpanchal27 Oct 10, 2024
218b887
Remove `get_block_type_uses_context` filter
mukeshpanchal27 Oct 10, 2024
33930ed
Initialize property as empty array by default
mukeshpanchal27 Oct 10, 2024
192e5ae
Revert context change
mukeshpanchal27 Oct 14, 2024
819e9db
Try to fix context
mukeshpanchal27 Oct 14, 2024
dc6577b
Update function name and docblock
mukeshpanchal27 Oct 16, 2024
28ce083
Fix unit tests for wpBlock.php
mukeshpanchal27 Oct 16, 2024
2c46470
PHPCS
mukeshpanchal27 Oct 16, 2024
9764c52
Apply suggestions from code review
mukeshpanchal27 Oct 16, 2024
de703d9
Fix unit tests for renderBlock.php
mukeshpanchal27 Oct 16, 2024
6c4f6cd
Fix unit tests for render.php
mukeshpanchal27 Oct 16, 2024
c7c5418
Move provides_context in to refresh_parsed_block_dependents()
mukeshpanchal27 Oct 17, 2024
dce8002
Bump the WP version number
mukeshpanchal27 Oct 28, 2024
22772c1
Merge branch 'WordPress:trunk' into fix/62046-test-approach
mukeshpanchal27 Nov 5, 2024
c83ca82
Remove context merging
mukeshpanchal27 Nov 5, 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
30 changes: 21 additions & 9 deletions src/wp-includes/class-wp-block.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,24 @@ public function __construct( $block, $available_context = array(), $registry = n
$this->block_type = $registry->get_registered( $this->name );

$this->available_context = $available_context;
$this->update_available_context( $block, $available_context );
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved

if ( ! empty( $block['innerHTML'] ) ) {
$this->inner_html = $block['innerHTML'];
}

if ( ! empty( $block['innerContent'] ) ) {
$this->inner_content = $block['innerContent'];
}
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
}

public function update_available_context( $block, $available_context ) {
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
$this->context = array();
if ( null === $this->available_context ) {
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
$this->available_context = $available_context;
} else {
$this->available_context = array_merge( $this->available_context, $available_context );
}

if ( ! empty( $this->block_type->uses_context ) ) {
foreach ( $this->block_type->uses_context as $context_name ) {
Expand All @@ -159,15 +177,7 @@ public function __construct( $block, $available_context = array(), $registry = n
}
}

$this->inner_blocks = new WP_Block_List( $block['innerBlocks'], $child_context, $registry );
}

if ( ! empty( $block['innerHTML'] ) ) {
$this->inner_html = $block['innerHTML'];
}

if ( ! empty( $block['innerContent'] ) ) {
$this->inner_content = $block['innerContent'];
$this->inner_blocks = new WP_Block_List( $block['innerBlocks'], $child_context, $this->registry );
}
}

Expand Down Expand Up @@ -514,6 +524,8 @@ public function render( $options = array() ) {
/** This filter is documented in wp-includes/blocks.php */
$inner_block->context = apply_filters( 'render_block_context', $inner_block->context, $inner_block->parsed_block, $parent_block );

$inner_block->update_available_context( $inner_block->parsed_block, $inner_block->context );
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved

$block_content .= $inner_block->render();
}

Expand Down
117 changes: 117 additions & 0 deletions tests/phpunit/tests/blocks/renderBlock.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,4 +192,121 @@

$this->assertSame( array( 'example' => 'ok' ), $provided_context[0] );
}

/**
* Tests the behavior of the 'render_block_context' filter based on the location of the filtered block.
*
* @ticket 62046
*/
public function test_render_block_context_inner_blocks() {
$provided_context = array();

register_block_type(
'tests/context-provider',
array(
'provides_context' => array( 'example' ),
)
);

register_block_type(
'tests/context-consumer',
array(
'uses_context' => array( 'example' ),
'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
$provided_context = $block->context;

return '';
},
)
);

// Filter the context provided by the test block.
add_filter(
'render_block_context',
function ( $context, $parsed_block ) {
if ( isset( $parsed_block['blockName'] ) && 'tests/context-provider' === $parsed_block['blockName'] ) {
$context['example'] = 'ok';
}

return $context;
},
10,
2
);

// Test inner block context when the provider block is a top-level block.
do_blocks(
<<<HTML
<!-- wp:tests/context-provider -->
<!-- wp:tests/context-consumer /-->
<!-- /wp:tests/context-provider -->
HTML
);
$this->assertTrue( isset( $provided_context['example'] ), 'Test block is top-level block: Context should include "example"' );
$this->assertSame( 'ok', $provided_context['example'], 'Test block is top-level block: "example" in context should be "ok"' );

// Test inner block context when the provider block is an inner block.
do_blocks(
<<<HTML
<!-- wp:group {"layout":{"type":"constrained"}} -->
<!-- wp:tests/context-provider -->
<!-- wp:tests/context-consumer /-->
<!-- /wp:tests/context-provider -->
<!-- /wp:group -->
HTML
);
$this->assertTrue( isset( $provided_context['example'] ), 'Test block is inner block: Block context should include "example"' );
$this->assertSame( 'ok', $provided_context['example'], 'Test block is inner block: "example" in context should be "ok"' );
}

/**
* Tests that the 'render_block_context' filter provides available context, not actual context.
*
* @ticket 62046
*/
public function test_render_block_context_allowed_context() {
$provided_context = array();

register_block_type(
'tests/context-consumer',
array(
'uses_context' => array( 'example' ),

Check warning on line 273 in tests/phpunit/tests/blocks/renderBlock.php

View workflow job for this annotation

GitHub Actions / PHP coding standards / Run coding standards checks 

Array double arrow not aligned correctly; expected 4 space(s) between "'uses_context'" and double arrow, but found 5.
'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {

Check warning on line 274 in tests/phpunit/tests/blocks/renderBlock.php

View workflow job for this annotation

GitHub Actions / PHP coding standards / Run coding standards checks 

Array double arrow not aligned correctly; expected 1 space(s) between "'render_callback'" and double arrow, but found 2.
mukeshpanchal27 marked this conversation as resolved.
Show resolved Hide resolved
$provided_context = $block->context;

return '';
},
)
);

// Filter the context provided to the test block.
add_filter(
'render_block_context',
function ( $context, $parsed_block ) {
if ( isset( $parsed_block['blockName'] ) && 'tests/context-consumer' === $parsed_block['blockName'] ) {
$context['invalid'] = 'ok';
}

return $context;
},
10,
2
);

do_blocks(
<<<HTML
<!-- wp:tests/context-consumer /-->
HTML
);
$this->assertFalse( isset( $provided_context['invalid'] ), 'Test block is top-level block: Context should not include unsupported properties"' );

do_blocks(
<<<HTML
<!-- wp:group {"layout":{"type":"constrained"}} -->
<!-- wp:tests/context-consumer /-->
<!-- /wp:group -->
HTML
);
$this->assertFalse( isset( $provided_context['invalid'] ), 'Test block is inner block: Context should not include unsupported properties' );
}
}
Loading