forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrenderBlock.php
More file actions
323 lines (278 loc) · 8.29 KB
/
renderBlock.php
File metadata and controls
323 lines (278 loc) · 8.29 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
<?php
/**
* Tests for render block functions.
*
* @package WordPress
* @subpackage Blocks
* @since 5.5.0
*
* @group blocks
*/
class Tests_Blocks_RenderBlock extends WP_UnitTestCase {
/**
* Sets up each test method.
*/
public function set_up() {
global $post;
parent::set_up();
$args = array(
'post_content' => 'example',
'post_excerpt' => '',
);
$post = self::factory()->post->create_and_get( $args );
setup_postdata( $post );
}
/**
* Tear down each test method.
*/
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();
}
/**
* Tests that a block which provides context makes that context available to
* its inner blocks.
*
* @ticket 49927
*
* @covers ::register_block_type
* @covers ::render_block
*/
public function test_provides_block_context() {
$provided_context = array();
register_block_type(
'tests/context-provider',
array(
'attributes' => array(
'contextWithAssigned' => array(
'type' => 'number',
),
'contextWithDefault' => array(
'type' => 'number',
'default' => 0,
),
'contextWithoutDefault' => array(
'type' => 'number',
),
'contextNotRequested' => array(
'type' => 'number',
),
),
'provides_context' => array(
'tests/contextWithAssigned' => 'contextWithAssigned',
'tests/contextWithDefault' => 'contextWithDefault',
'tests/contextWithoutDefault' => 'contextWithoutDefault',
'tests/contextNotRequested' => 'contextNotRequested',
),
)
);
register_block_type(
'tests/context-consumer',
array(
'uses_context' => array(
'tests/contextWithDefault',
'tests/contextWithAssigned',
'tests/contextWithoutDefault',
),
'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
$provided_context[] = $block->context;
return '';
},
)
);
$parsed_blocks = parse_blocks(
'<!-- wp:tests/context-provider {"contextWithAssigned":10} -->' .
'<!-- wp:tests/context-consumer /-->' .
'<!-- /wp:tests/context-provider -->'
);
render_block( $parsed_blocks[0] );
$this->assertSame(
array(
'tests/contextWithDefault' => 0,
'tests/contextWithAssigned' => 10,
),
$provided_context[0]
);
}
/**
* Tests that a block can receive default-provided context through
* render_block.
*
* @ticket 49927
*
* @covers ::register_block_type
* @covers ::render_block
*/
public function test_provides_default_context() {
global $post;
$provided_context = array();
register_block_type(
'tests/context-consumer',
array(
'uses_context' => array( 'postId', 'postType' ),
'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
$provided_context[] = $block->context;
return '';
},
)
);
$parsed_blocks = parse_blocks( '<!-- wp:tests/context-consumer /-->' );
render_block( $parsed_blocks[0] );
$this->assertSame(
array(
'postId' => $post->ID,
'postType' => $post->post_type,
),
$provided_context[0]
);
}
/**
* Tests that default block context can be filtered.
*
* @ticket 49927
*
* @covers ::register_block_type
* @covers ::render_block
*/
public function test_default_context_is_filterable() {
$provided_context = array();
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_block_context = static function ( $context ) {
$context['example'] = 'ok';
return $context;
};
$parsed_blocks = parse_blocks( '<!-- wp:tests/context-consumer /-->' );
add_filter( 'render_block_context', $filter_block_context );
render_block( $parsed_blocks[0] );
remove_filter( 'render_block_context', $filter_block_context );
$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->assertArrayHasKey( 'example', $provided_context, '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->assertArrayHasKey( 'example', $provided_context, '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 arbitrary 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' ),
'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
$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['arbitrary'] = 'ok';
}
return $context;
},
10,
2
);
do_blocks(
<<<HTML
<!-- wp:tests/context-consumer /-->
HTML
);
$this->assertArrayNotHasKey( 'arbitrary', $provided_context, 'Test block is top-level block: Block context should not include "arbitrary"' );
do_blocks(
<<<HTML
<!-- wp:group {"layout":{"type":"constrained"}} -->
<!-- wp:tests/context-consumer /-->
<!-- /wp:group -->
HTML
);
/*
* These assertions assert something that ideally should not be the case: Inner blocks should respect the
* `uses_context` value just like top-level blocks do. However, due to logic in `WP_Block::render()`, the
* `context` property value itself is filterable when it should rather only apply to the `available_context`
* property.
* However, changing this behavior now would be a backward compatibility break, hence the assertion here.
* Potentially it can be reconsidered in the future, so that these two assertions could be replaced with an
* `assertArrayNotHasKey( 'arbitrary', $provided_context )`.
*/
$this->assertArrayHasKey( 'arbitrary', $provided_context, 'Test block is inner block: Block context should include "arbitrary"' );
$this->assertSame( 'ok', $provided_context['arbitrary'], 'Test block is inner block: "arbitrary" in context should be "ok"' );
}
}