mirrored from git://develop.git.wordpress.org/
/
editor.php
545 lines (483 loc) · 14.4 KB
/
editor.php
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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
<?php
/**
* Block editor tests
*
* @package WordPress
* @subpackage Blocks
* @since 5.5.0
*/
/**
* Tests for the block editor methods.
*
* @since 5.5.0
*
* @group blocks
*/
class Tests_Blocks_Editor extends WP_UnitTestCase {
/**
* Sets up each test method.
*/
public function set_up() {
global $post;
parent::set_up();
$args = array(
'post_title' => 'Example',
);
$post = $this->factory()->post->create_and_get( $args );
global $wp_rest_server;
$wp_rest_server = new Spy_REST_Server;
do_action( 'rest_api_init', $wp_rest_server );
}
public function tear_down() {
/** @var WP_REST_Server $wp_rest_server */
global $wp_rest_server;
$wp_rest_server = null;
parent::tear_down();
}
public function filter_set_block_categories_post( $block_categories, $post ) {
if ( empty( $post ) ) {
return $block_categories;
}
return array(
array(
'slug' => 'filtered-category',
'title' => 'Filtered Category',
'icon' => null,
),
);
}
public function filter_set_allowed_block_types_post( $allowed_block_types, $post ) {
if ( empty( $post ) ) {
return $allowed_block_types;
}
return array( 'test/filtered-block' );
}
public function filter_set_block_editor_settings_post( $editor_settings, $post ) {
if ( empty( $post ) ) {
return $allowed_block_types;
}
return array(
'filter' => 'deprecated',
);
}
/**
* @ticket 52920
*/
public function test_block_editor_context_no_settings() {
$context = new WP_Block_Editor_Context();
$this->assertNull( $context->post );
}
/**
* @ticket 52920
*/
public function test_block_editor_context_post() {
$context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
$this->assertSame( get_post(), $context->post );
}
/**
* @ticket 52920
* @expectedDeprecated block_categories
*/
public function test_get_block_categories_deprecated_filter_post_object() {
add_filter( 'block_categories', array( $this, 'filter_set_block_categories_post' ), 10, 2 );
$block_categories = get_block_categories( get_post() );
remove_filter( 'block_categories', array( $this, 'filter_set_block_categories_post' ) );
$this->assertSameSets(
array(
array(
'slug' => 'filtered-category',
'title' => 'Filtered Category',
'icon' => null,
),
),
$block_categories
);
}
/**
* @ticket 52920
* @expectedDeprecated block_categories
*/
public function test_get_block_categories_deprecated_filter_post_editor() {
add_filter( 'block_categories', array( $this, 'filter_set_block_categories_post' ), 10, 2 );
$post_editor_context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
$block_categories = get_block_categories( $post_editor_context );
remove_filter( 'block_categories', array( $this, 'filter_set_block_categories_post' ) );
$this->assertSameSets(
array(
array(
'slug' => 'filtered-category',
'title' => 'Filtered Category',
'icon' => null,
),
),
$block_categories
);
}
/**
* @ticket 52920
*/
public function test_get_allowed_block_types_default() {
$post_editor_context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
$allowed_block_types = get_allowed_block_types( $post_editor_context );
$this->assertTrue( $allowed_block_types );
}
/**
* @ticket 52920
* @expectedDeprecated allowed_block_types
*/
public function test_get_allowed_block_types_deprecated_filter_post_editor() {
add_filter( 'allowed_block_types', array( $this, 'filter_set_allowed_block_types_post' ), 10, 2 );
$post_editor_context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
$allowed_block_types = get_allowed_block_types( $post_editor_context );
remove_filter( 'allowed_block_types', array( $this, 'filter_set_allowed_block_types_post' ) );
$this->assertSameSets( array( 'test/filtered-block' ), $allowed_block_types );
}
/**
* @ticket 52920
*/
public function test_get_default_block_editor_settings() {
$settings = get_default_block_editor_settings();
$this->assertCount( 17, $settings );
$this->assertFalse( $settings['alignWide'] );
$this->assertIsArray( $settings['allowedMimeTypes'] );
$this->assertTrue( $settings['allowedBlockTypes'] );
$this->assertSameSets(
array(
array(
'slug' => 'text',
'title' => 'Text',
'icon' => null,
),
array(
'slug' => 'media',
'title' => 'Media',
'icon' => null,
),
array(
'slug' => 'design',
'title' => 'Design',
'icon' => null,
),
array(
'slug' => 'widgets',
'title' => 'Widgets',
'icon' => null,
),
array(
'slug' => 'theme',
'title' => 'Theme',
'icon' => null,
),
array(
'slug' => 'embed',
'title' => 'Embeds',
'icon' => null,
),
array(
'slug' => 'reusable',
'title' => 'Reusable Blocks',
'icon' => null,
),
),
$settings['blockCategories']
);
$this->assertFalse( $settings['disableCustomColors'] );
$this->assertFalse( $settings['disableCustomFontSizes'] );
$this->assertFalse( $settings['disableCustomGradients'] );
$this->assertFalse( $settings['enableCustomLineHeight'] );
$this->assertFalse( $settings['enableCustomSpacing'] );
$this->assertFalse( $settings['enableCustomUnits'] );
$this->assertFalse( $settings['isRTL'] );
$this->assertSame( 'large', $settings['imageDefaultSize'] );
$this->assertSameSets(
array(
array(
'width' => 150,
'height' => 150,
'crop' => true,
),
array(
'width' => 300,
'height' => 300,
'crop' => false,
),
array(
'width' => 1024,
'height' => 1024,
'crop' => false,
),
),
$settings['imageDimensions']
);
$this->assertTrue( $settings['imageEditing'] );
$this->assertSameSets(
array(
array(
'slug' => 'full',
'name' => 'Full Size',
),
array(
'slug' => 'large',
'name' => 'Large',
),
array(
'slug' => 'medium',
'name' => 'Medium',
),
array(
'slug' => 'thumbnail',
'name' => 'Thumbnail',
),
),
$settings['imageSizes']
);
$this->assertIsInt( $settings['maxUploadFileSize'] );
}
/**
* @ticket 53397
*/
public function test_get_legacy_widget_block_editor_settings() {
$settings = get_legacy_widget_block_editor_settings();
$this->assertCount( 1, $settings );
$this->assertSameSets(
array(
'archives',
'block',
'calendar',
'categories',
'custom_html',
'media_audio',
'media_gallery',
'media_image',
'media_video',
'pages',
'recent-comments',
'recent-posts',
'rss',
'search',
'tag_cloud',
'text',
),
$settings['widgetTypesToHideFromLegacyWidgetBlock']
);
}
/**
* @ticket 52920
*/
public function test_get_block_editor_settings_overrides_default_settings_all_editors() {
function filter_allowed_block_types_my_editor() {
return array( 'test/filtered-my-block' );
}
function filter_block_categories_my_editor() {
return array(
array(
'slug' => 'filtered-my-category',
'title' => 'Filtered My Category',
'icon' => null,
),
);
}
function filter_block_editor_settings_my_editor( $editor_settings ) {
$editor_settings['maxUploadFileSize'] = 12345;
return $editor_settings;
}
add_filter( 'allowed_block_types_all', 'filter_allowed_block_types_my_editor', 10, 1 );
add_filter( 'block_categories_all', 'filter_block_categories_my_editor', 10, 1 );
add_filter( 'block_editor_settings_all', 'filter_block_editor_settings_my_editor', 10, 1 );
$my_editor_context = new WP_Block_Editor_Context();
$settings = get_block_editor_settings( array(), $my_editor_context );
remove_filter( 'allowed_block_types_all', 'filter_allowed_block_types_my_editor' );
remove_filter( 'block_categories_all', 'filter_block_categories_my_editor' );
remove_filter( 'block_editor_settings_all', 'filter_block_editor_settings_my_editor' );
$this->assertSameSets( array( 'test/filtered-my-block' ), $settings['allowedBlockTypes'] );
$this->assertSameSets(
array(
array(
'slug' => 'filtered-my-category',
'title' => 'Filtered My Category',
'icon' => null,
),
),
$settings['blockCategories']
);
$this->assertSame( 12345, $settings['maxUploadFileSize'] );
}
/**
* @ticket 53458
*/
public function test_get_block_editor_settings_theme_json_settings() {
switch_theme( 'block-theme' );
$post_editor_context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
$settings = get_block_editor_settings( array(), $post_editor_context );
// Related entry in theme.json: settings.color.palette
$this->assertSameSetsWithIndex(
array(
array(
'slug' => 'light',
'name' => 'Light',
'color' => '#f5f7f9',
),
array(
'slug' => 'dark',
'name' => 'Dark',
'color' => '#000',
),
),
$settings['colors']
);
// settings.color.gradients
$this->assertSameSetsWithIndex(
array(
array(
'name' => 'Custom gradient',
'gradient' => 'linear-gradient(135deg,rgba(0,0,0) 0%,rgb(0,0,0) 100%)',
'slug' => 'custom-gradient',
),
),
$settings['gradients']
);
// settings.typography.fontSizes
$this->assertSameSetsWithIndex(
array(
array(
'name' => 'Custom',
'slug' => 'custom',
'size' => '100px',
),
),
$settings['fontSizes']
);
// settings.color.custom
$this->assertTrue( $settings['disableCustomColors'] );
// settings.color.customGradient
$this->assertTrue( $settings['disableCustomGradients'] );
// settings.typography.customFontSize
$this->assertTrue( $settings['disableCustomFontSizes'] );
// settings.typography.customLineHeight
$this->assertTrue( $settings['enableCustomLineHeight'] );
// settings.spacing.enableCustomUnits
$this->assertSameSets( array( 'rem' ), $settings['enableCustomUnits'] );
// settings.spacing.customPadding
$this->assertTrue( $settings['enableCustomSpacing'] );
switch_theme( WP_DEFAULT_THEME );
}
/**
* @ticket 52920
* @expectedDeprecated block_editor_settings
*/
public function test_get_block_editor_settings_deprecated_filter_post_editor() {
add_filter( 'block_editor_settings', array( $this, 'filter_set_block_editor_settings_post' ), 10, 2 );
$post_editor_context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
$settings = get_block_editor_settings( array(), $post_editor_context );
remove_filter( 'block_editor_settings', array( $this, 'filter_set_block_editor_settings_post' ) );
$this->assertSameSets(
array(
'filter' => 'deprecated',
),
$settings
);
}
/**
* @ticket 52920
*/
public function test_block_editor_rest_api_preload_no_paths() {
$editor_context = new WP_Block_Editor_Context();
block_editor_rest_api_preload( array(), $editor_context );
$after = implode( '', wp_scripts()->registered['wp-api-fetch']->extra['after'] );
$this->assertStringNotContainsString( 'wp.apiFetch.createPreloadingMiddleware', $after );
}
/**
* @ticket 52920
* @expectedDeprecated block_editor_preload_paths
*/
public function test_block_editor_rest_api_preload_deprecated_filter_post_editor() {
function filter_remove_preload_paths( $preload_paths, $post ) {
if ( empty( $post ) ) {
return $preload_paths;
}
return array();
}
add_filter( 'block_editor_preload_paths', 'filter_remove_preload_paths', 10, 2 );
$post_editor_context = new WP_Block_Editor_Context( array( 'post' => get_post() ) );
block_editor_rest_api_preload(
array(
array( '/wp/v2/blocks', 'OPTIONS' ),
),
$post_editor_context
);
remove_filter( 'block_editor_preload_paths', 'filter_remove_preload_paths' );
$after = implode( '', wp_scripts()->registered['wp-api-fetch']->extra['after'] );
$this->assertStringNotContainsString( 'wp.apiFetch.createPreloadingMiddleware', $after );
}
/**
* @ticket 52920
*/
public function test_block_editor_rest_api_preload_filter_all() {
function filter_add_preload_paths( $preload_paths, WP_Block_Editor_Context $context ) {
if ( empty( $context->post ) ) {
array_push( $preload_paths, array( '/wp/v2/types', 'OPTIONS' ) );
}
return $preload_paths;
}
add_filter( 'block_editor_rest_api_preload_paths', 'filter_add_preload_paths', 10, 2 );
$editor_context = new WP_Block_Editor_Context();
block_editor_rest_api_preload(
array(
array( '/wp/v2/blocks', 'OPTIONS' ),
),
$editor_context
);
remove_filter( 'block_editor_rest_api_preload_paths', 'filter_add_preload_paths' );
$after = implode( '', wp_scripts()->registered['wp-api-fetch']->extra['after'] );
$this->assertStringContainsString( 'wp.apiFetch.createPreloadingMiddleware', $after );
$this->assertStringContainsString( '"\/wp\/v2\/blocks"', $after );
$this->assertStringContainsString( '"\/wp\/v2\/types"', $after );
}
/**
* @ticket 54558
* @dataProvider data_block_editor_rest_api_preload_adds_missing_leading_slash
*
* @covers ::block_editor_rest_api_preload
*
* @param array $preload_paths The paths to preload.
* @param string $expected The expected substring.
*/
public function test_block_editor_rest_api_preload_adds_missing_leading_slash( array $preload_paths, $expected ) {
block_editor_rest_api_preload( $preload_paths, new WP_Block_Editor_Context() );
$haystack = implode( '', wp_scripts()->registered['wp-api-fetch']->extra['after'] );
$this->assertStringContainsString( $expected, $haystack );
}
/**
* Data provider.
*
* @return array
*/
public function data_block_editor_rest_api_preload_adds_missing_leading_slash() {
return array(
'a string without a slash' => array(
'preload_paths' => array( 'wp/v2/blocks' ),
'expected' => '\/wp\/v2\/blocks',
),
'a string with a slash' => array(
'preload_paths' => array( '/wp/v2/blocks' ),
'expected' => '\/wp\/v2\/blocks',
),
'a string starting with a question mark' => array(
'preload_paths' => array( '?context=edit' ),
'expected' => '/?context=edit',
),
'an array with a string without a slash' => array(
'preload_paths' => array( array( 'wp/v2/blocks', 'OPTIONS' ) ),
'expected' => '\/wp\/v2\/blocks',
),
'an array with a string with a slash' => array(
'preload_paths' => array( array( '/wp/v2/blocks', 'OPTIONS' ) ),
'expected' => '\/wp\/v2\/blocks',
),
'an array with a string starting with a question mark' => array(
'preload_paths' => array( array( '?context=edit', 'OPTIONS' ) ),
'expected' => '\/?context=edit',
),
);
}
}