PluginProbe
Gutenberg / 16.2.0
Gutenberg v16.2.0
24.0.0 23.9.1 23.9.0 23.8.0 23.7.2 23.7.1 23.7.0 23.6.1 23.6.2 23.6.0 23.5.3 23.5.2 23.5.1 23.5.0 23.4.0 23.3.2 23.3.1 23.3.0 23.2.0 23.2.1 23.2.2 23.1.1 23.1.0 23.0.1 12.6.0 All 403 releases
← All changes | lib/blocks.php +70 -261 12.6.016.2.0 View file →
@@ -1,7 +1,7 @@
1 1 <?php
2 2 /**
3 - * Block and style registration functions.
3 + * Block functions specific for the Gutenberg editor plugin.
4 4 *
5 5 * @package gutenberg
6 6 */
7 7
@@ -20,25 +20,19 @@
20 20 'freeform',
21 21 'code',
22 22 'column',
23 23 'columns',
24 - 'comments-query-loop',
25 - 'cover',
26 - 'gallery',
24 + 'comments',
25 + 'details',
27 26 'group',
28 - 'heading',
27 + 'footnotes',
29 28 'html',
30 - 'home-link',
31 - 'image',
32 29 'list',
30 + 'list-item',
33 31 'media-text',
34 32 'missing',
35 33 'more',
36 - 'navigation-area',
37 - 'navigation-link',
38 - 'navigation-submenu',
39 34 'nextpage',
40 - 'pattern',
41 35 'paragraph',
42 36 'preformatted',
43 37 'pullquote',
44 38 'quote',
@@ -45,9 +39,9 @@
45 39 'separator',
46 40 'social-links',
47 41 'spacer',
48 42 'table',
49 - // 'table-of-contents',
43 + 'table-of-contents',
50 44 'text-columns',
51 45 'verse',
52 46 'video',
53 47 'embed',
@@ -53,11 +47,13 @@
53 47 'embed',
54 48 ),
55 49 'block_names' => array(
56 50 'archives.php' => 'core/archives',
51 + 'avatar.php' => 'core/avatar',
57 52 'block.php' => 'core/block',
58 53 'calendar.php' => 'core/calendar',
59 54 'categories.php' => 'core/categories',
55 + 'cover.php' => 'core/cover',
60 56 'comment-author-avatar.php' => 'core/comment-author-avatar',
61 57 'comment-author-name.php' => 'core/comment-author-name',
62 58 'comment-content.php' => 'core/comment-content',
63 59 'comment-date.php' => 'core/comment-date',
@@ -67,26 +63,29 @@
67 63 'comments-pagination.php' => 'core/comments-pagination',
68 64 'comments-pagination-next.php' => 'core/comments-pagination-next',
69 65 'comments-pagination-numbers.php' => 'core/comments-pagination-numbers',
70 66 'comments-pagination-previous.php' => 'core/comments-pagination-previous',
67 + 'comments-title.php' => 'core/comments-title',
68 + 'comments.php' => 'core/comments',
69 + 'footnotes.php' => 'core/footnotes',
71 70 'file.php' => 'core/file',
72 71 'home-link.php' => 'core/home-link',
73 72 'image.php' => 'core/image',
74 73 'gallery.php' => 'core/gallery',
74 + 'heading.php' => 'core/heading',
75 75 'latest-comments.php' => 'core/latest-comments',
76 76 'latest-posts.php' => 'core/latest-posts',
77 77 'loginout.php' => 'core/loginout',
78 78 'navigation.php' => 'core/navigation',
79 - 'navigation-area.php' => 'core/navigation-area',
80 79 'navigation-link.php' => 'core/navigation-link',
81 80 'navigation-submenu.php' => 'core/navigation-submenu',
82 81 'page-list.php' => 'core/page-list',
82 + 'page-list-item.php' => 'core/page-list-item',
83 83 'pattern.php' => 'core/pattern',
84 84 'post-author.php' => 'core/post-author',
85 85 'post-author-name.php' => 'core/post-author-name',
86 86 'post-author-biography.php' => 'core/post-author-biography',
87 87 'post-comment.php' => 'core/post-comment',
88 - 'post-comments.php' => 'core/post-comments',
89 88 'post-comments-count.php' => 'core/post-comments-count',
90 89 'post-comments-form.php' => 'core/post-comments-form',
91 90 'post-comments-link.php' => 'core/post-comments-link',
92 91 'post-content.php' => 'core/post-content',
@@ -94,11 +93,13 @@
94 93 'post-excerpt.php' => 'core/post-excerpt',
95 94 'post-featured-image.php' => 'core/post-featured-image',
96 95 'post-navigation-link.php' => 'core/post-navigation-link',
97 96 'post-terms.php' => 'core/post-terms',
97 + 'post-time-to-read.php' => 'core/post-time-to-read',
98 98 'post-title.php' => 'core/post-title',
99 99 'query.php' => 'core/query',
100 100 'post-template.php' => 'core/post-template',
101 + 'query-no-results.php' => 'core/query-no-results',
101 102 'query-pagination.php' => 'core/query-pagination',
102 103 'query-pagination-next.php' => 'core/query-pagination-next',
103 104 'query-pagination-numbers.php' => 'core/query-pagination-numbers',
104 105 'query-pagination-previous.php' => 'core/query-pagination-previous',
@@ -110,9 +111,8 @@
110 111 'social-link.php' => 'core/social-link',
111 112 'site-logo.php' => 'core/site-logo',
112 113 'site-tagline.php' => 'core/site-tagline',
113 114 'site-title.php' => 'core/site-title',
114 - // 'table-of-contents.php' => 'core/table-of-contents',
115 115 'tag-cloud.php' => 'core/tag-cloud',
116 116 'template-part.php' => 'core/template-part',
117 117 'term-description.php' => 'core/term-description',
118 118 ),
@@ -137,10 +137,8 @@
137 137 foreach ( $blocks_dirs as $blocks_dir => $details ) {
138 138 $block_folders = $details['block_folders'];
139 139 $block_names = $details['block_names'];
140 140
141 - $registry = WP_Block_Type_Registry::get_instance();
142 -
143 141 foreach ( $block_folders as $folder_name ) {
144 142 $block_json_file = $blocks_dir . $folder_name . '/block.json';
145 143
146 144 // Ideally, all paths to block metadata files should be listed in
@@ -147,15 +145,12 @@
147 145 // WordPress core. In this place we should rather use filter
148 146 // to replace paths with overrides defined by the plugin.
149 147 $metadata = json_decode( file_get_contents( $block_json_file ), true );
150 148 if ( ! is_array( $metadata ) || ! $metadata['name'] ) {
151 - return false;
149 + continue;
152 150 }
153 151
154 - if ( $registry->is_registered( $metadata['name'] ) ) {
155 - $registry->unregister( $metadata['name'] );
156 - }
157 -
152 + gutenberg_deregister_core_block_and_assets( $metadata['name'] );
158 153 gutenberg_register_core_block_assets( $folder_name );
159 154 register_block_type_from_metadata( $block_json_file );
160 155 }
161 156
@@ -160,16 +155,14 @@
160 155 }
161 156
162 157 foreach ( $block_names as $file => $sub_block_names ) {
163 158 if ( ! file_exists( $blocks_dir . $file ) ) {
164 - return;
159 + continue;
165 160 }
166 161
167 162 $sub_block_names_normalized = is_string( $sub_block_names ) ? array( $sub_block_names ) : $sub_block_names;
168 163 foreach ( $sub_block_names_normalized as $block_name ) {
169 - if ( $registry->is_registered( $block_name ) ) {
170 - $registry->unregister( $block_name );
171 - }
164 + gutenberg_deregister_core_block_and_assets( $block_name );
172 165 gutenberg_register_core_block_assets( $block_name );
173 166 }
174 167
175 168 require_once $blocks_dir . $file;
@@ -179,8 +172,30 @@
179 172
180 173 add_action( 'init', 'gutenberg_reregister_core_block_types' );
181 174
182 175 /**
176 + * Deregisters the existing core block type and its assets.
177 + *
178 + * @param string $block_name The name of the block.
179 + *
180 + * @return void
181 + */
182 +function gutenberg_deregister_core_block_and_assets( $block_name ) {
183 + $registry = WP_Block_Type_Registry::get_instance();
184 + if ( $registry->is_registered( $block_name ) ) {
185 + $block_type = $registry->get_registered( $block_name );
186 + if ( ! empty( $block_type->view_script_handles ) ) {
187 + foreach ( $block_type->view_script_handles as $view_script_handle ) {
188 + if ( str_starts_with( $view_script_handle, 'wp-block-' ) ) {
189 + wp_deregister_script( $view_script_handle );
190 + }
191 + }
192 + }
193 + $registry->unregister( $block_name );
194 + }
195 +}
196 +
197 +/**
183 198 * Registers block styles for a core block.
184 199 *
185 200 * @param string $block_name The block-name.
186 201 *
@@ -194,18 +209,19 @@
194 209 $block_name = str_replace( 'core/', '', $block_name );
195 210
196 211 // When in production, use the plugin's version as the default asset version;
197 212 // else (for development or test) default to use the current time.
198 - $default_version = defined( 'GUTENBERG_VERSION' ) && ! ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? GUTENBERG_VERSION : time();
213 + $default_version = defined( 'GUTENBERG_VERSION' ) && ! SCRIPT_DEBUG ? GUTENBERG_VERSION : time();
199 214
200 - $style_path = "build/block-library/blocks/$block_name/style.css";
201 - $editor_style_path = "build/block-library/blocks/$block_name/style-editor.css";
215 + $style_path = "build/block-library/blocks/$block_name/";
216 + $stylesheet_url = gutenberg_url( $style_path . 'style.css' );
217 + $stylesheet_path = gutenberg_dir_path() . $style_path . ( is_rtl() ? 'style-rtl.css' : 'style.css' );
202 218
203 - if ( file_exists( gutenberg_dir_path() . $style_path ) ) {
219 + if ( file_exists( $stylesheet_path ) ) {
204 220 wp_deregister_style( "wp-block-{$block_name}" );
205 221 wp_register_style(
206 222 "wp-block-{$block_name}",
207 - gutenberg_url( $style_path ),
223 + $stylesheet_url,
208 224 array(),
209 225 $default_version
210 226 );
211 227 wp_style_add_data( "wp-block-{$block_name}", 'rtl', 'replace' );
@@ -210,11 +226,11 @@
210 226 );
211 227 wp_style_add_data( "wp-block-{$block_name}", 'rtl', 'replace' );
212 228
213 229 // Add a reference to the stylesheet's path to allow calculations for inlining styles in `wp_head`.
214 - wp_style_add_data( "wp-block-{$block_name}", 'path', gutenberg_dir_path() . $style_path );
230 + wp_style_add_data( "wp-block-{$block_name}", 'path', $stylesheet_path );
215 231 } else {
216 - wp_register_style( "wp-block-{$block_name}", false );
232 + wp_register_style( "wp-block-{$block_name}", false, array() );
217 233 }
218 234
219 235 // If the current theme supports wp-block-styles, dequeue the full stylesheet
220 236 // and instead attach each block's theme-styles to their block styles stylesheet.
@@ -225,9 +241,9 @@
225 241 static $stylesheet_removed;
226 242 if ( ! $stylesheet_removed ) {
227 243 add_action(
228 244 'wp_enqueue_scripts',
229 - function() {
245 + static function() {
230 246 wp_dequeue_style( 'wp-block-library-theme' );
231 247 }
232 248 );
233 249 $stylesheet_removed = true;
@@ -240,9 +256,9 @@
240 256
241 257 // If the file exists, enqueue it.
242 258 if ( file_exists( gutenberg_dir_path() . $theme_style_path ) ) {
243 259
244 - if ( file_exists( gutenberg_dir_path() . $style_path ) ) {
260 + if ( file_exists( $stylesheet_path ) ) {
245 261 // If there is a main stylesheet for this block, append the theme styles to main styles.
246 262 wp_add_inline_style(
247 263 "wp-block-{$block_name}",
248 264 file_get_contents( gutenberg_dir_path() . $theme_style_path )
@@ -259,8 +275,9 @@
259 275 }
260 276 }
261 277 }
262 278
279 + $editor_style_path = "build/block-library/blocks/$block_name/style-editor.css";
263 280 if ( file_exists( gutenberg_dir_path() . $editor_style_path ) ) {
264 281 wp_deregister_style( "wp-block-{$block_name}-editor" );
265 282 wp_register_style(
266 283 "wp-block-{$block_name}-editor",
@@ -273,48 +290,8 @@
273 290 wp_register_style( "wp-block-{$block_name}-editor", false );
274 291 }
275 292 }
276 293
277 -if ( ! function_exists( '_wp_normalize_relative_css_links' ) ) {
278 - /**
279 - * Make URLs relative to the WordPress installation.
280 - *
281 - * @since 5.8.2
282 - *
283 - * @param string $css The CSS to make URLs relative to the WordPress installation.
284 - * @param string $stylesheet_url The URL to the stylesheet.
285 - *
286 - * @return string The CSS with URLs made relative to the WordPress installation.
287 - */
288 - function _wp_normalize_relative_css_links( $css, $stylesheet_url ) {
289 - $has_src_results = preg_match_all( '#url\s*\(\s*[\'"]?\s*([^\'"\)]+)#', $css, $src_results );
290 - if ( $has_src_results ) {
291 - // Loop through the URLs to find relative ones.
292 - foreach ( $src_results[1] as $src_index => $src_result ) {
293 - // Skip if this is an absolute URL.
294 - if ( 0 === strpos( $src_result, 'http' ) || 0 === strpos( $src_result, '//' ) ) {
295 - continue;
296 - }
297 -
298 - // Build the absolute URL.
299 - $absolute_url = dirname( $stylesheet_url ) . '/' . $src_result;
300 - $absolute_url = str_replace( '/./', '/', $absolute_url );
301 - // Convert to URL related to the site root.
302 - $relative_url = wp_make_link_relative( $absolute_url );
303 -
304 - // Replace the URL in the CSS.
305 - $css = str_replace(
306 - $src_results[0][ $src_index ],
307 - str_replace( $src_result, $relative_url, $src_results[0][ $src_index ] ),
308 - $css
309 - );
310 - }
311 - }
312 -
313 - return $css;
314 - }
315 -}
316 -
317 294 /**
318 295 * Complements the implementation of block type `core/social-icon`, whether it
319 296 * be provided by core or the plugin, with derived block types for each
320 297 * "service" (WordPress, Twitter, etc.) supported by Social Links.
@@ -322,9 +299,9 @@
322 299 * This ensures backwards compatibility for any users running the Gutenberg
323 300 * plugin who have used Social Links prior to their conversion to block
324 301 * variations.
325 302 *
326 - * This shim is INTENTIONALLY left out of core, as Social Links haven't yet
303 + * This shim is INTENTIONALLY left out of core, as Social Links have never
327 304 * landed there.
328 305 *
329 306 * @see https://github.com/WordPress/gutenberg/pull/19887
330 307 */
@@ -396,198 +373,30 @@
396 373
397 374 add_action( 'init', 'gutenberg_register_legacy_social_link_blocks' );
398 375
399 376 /**
400 - * Checks whether the current block type supports the feature requested.
377 + * Migrate the legacy `sync_status` meta key (added 16.1) to the new `wp_pattern_sync_status` meta key (16.1.1).
401 378 *
402 - * @param WP_Block_Type $block_type Block type to check for support.
403 - * @param array $feature Path of the feature to check support for.
404 - * @param mixed $default Fallback value for feature support, defaults to false.
379 + * This filter is INTENTIONALLY left out of core as the meta key was fist introduced to core in 6.3 as `wp_pattern_sync_status`.
380 + * see https://github.com/WordPress/gutenberg/pull/52232
405 381 *
406 - * @return boolean Whether or not the feature is supported.
382 + * @param mixed $value The value to return, either a single metadata value or an array of values depending on the value of $single.
383 + * @param int $object_id ID of the object metadata is for.
384 + * @param string $meta_key Metadata key.
385 + * @param bool $single Whether to return only the first value of the specified $meta_key.
407 386 */
408 -function gutenberg_block_has_support( $block_type, $feature, $default = false ) {
409 - $block_support = $default;
410 - if ( $block_type && property_exists( $block_type, 'supports' ) ) {
411 - $block_support = _wp_array_get( $block_type->supports, $feature, $default );
387 +function gutenberg_legacy_wp_block_post_meta( $value, $object_id, $meta_key, $single ) {
388 + if ( 'wp_pattern_sync_status' !== $meta_key ) {
389 + return $value;
412 390 }
413 391
414 - return true === $block_support || is_array( $block_support );
415 -}
392 + $sync_status = get_post_meta( $object_id, 'sync_status', $single );
416 393
417 -/**
418 - * Updates the shape of supports for declaring fontSize and lineHeight.
419 - *
420 - * @param array $metadata Metadata for registering a block type.
421 - * @return array Metadata for registering a block type with the supports shape updated.
422 - */
423 -function gutenberg_migrate_old_typography_shape( $metadata ) {
424 - // Temporarily disable migrations from core blocks to avoid warnings on versions older than 5.8.
425 - if ( isset( $metadata['supports'] ) && false === strpos( $metadata['file'], '/wp-includes/blocks/' ) ) {
426 - $typography_keys = array(
427 - '__experimentalFontFamily',
428 - '__experimentalFontStyle',
429 - '__experimentalFontWeight',
430 - '__experimentalLetterSpacing',
431 - '__experimentalTextDecoration',
432 - '__experimentalTextTransform',
433 - 'fontSize',
434 - 'lineHeight',
435 - );
436 - foreach ( $typography_keys as $typography_key ) {
437 - $support_for_key = _wp_array_get( $metadata['supports'], array( $typography_key ), null );
438 - if ( null !== $support_for_key ) {
439 - trigger_error(
440 - /* translators: %1$s: Block type, %2$s: typography supports key e.g: fontSize, lineHeight etc... */
441 - sprintf( __( 'Block %1$s is declaring %2$s support on block.json under supports.%2$s. %2$s support is now declared under supports.typography.%2$s.', 'gutenberg' ), $metadata['name'], $typography_key ),
442 - headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE
443 - );
444 - _wp_array_set( $metadata['supports'], array( 'typography', $typography_key ), $support_for_key );
445 - unset( $metadata['supports'][ $typography_key ] );
446 - }
447 - }
394 + if ( $single && 'unsynced' === $sync_status ) {
395 + return $sync_status;
396 + } elseif ( isset( $sync_status[0] ) && 'unsynced' === $sync_status[0] ) {
397 + return $sync_status;
448 398 }
449 - return $metadata;
450 -}
451 399
452 -if ( ! function_exists( 'wp_migrate_old_typography_shape' ) ) {
453 - add_filter( 'block_type_metadata', 'gutenberg_migrate_old_typography_shape' );
400 + return $value;
454 401 }
455 -
456 -if ( ! function_exists( 'wp_enqueue_block_style' ) ) {
457 - /**
458 - * Enqueue a stylesheet for a specific block.
459 - *
460 - * If the theme has opted-in to separate-styles loading,
461 - * then the stylesheet will be enqueued on-render,
462 - * otherwise when the block inits.
463 - *
464 - * @param string $block_name The block-name, including namespace.
465 - * @param array $args An array of arguments [handle,src,deps,ver,media].
466 - *
467 - * @return void
468 - */
469 - function wp_enqueue_block_style( $block_name, $args ) {
470 - $args = wp_parse_args(
471 - $args,
472 - array(
473 - 'handle' => '',
474 - 'src' => '',
475 - 'deps' => array(),
476 - 'ver' => false,
477 - 'media' => 'all',
478 - )
479 - );
480 -
481 - /**
482 - * Callback function to register and enqueue styles.
483 - *
484 - * @param string $content When the callback is used for the render_block filter,
485 - * the content needs to be returned so the function parameter
486 - * is to ensure the content exists.
487 - * @return string Block content.
488 - */
489 - $callback = static function( $content ) use ( $args ) {
490 - // Register the stylesheet.
491 - if ( ! empty( $args['src'] ) ) {
492 - wp_register_style( $args['handle'], $args['src'], $args['deps'], $args['ver'], $args['media'] );
493 - }
494 -
495 - // Add `path` data if provided.
496 - if ( isset( $args['path'] ) ) {
497 - wp_style_add_data( $args['handle'], 'path', $args['path'] );
498 -
499 - // Get the RTL file path.
500 - $rtl_file_path = str_replace( '.css', '-rtl.css', $args['path'] );
501 -
502 - // Add RTL stylesheet.
503 - if ( file_exists( $rtl_file_path ) ) {
504 - wp_style_add_data( $args['handle'], 'rtl', 'replace' );
505 -
506 - if ( is_rtl() ) {
507 - wp_style_add_data( $args['handle'], 'path', $rtl_file_path );
508 - }
509 - }
510 - }
511 -
512 - // Enqueue the stylesheet.
513 - wp_enqueue_style( $args['handle'] );
514 -
515 - return $content;
516 - };
517 -
518 - $hook = did_action( 'wp_enqueue_scripts' ) ? 'wp_footer' : 'wp_enqueue_scripts';
519 - if ( wp_should_load_separate_core_block_assets() ) {
520 - /**
521 - * Callback function to register and enqueue styles.
522 - *
523 - * @param string $content The block content.
524 - * @param array $block The full block, including name and attributes.
525 - * @return string Block content.
526 - */
527 - $callback_separate = static function( $content, $block ) use ( $block_name, $callback ) {
528 - if ( ! empty( $block['blockName'] ) && $block_name === $block['blockName'] ) {
529 - return $callback( $content );
530 - }
531 - return $content;
532 - };
533 -
534 - /*
535 - * The filter's callback here is an anonymous function because
536 - * using a named function in this case is not possible.
537 - *
538 - * The function cannot be unhooked, however, users are still able
539 - * to dequeue the stylesheets registered/enqueued by the callback
540 - * which is why in this case, using an anonymous function
541 - * was deemed acceptable.
542 - */
543 - add_filter( 'render_block', $callback_separate, 10, 2 );
544 - return;
545 - }
546 -
547 - /*
548 - * The filter's callback here is an anonymous function because
549 - * using a named function in this case is not possible.
550 - *
551 - * The function cannot be unhooked, however, users are still able
552 - * to dequeue the stylesheets registered/enqueued by the callback
553 - * which is why in this case, using an anonymous function
554 - * was deemed acceptable.
555 - */
556 - add_filter( $hook, $callback );
557 -
558 - // Enqueue assets in the editor.
559 - add_action( 'enqueue_block_assets', $callback );
560 - }
561 -}
562 -
563 -/**
564 - * Allow multiple block styles.
565 - *
566 - * @param array $metadata Metadata for registering a block type.
567 - *
568 - * @return array
569 - */
570 -function gutenberg_multiple_block_styles( $metadata ) {
571 - foreach ( array( 'style', 'editorStyle' ) as $key ) {
572 - if ( ! empty( $metadata[ $key ] ) && is_array( $metadata[ $key ] ) ) {
573 - $default_style = array_shift( $metadata[ $key ] );
574 - foreach ( $metadata[ $key ] as $handle ) {
575 - $args = array( 'handle' => $handle );
576 - if ( 0 === strpos( $handle, 'file:' ) && isset( $metadata['file'] ) ) {
577 - $style_path = remove_block_asset_path_prefix( $handle );
578 - $args = array(
579 - 'handle' => sanitize_key( "{$metadata['name']}-{$style_path}" ),
580 - 'src' => plugins_url( $style_path, $metadata['file'] ),
581 - );
582 - }
583 -
584 - wp_enqueue_block_style( $metadata['name'], $args );
585 - }
586 -
587 - // Only return the 1st item in the array.
588 - $metadata[ $key ] = $default_style;
589 - }
590 - }
591 - return $metadata;
592 -}
593 -add_filter( 'block_type_metadata', 'gutenberg_multiple_block_styles' );
402 +add_filter( 'default_post_metadata', 'gutenberg_legacy_wp_block_post_meta', 10, 4 );