| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Block Editor API. 4 * 5 * @package WordPress 6 * @subpackage Editor 7 * @since 5.8.0 8 */ 9 10 /** 11 * Returns the list of default categories for block types. 12 * 13 * @since 5.8.0 14 * @since 6.3.0 Reusable Blocks renamed to Patterns. 15 * 16 * @return array[] Array of categories for block types. 17 */ 18 function get_default_block_categories() { 19 return array( 20 array( 21 'slug' => 'text', 22 'title' => _x( 'Text', 'block category' ), 23 'icon' => null, 24 ), 25 array( 26 'slug' => 'media', 27 'title' => _x( 'Media', 'block category' ), 28 'icon' => null, 29 ), 30 array( 31 'slug' => 'design', 32 'title' => _x( 'Design', 'block category' ), 33 'icon' => null, 34 ), 35 array( 36 'slug' => 'widgets', 37 'title' => _x( 'Widgets', 'block category' ), 38 'icon' => null, 39 ), 40 array( 41 'slug' => 'theme', 42 'title' => _x( 'Theme', 'block category' ), 43 'icon' => null, 44 ), 45 array( 46 'slug' => 'embed', 47 'title' => _x( 'Embeds', 'block category' ), 48 'icon' => null, 49 ), 50 array( 51 'slug' => 'reusable', 52 'title' => _x( 'Patterns', 'block category' ), 53 'icon' => null, 54 ), 55 ); 56 } 57 58 /** 59 * Returns all the categories for block types that will be shown in the block editor. 60 * 61 * @since 5.0.0 62 * @since 5.8.0 It is possible to pass the block editor context as param. 63 * 64 * @param WP_Post|WP_Block_Editor_Context $post_or_block_editor_context The current post object or 65 * the block editor context. 66 * 67 * @return array[] Array of categories for block types. 68 */ 69 function get_block_categories( $post_or_block_editor_context ) { 70 $block_categories = get_default_block_categories(); 71 $block_editor_context = $post_or_block_editor_context instanceof WP_Post ? 72 new WP_Block_Editor_Context( 73 array( 74 'post' => $post_or_block_editor_context, 75 ) 76 ) : $post_or_block_editor_context; 77 78 /** 79 * Filters the default array of categories for block types. 80 * 81 * @since 5.8.0 82 * 83 * @param array[] $block_categories Array of categories for block types. 84 * @param WP_Block_Editor_Context $block_editor_context The current block editor context. 85 */ 86 $block_categories = apply_filters( 'block_categories_all', $block_categories, $block_editor_context ); 87 88 if ( ! empty( $block_editor_context->post ) ) { 89 $post = $block_editor_context->post; 90 91 /** 92 * Filters the default array of categories for block types. 93 * 94 * @since 5.0.0 95 * @deprecated 5.8.0 Use the {@see 'block_categories_all'} filter instead. 96 * 97 * @param array[] $block_categories Array of categories for block types. 98 * @param WP_Post $post Post being loaded. 99 */ 100 $block_categories = apply_filters_deprecated( 'block_categories', array( $block_categories, $post ), '5.8.0', 'block_categories_all' ); 101 } 102 103 return $block_categories; 104 } 105 106 /** 107 * Gets the list of allowed block types to use in the block editor. 108 * 109 * @since 5.8.0 110 * 111 * @param WP_Block_Editor_Context $block_editor_context The current block editor context. 112 * 113 * @return bool|string[] Array of block type slugs, or boolean to enable/disable all. 114 */ 115 function get_allowed_block_types( $block_editor_context ) { 116 $allowed_block_types = true; 117 118 /** 119 * Filters the allowed block types for all editor types. 120 * 121 * @since 5.8.0 122 * 123 * @param bool|string[] $allowed_block_types Array of block type slugs, or boolean to enable/disable all. 124 * Default true (all registered block types supported). 125 * @param WP_Block_Editor_Context $block_editor_context The current block editor context. 126 */ 127 $allowed_block_types = apply_filters( 'allowed_block_types_all', $allowed_block_types, $block_editor_context ); 128 129 if ( ! empty( $block_editor_context->post ) ) { 130 $post = $block_editor_context->post; 131 132 /** 133 * Filters the allowed block types for the editor. 134 * 135 * @since 5.0.0 136 * @deprecated 5.8.0 Use the {@see 'allowed_block_types_all'} filter instead. 137 * 138 * @param bool|string[] $allowed_block_types Array of block type slugs, or boolean to enable/disable all. 139 * Default true (all registered block types supported) 140 * @param WP_Post $post The post resource data. 141 */ 142 $allowed_block_types = apply_filters_deprecated( 'allowed_block_types', array( $allowed_block_types, $post ), '5.8.0', 'allowed_block_types_all' ); 143 } 144 145 return $allowed_block_types; 146 } 147 148 /** 149 * Returns the default block editor settings. 150 * 151 * @since 5.8.0 152 * 153 * @return array The default block editor settings. 154 */ 155 function get_default_block_editor_settings() { 156 // Media settings. 157 158 // wp_max_upload_size() can be expensive, so only call it when relevant for the current user. 159 $max_upload_size = 0; 160 if ( current_user_can( 'upload_files' ) ) { 161 $max_upload_size = wp_max_upload_size(); 162 if ( ! $max_upload_size ) { 163 $max_upload_size = 0; 164 } 165 } 166 167 /** This filter is documented in wp-admin/includes/media.php */ 168 $image_size_names = apply_filters( 169 'image_size_names_choose', 170 array( 171 'thumbnail' => __( 'Thumbnail' ), 172 'medium' => __( 'Medium' ), 173 'large' => __( 'Large' ), 174 'full' => __( 'Full Size' ), 175 ) 176 ); 177 178 $available_image_sizes = array(); 179 foreach ( $image_size_names as $image_size_slug => $image_size_name ) { 180 $available_image_sizes[] = array( 181 'slug' => $image_size_slug, 182 'name' => $image_size_name, 183 ); 184 } 185 186 $default_size = get_option( 'image_default_size', 'large' ); 187 $image_default_size = in_array( $default_size, array_keys( $image_size_names ), true ) ? $default_size : 'large'; 188 189 $image_dimensions = array(); 190 $all_sizes = wp_get_registered_image_subsizes(); 191 foreach ( $available_image_sizes as $size ) { 192 $key = $size['slug']; 193 if ( isset( $all_sizes[ $key ] ) ) { 194 $image_dimensions[ $key ] = $all_sizes[ $key ]; 195 } 196 } 197 198 // These styles are used if the "no theme styles" options is triggered or on 199 // themes without their own editor styles. 200 $default_editor_styles_file = ABSPATH . WPINC . '/css/dist/block-editor/default-editor-styles.css'; 201 202 static $default_editor_styles_file_contents = false; 203 if ( ! $default_editor_styles_file_contents && file_exists( $default_editor_styles_file ) ) { 204 $default_editor_styles_file_contents = file_get_contents( $default_editor_styles_file ); 205 } 206 207 $default_editor_styles = array(); 208 if ( $default_editor_styles_file_contents ) { 209 $default_editor_styles = array( 210 array( 'css' => $default_editor_styles_file_contents ), 211 ); 212 } 213 214 $editor_settings = array( 215 'alignWide' => get_theme_support( 'align-wide' ), 216 'allowedBlockTypes' => true, 217 'allowedMimeTypes' => get_allowed_mime_types(), 218 'defaultEditorStyles' => $default_editor_styles, 219 'blockCategories' => get_default_block_categories(), 220 'isRTL' => is_rtl(), 221 'imageDefaultSize' => $image_default_size, 222 'imageDimensions' => $image_dimensions, 223 'imageEditing' => true, 224 'imageSizes' => $available_image_sizes, 225 'maxUploadFileSize' => $max_upload_size, 226 '__experimentalDashboardLink' => admin_url( '/' ), 227 // The following flag is required to enable the new Gallery block format on the mobile apps in 5.9. 228 '__unstableGalleryWithImageBlocks' => true, 229 ); 230 231 $theme_settings = get_classic_theme_supports_block_editor_settings(); 232 foreach ( $theme_settings as $key => $value ) { 233 $editor_settings[ $key ] = $value; 234 } 235 236 return $editor_settings; 237 } 238 239 /** 240 * Returns the block editor settings needed to use the Legacy Widget block which 241 * is not registered by default. 242 * 243 * @since 5.8.0 244 * 245 * @return array Settings to be used with get_block_editor_settings(). 246 */ 247 function get_legacy_widget_block_editor_settings() { 248 $editor_settings = array(); 249 250 /** 251 * Filters the list of widget-type IDs that should **not** be offered by the 252 * Legacy Widget block. 253 * 254 * Returning an empty array will make all widgets available. 255 * 256 * @since 5.8.0 257 * 258 * @param string[] $widgets An array of excluded widget-type IDs. 259 */ 260 $editor_settings['widgetTypesToHideFromLegacyWidgetBlock'] = apply_filters( 261 'widget_types_to_hide_from_legacy_widget_block', 262 array( 263 'pages', 264 'calendar', 265 'archives', 266 'media_audio', 267 'media_image', 268 'media_gallery', 269 'media_video', 270 'search', 271 'text', 272 'categories', 273 'recent-posts', 274 'recent-comments', 275 'rss', 276 'tag_cloud', 277 'custom_html', 278 'block', 279 ) 280 ); 281 282 return $editor_settings; 283 } 284 285 /** 286 * Collect the block editor assets that need to be loaded into the editor's iframe. 287 * 288 * @since 6.0.0 289 * @access private 290 * 291 * @global WP_Styles $wp_styles The WP_Styles current instance. 292 * @global WP_Scripts $wp_scripts The WP_Scripts current instance. 293 * 294 * @return array { 295 * The block editor assets. 296 * 297 * @type string|false $styles String containing the HTML for styles. 298 * @type string|false $scripts String containing the HTML for scripts. 299 * } 300 */ 301 function _wp_get_iframed_editor_assets() { 302 global $wp_styles, $wp_scripts; 303 304 // Keep track of the styles and scripts instance to restore later. 305 $current_wp_styles = $wp_styles; 306 $current_wp_scripts = $wp_scripts; 307 308 // Create new instances to collect the assets. 309 $wp_styles = new WP_Styles(); 310 $wp_scripts = new WP_Scripts(); 311 312 /* 313 * Register all currently registered styles and scripts. The actions that 314 * follow enqueue assets, but don't necessarily register them. 315 */ 316 $wp_styles->registered = $current_wp_styles->registered; 317 $wp_scripts->registered = $current_wp_scripts->registered; 318 319 /* 320 * We generally do not need reset styles for the iframed editor. 321 * However, if it's a classic theme, margins will be added to every block, 322 * which is reset specifically for list items, so classic themes rely on 323 * these reset styles. 324 */ 325 $wp_styles->done = 326 wp_theme_has_theme_json() ? array( 'wp-reset-editor-styles' ) : array(); 327 328 wp_enqueue_script( 'wp-polyfill' ); 329 // Enqueue the `editorStyle` handles for all core block, and dependencies. 330 wp_enqueue_style( 'wp-edit-blocks' ); 331 332 if ( current_theme_supports( 'wp-block-styles' ) ) { 333 wp_enqueue_style( 'wp-block-library-theme' ); 334 } 335 336 /* 337 * We don't want to load EDITOR scripts in the iframe, only enqueue 338 * front-end assets for the content. 339 */ 340 add_filter( 'should_load_block_editor_scripts_and_styles', '__return_false' ); 341 /** This action is documented in wp-includes/script-loader.php */ 342 do_action( 'enqueue_block_assets' ); 343 remove_filter( 'should_load_block_editor_scripts_and_styles', '__return_false' ); 344 345 $block_registry = WP_Block_Type_Registry::get_instance(); 346 347 /* 348 * Additionally, do enqueue `editorStyle` assets for all blocks, which 349 * contains editor-only styling for blocks (editor content). 350 */ 351 foreach ( $block_registry->get_all_registered() as $block_type ) { 352 if ( isset( $block_type->editor_style_handles ) && is_array( $block_type->editor_style_handles ) ) { 353 foreach ( $block_type->editor_style_handles as $style_handle ) { 354 wp_enqueue_style( $style_handle ); 355 } 356 } 357 } 358 359 /** 360 * Remove the deprecated `print_emoji_styles` handler. 361 * It avoids breaking style generation with a deprecation message. 362 */ 363 $has_emoji_styles = has_action( 'wp_print_styles', 'print_emoji_styles' ); 364 if ( $has_emoji_styles ) { 365 remove_action( 'wp_print_styles', 'print_emoji_styles' ); 366 } 367 368 ob_start(); 369 wp_print_styles(); 370 wp_print_font_faces(); 371 wp_print_font_faces_from_style_variations(); 372 $styles = ob_get_clean(); 373 374 if ( $has_emoji_styles ) { 375 add_action( 'wp_print_styles', 'print_emoji_styles' ); 376 } 377 378 ob_start(); 379 wp_print_head_scripts(); 380 wp_print_footer_scripts(); 381 $scripts = ob_get_clean(); 382 383 // Restore the original instances. 384 $wp_styles = $current_wp_styles; 385 $wp_scripts = $current_wp_scripts; 386 387 return array( 388 'styles' => $styles, 389 'scripts' => $scripts, 390 ); 391 } 392 393 /** 394 * Finds the first occurrence of a specific block in an array of blocks. 395 * 396 * @since 6.3.0 397 * 398 * @param array $blocks Array of blocks. 399 * @param string $block_name Name of the block to find. 400 * @return array Found block, or empty array if none found. 401 */ 402 function wp_get_first_block( $blocks, $block_name ) { 403 foreach ( $blocks as $block ) { 404 if ( $block_name === $block['blockName'] ) { 405 return $block; 406 } 407 if ( ! empty( $block['innerBlocks'] ) ) { 408 $found_block = wp_get_first_block( $block['innerBlocks'], $block_name ); 409 410 if ( ! empty( $found_block ) ) { 411 return $found_block; 412 } 413 } 414 } 415 416 return array(); 417 } 418 419 /** 420 * Retrieves Post Content block attributes from the current post template. 421 * 422 * @since 6.3.0 423 * @since 6.4.0 Return null if there is no post content block. 424 * @access private 425 * 426 * @global int $post_ID 427 * 428 * @return array|null Post Content block attributes array or null if Post Content block doesn't exist. 429 */ 430 function wp_get_post_content_block_attributes() { 431 global $post_ID; 432 433 $is_block_theme = wp_is_block_theme(); 434 435 if ( ! $is_block_theme || ! $post_ID ) { 436 return null; 437 } 438 439 $template_slug = get_page_template_slug( $post_ID ); 440 441 if ( ! $template_slug ) { 442 $post_slug = 'singular'; 443 $page_slug = 'singular'; 444 $template_types = get_block_templates(); 445 446 foreach ( $template_types as $template_type ) { 447 if ( 'page' === $template_type->slug ) { 448 $page_slug = 'page'; 449 } 450 if ( 'single' === $template_type->slug ) { 451 $post_slug = 'single'; 452 } 453 } 454 455 $what_post_type = get_post_type( $post_ID ); 456 switch ( $what_post_type ) { 457 case 'page': 458 $template_slug = $page_slug; 459 break; 460 default: 461 $template_slug = $post_slug; 462 break; 463 } 464 } 465 466 $current_template = get_block_templates( array( 'slug__in' => array( $template_slug ) ) ); 467 468 if ( ! empty( $current_template ) ) { 469 $template_blocks = parse_blocks( $current_template[0]->content ); 470 $post_content_block = wp_get_first_block( $template_blocks, 'core/post-content' ); 471 472 if ( isset( $post_content_block['attrs'] ) ) { 473 return $post_content_block['attrs']; 474 } 475 } 476 477 return null; 478 } 479 480 /** 481 * Returns the contextualized block editor settings for a selected editor context. 482 * 483 * @since 5.8.0 484 * 485 * @param array $custom_settings Custom settings to use with the given editor type. 486 * @param WP_Block_Editor_Context $block_editor_context The current block editor context. 487 * 488 * @return array The contextualized block editor settings. 489 */ 490 function get_block_editor_settings( array $custom_settings, $block_editor_context ) { 491 $editor_settings = array_merge( 492 get_default_block_editor_settings(), 493 array( 494 'allowedBlockTypes' => get_allowed_block_types( $block_editor_context ), 495 'blockCategories' => get_block_categories( $block_editor_context ), 496 ), 497 $custom_settings 498 ); 499 500 $editor_settings['__experimentalBlockBindingsSupportedAttributes'] = array(); 501 foreach ( array_keys( WP_Block_Type_Registry::get_instance()->get_all_registered() ) as $block_type ) { 502 $supported_block_attributes = get_block_bindings_supported_attributes( $block_type ); 503 if ( ! empty( $supported_block_attributes ) ) { 504 $editor_settings['__experimentalBlockBindingsSupportedAttributes'][ $block_type ] = $supported_block_attributes; 505 } 506 } 507 508 $global_styles = array(); 509 $presets = array( 510 array( 511 'css' => 'variables', 512 '__unstableType' => 'presets', 513 'isGlobalStyles' => true, 514 ), 515 array( 516 'css' => 'presets', 517 '__unstableType' => 'presets', 518 'isGlobalStyles' => true, 519 ), 520 ); 521 foreach ( $presets as $preset_style ) { 522 $actual_css = wp_get_global_stylesheet( array( $preset_style['css'] ) ); 523 if ( '' !== $actual_css ) { 524 $preset_style['css'] = $actual_css; 525 $global_styles[] = $preset_style; 526 } 527 } 528 529 $block_classes = array( 530 'css' => 'styles', 531 '__unstableType' => 'theme', 532 'isGlobalStyles' => true, 533 ); 534 $actual_css = wp_get_global_stylesheet( array( $block_classes['css'] ) ); 535 if ( '' !== $actual_css ) { 536 $block_classes['css'] = $actual_css; 537 $global_styles[] = $block_classes; 538 } 539 540 // Get any additional css from the customizer and add it before global styles custom CSS. 541 $global_styles[] = array( 542 'css' => wp_get_custom_css(), 543 '__unstableType' => 'user', 544 'isGlobalStyles' => false, 545 ); 546 547 /* 548 * Add the custom CSS as a separate stylesheet so any invalid CSS 549 * entered by users does not break other global styles. 550 */ 551 $global_styles[] = array( 552 'css' => wp_get_global_stylesheet( array( 'custom-css' ) ), 553 '__unstableType' => 'user', 554 'isGlobalStyles' => true, 555 ); 556 557 $editor_settings['styles'] = array_merge( $global_styles, get_block_editor_theme_styles() ); 558 559 $editor_settings['__experimentalFeatures'] = wp_get_global_settings(); 560 // These settings may need to be updated based on data coming from theme.json sources. 561 if ( isset( $editor_settings['__experimentalFeatures']['color']['palette'] ) ) { 562 $colors_by_origin = $editor_settings['__experimentalFeatures']['color']['palette']; 563 $editor_settings['colors'] = $colors_by_origin['custom'] ?? $colors_by_origin['theme'] ?? $colors_by_origin['default']; 564 } 565 if ( isset( $editor_settings['__experimentalFeatures']['color']['gradients'] ) ) { 566 $gradients_by_origin = $editor_settings['__experimentalFeatures']['color']['gradients']; 567 $editor_settings['gradients'] = $gradients_by_origin['custom'] ?? $gradients_by_origin['theme'] ?? $gradients_by_origin['default']; 568 } 569 if ( isset( $editor_settings['__experimentalFeatures']['typography']['fontSizes'] ) ) { 570 $font_sizes_by_origin = $editor_settings['__experimentalFeatures']['typography']['fontSizes']; 571 $editor_settings['fontSizes'] = $font_sizes_by_origin['custom'] ?? $font_sizes_by_origin['theme'] ?? $font_sizes_by_origin['default']; 572 } 573 if ( isset( $editor_settings['__experimentalFeatures']['color']['custom'] ) ) { 574 $editor_settings['disableCustomColors'] = ! $editor_settings['__experimentalFeatures']['color']['custom']; 575 unset( $editor_settings['__experimentalFeatures']['color']['custom'] ); 576 } 577 if ( isset( $editor_settings['__experimentalFeatures']['color']['customGradient'] ) ) { 578 $editor_settings['disableCustomGradients'] = ! $editor_settings['__experimentalFeatures']['color']['customGradient']; 579 unset( $editor_settings['__experimentalFeatures']['color']['customGradient'] ); 580 } 581 if ( isset( $editor_settings['__experimentalFeatures']['typography']['customFontSize'] ) ) { 582 $editor_settings['disableCustomFontSizes'] = ! $editor_settings['__experimentalFeatures']['typography']['customFontSize']; 583 unset( $editor_settings['__experimentalFeatures']['typography']['customFontSize'] ); 584 } 585 if ( isset( $editor_settings['__experimentalFeatures']['typography']['lineHeight'] ) ) { 586 $editor_settings['enableCustomLineHeight'] = $editor_settings['__experimentalFeatures']['typography']['lineHeight']; 587 unset( $editor_settings['__experimentalFeatures']['typography']['lineHeight'] ); 588 } 589 if ( isset( $editor_settings['__experimentalFeatures']['spacing']['units'] ) ) { 590 $editor_settings['enableCustomUnits'] = $editor_settings['__experimentalFeatures']['spacing']['units']; 591 unset( $editor_settings['__experimentalFeatures']['spacing']['units'] ); 592 } 593 if ( isset( $editor_settings['__experimentalFeatures']['spacing']['padding'] ) ) { 594 $editor_settings['enableCustomSpacing'] = $editor_settings['__experimentalFeatures']['spacing']['padding']; 595 unset( $editor_settings['__experimentalFeatures']['spacing']['padding'] ); 596 } 597 if ( isset( $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize'] ) ) { 598 $editor_settings['disableCustomSpacingSizes'] = ! $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize']; 599 unset( $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize'] ); 600 } 601 602 if ( isset( $editor_settings['__experimentalFeatures']['spacing']['spacingSizes'] ) ) { 603 $spacing_sizes_by_origin = $editor_settings['__experimentalFeatures']['spacing']['spacingSizes']; 604 $editor_settings['spacingSizes'] = $spacing_sizes_by_origin['custom'] ?? $spacing_sizes_by_origin['theme'] ?? $spacing_sizes_by_origin['default']; 605 } 606 607 $editor_settings['__unstableResolvedAssets'] = _wp_get_iframed_editor_assets(); 608 $editor_settings['__unstableIsBlockBasedTheme'] = wp_is_block_theme(); 609 $editor_settings['localAutosaveInterval'] = 15; 610 $editor_settings['disableLayoutStyles'] = current_theme_supports( 'disable-layout-styles' ); 611 $editor_settings['__experimentalDiscussionSettings'] = array( 612 'commentOrder' => get_option( 'comment_order' ), 613 'commentsPerPage' => get_option( 'comments_per_page' ), 614 'defaultCommentsPage' => get_option( 'default_comments_page' ), 615 'pageComments' => get_option( 'page_comments' ), 616 'threadComments' => get_option( 'thread_comments' ), 617 'threadCommentsDepth' => get_option( 'thread_comments_depth' ), 618 'defaultCommentStatus' => get_option( 'default_comment_status' ), 619 'avatarURL' => get_avatar_url( 620 '', 621 array( 622 'size' => 96, 623 'force_default' => true, 624 'default' => get_option( 'avatar_default' ), 625 ) 626 ), 627 ); 628 629 $post_content_block_attributes = wp_get_post_content_block_attributes(); 630 631 if ( isset( $post_content_block_attributes ) ) { 632 $editor_settings['postContentAttributes'] = $post_content_block_attributes; 633 } 634 635 $editor_settings['canUpdateBlockBindings'] = current_user_can( 'edit_block_binding', $block_editor_context ); 636 637 /** 638 * Filters the settings to pass to the block editor for all editor type. 639 * 640 * @since 5.8.0 641 * 642 * @param array $editor_settings Default editor settings. 643 * @param WP_Block_Editor_Context $block_editor_context The current block editor context. 644 */ 645 $editor_settings = apply_filters( 'block_editor_settings_all', $editor_settings, $block_editor_context ); 646 647 if ( ! empty( $block_editor_context->post ) ) { 648 $post = $block_editor_context->post; 649 650 /** 651 * Filters the settings to pass to the block editor. 652 * 653 * @since 5.0.0 654 * @deprecated 5.8.0 Use the {@see 'block_editor_settings_all'} filter instead. 655 * 656 * @param array $editor_settings Default editor settings. 657 * @param WP_Post $post Post being edited. 658 */ 659 $editor_settings = apply_filters_deprecated( 'block_editor_settings', array( $editor_settings, $post ), '5.8.0', 'block_editor_settings_all' ); 660 } 661 662 $editor_settings['canEditCSS'] = current_user_can( 'edit_css' ); 663 664 return $editor_settings; 665 } 666 667 /** 668 * Preloads common data used with the block editor by specifying an array of 669 * REST API paths that will be preloaded for a given block editor context. 670 * 671 * @since 5.8.0 672 * 673 * @global WP_Post $post Global post object. 674 * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts. 675 * @global WP_Styles $wp_styles The WP_Styles object for printing styles. 676 * 677 * @param (string|string[])[] $preload_paths List of paths to preload. 678 * @param WP_Block_Editor_Context $block_editor_context The current block editor context. 679 */ 680 function block_editor_rest_api_preload( array $preload_paths, $block_editor_context ) { 681 global $post, $wp_scripts, $wp_styles; 682 683 /** 684 * Filters the array of REST API paths that will be used to preloaded common data for the block editor. 685 * 686 * @since 5.8.0 687 * 688 * @param (string|string[])[] $preload_paths Array of paths to preload. 689 * @param WP_Block_Editor_Context $block_editor_context The current block editor context. 690 */ 691 $preload_paths = apply_filters( 'block_editor_rest_api_preload_paths', $preload_paths, $block_editor_context ); 692 693 if ( ! empty( $block_editor_context->post ) ) { 694 $selected_post = $block_editor_context->post; 695 696 /** 697 * Filters the array of paths that will be preloaded. 698 * 699 * Preload common data by specifying an array of REST API paths that will be preloaded. 700 * 701 * @since 5.0.0 702 * @deprecated 5.8.0 Use the {@see 'block_editor_rest_api_preload_paths'} filter instead. 703 * 704 * @param (string|string[])[] $preload_paths Array of paths to preload. 705 * @param WP_Post $selected_post Post being edited. 706 */ 707 $preload_paths = apply_filters_deprecated( 'block_editor_preload_paths', array( $preload_paths, $selected_post ), '5.8.0', 'block_editor_rest_api_preload_paths' ); 708 } 709 710 if ( empty( $preload_paths ) ) { 711 return; 712 } 713 714 /* 715 * Ensure the global $post, $wp_scripts, and $wp_styles remain the same after 716 * API data is preloaded. 717 * Because API preloading can call the_content and other filters, plugins 718 * can unexpectedly modify the global $post or enqueue assets which are not 719 * intended for the block editor. 720 */ 721 $backup_global_post = ! empty( $post ) ? clone $post : $post; 722 $backup_wp_scripts = ! empty( $wp_scripts ) ? clone $wp_scripts : $wp_scripts; 723 $backup_wp_styles = ! empty( $wp_styles ) ? clone $wp_styles : $wp_styles; 724 725 foreach ( $preload_paths as &$path ) { 726 if ( is_string( $path ) && ! str_starts_with( $path, '/' ) ) { 727 $path = '/' . $path; 728 continue; 729 } 730 731 if ( is_array( $path ) && is_string( $path[0] ) && ! str_starts_with( $path[0], '/' ) ) { 732 $path[0] = '/' . $path[0]; 733 } 734 } 735 736 unset( $path ); 737 738 $preload_data = array_reduce( 739 $preload_paths, 740 'rest_preload_api_request', 741 array() 742 ); 743 744 // Restore the global $post, $wp_scripts, and $wp_styles as they were before API preloading. 745 $post = $backup_global_post; 746 $wp_scripts = $backup_wp_scripts; 747 $wp_styles = $backup_wp_styles; 748 749 wp_add_inline_script( 750 'wp-api-fetch', 751 sprintf( 752 'wp.apiFetch.use( wp.apiFetch.createPreloadingMiddleware( %s ) );', 753 wp_json_encode( $preload_data, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) 754 ), 755 'after' 756 ); 757 } 758 759 /** 760 * Creates an array of theme styles to load into the block editor. 761 * 762 * @since 5.8.0 763 * 764 * @global array $editor_styles 765 * 766 * @return array An array of theme styles for the block editor. 767 */ 768 function get_block_editor_theme_styles() { 769 global $editor_styles; 770 771 $styles = array(); 772 773 if ( $editor_styles && current_theme_supports( 'editor-styles' ) ) { 774 foreach ( $editor_styles as $style ) { 775 if ( preg_match( '~^(https?:)?//~', $style ) ) { 776 $response = wp_remote_get( $style ); 777 if ( ! is_wp_error( $response ) ) { 778 $styles[] = array( 779 'css' => wp_remote_retrieve_body( $response ), 780 '__unstableType' => 'theme', 781 'isGlobalStyles' => false, 782 ); 783 } 784 } else { 785 $file = get_theme_file_path( $style ); 786 if ( is_file( $file ) ) { 787 $styles[] = array( 788 'css' => file_get_contents( $file ), 789 'baseURL' => get_theme_file_uri( $style ), 790 '__unstableType' => 'theme', 791 'isGlobalStyles' => false, 792 ); 793 } 794 } 795 } 796 } 797 798 return $styles; 799 } 800 801 /** 802 * Returns the classic theme supports settings for block editor. 803 * 804 * @since 6.2.0 805 * @since 6.6.0 Add support for 'editor-spacing-sizes' theme support. 806 * 807 * @return array The classic theme supports settings. 808 */ 809 function get_classic_theme_supports_block_editor_settings() { 810 $theme_settings = array( 811 'disableCustomColors' => get_theme_support( 'disable-custom-colors' ), 812 'disableCustomFontSizes' => get_theme_support( 'disable-custom-font-sizes' ), 813 'disableCustomGradients' => get_theme_support( 'disable-custom-gradients' ), 814 'disableLayoutStyles' => get_theme_support( 'disable-layout-styles' ), 815 'enableCustomLineHeight' => get_theme_support( 'custom-line-height' ), 816 'enableCustomSpacing' => get_theme_support( 'custom-spacing' ), 817 'enableCustomUnits' => get_theme_support( 'custom-units' ), 818 ); 819 820 // Theme settings. 821 $color_palette = current( (array) get_theme_support( 'editor-color-palette' ) ); 822 if ( false !== $color_palette ) { 823 $theme_settings['colors'] = $color_palette; 824 } 825 826 $font_sizes = current( (array) get_theme_support( 'editor-font-sizes' ) ); 827 if ( false !== $font_sizes ) { 828 $theme_settings['fontSizes'] = $font_sizes; 829 } 830 831 $gradient_presets = current( (array) get_theme_support( 'editor-gradient-presets' ) ); 832 if ( false !== $gradient_presets ) { 833 $theme_settings['gradients'] = $gradient_presets; 834 } 835 836 $spacing_sizes = current( (array) get_theme_support( 'editor-spacing-sizes' ) ); 837 if ( false !== $spacing_sizes ) { 838 $theme_settings['spacingSizes'] = $spacing_sizes; 839 } 840 841 return $theme_settings; 842 } 843 844 /** 845 * Initialize site preview. 846 * 847 * This function sets IFRAME_REQUEST to true if the site preview parameter is set. 848 * 849 * @since 6.8.0 850 */ 851 function wp_initialize_site_preview_hooks() { 852 if ( 853 ! defined( 'IFRAME_REQUEST' ) && 854 isset( $_GET['wp_site_preview'] ) && 855 1 === (int) $_GET['wp_site_preview'] && 856 current_user_can( 'edit_theme_options' ) 857 ) { 858 define( 'IFRAME_REQUEST', true ); 859 } 860 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Tue Jun 16 08:20:09 2026 | Cross-referenced by PHPXref |