[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> block-editor.php (source)

   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      do_action( 'enqueue_block_assets' );
 342      remove_filter( 'should_load_block_editor_scripts_and_styles', '__return_false' );
 343  
 344      $block_registry = WP_Block_Type_Registry::get_instance();
 345  
 346      /*
 347       * Additionally, do enqueue `editorStyle` assets for all blocks, which
 348       * contains editor-only styling for blocks (editor content).
 349       */
 350      foreach ( $block_registry->get_all_registered() as $block_type ) {
 351          if ( isset( $block_type->editor_style_handles ) && is_array( $block_type->editor_style_handles ) ) {
 352              foreach ( $block_type->editor_style_handles as $style_handle ) {
 353                  wp_enqueue_style( $style_handle );
 354              }
 355          }
 356      }
 357  
 358      /**
 359       * Remove the deprecated `print_emoji_styles` handler.
 360       * It avoids breaking style generation with a deprecation message.
 361       */
 362      $has_emoji_styles = has_action( 'wp_print_styles', 'print_emoji_styles' );
 363      if ( $has_emoji_styles ) {
 364          remove_action( 'wp_print_styles', 'print_emoji_styles' );
 365      }
 366  
 367      ob_start();
 368      wp_print_styles();
 369      wp_print_font_faces();
 370      wp_print_font_faces_from_style_variations();
 371      $styles = ob_get_clean();
 372  
 373      if ( $has_emoji_styles ) {
 374          add_action( 'wp_print_styles', 'print_emoji_styles' );
 375      }
 376  
 377      ob_start();
 378      wp_print_head_scripts();
 379      wp_print_footer_scripts();
 380      $scripts = ob_get_clean();
 381  
 382      // Restore the original instances.
 383      $wp_styles  = $current_wp_styles;
 384      $wp_scripts = $current_wp_scripts;
 385  
 386      return array(
 387          'styles'  => $styles,
 388          'scripts' => $scripts,
 389      );
 390  }
 391  
 392  /**
 393   * Finds the first occurrence of a specific block in an array of blocks.
 394   *
 395   * @since 6.3.0
 396   *
 397   * @param array  $blocks     Array of blocks.
 398   * @param string $block_name Name of the block to find.
 399   * @return array Found block, or empty array if none found.
 400   */
 401  function wp_get_first_block( $blocks, $block_name ) {
 402      foreach ( $blocks as $block ) {
 403          if ( $block_name === $block['blockName'] ) {
 404              return $block;
 405          }
 406          if ( ! empty( $block['innerBlocks'] ) ) {
 407              $found_block = wp_get_first_block( $block['innerBlocks'], $block_name );
 408  
 409              if ( ! empty( $found_block ) ) {
 410                  return $found_block;
 411              }
 412          }
 413      }
 414  
 415      return array();
 416  }
 417  
 418  /**
 419   * Retrieves Post Content block attributes from the current post template.
 420   *
 421   * @since 6.3.0
 422   * @since 6.4.0 Return null if there is no post content block.
 423   * @access private
 424   *
 425   * @global int $post_ID
 426   *
 427   * @return array|null Post Content block attributes array or null if Post Content block doesn't exist.
 428   */
 429  function wp_get_post_content_block_attributes() {
 430      global $post_ID;
 431  
 432      $is_block_theme = wp_is_block_theme();
 433  
 434      if ( ! $is_block_theme || ! $post_ID ) {
 435          return null;
 436      }
 437  
 438      $template_slug = get_page_template_slug( $post_ID );
 439  
 440      if ( ! $template_slug ) {
 441          $post_slug      = 'singular';
 442          $page_slug      = 'singular';
 443          $template_types = get_block_templates();
 444  
 445          foreach ( $template_types as $template_type ) {
 446              if ( 'page' === $template_type->slug ) {
 447                  $page_slug = 'page';
 448              }
 449              if ( 'single' === $template_type->slug ) {
 450                  $post_slug = 'single';
 451              }
 452          }
 453  
 454          $what_post_type = get_post_type( $post_ID );
 455          switch ( $what_post_type ) {
 456              case 'page':
 457                  $template_slug = $page_slug;
 458                  break;
 459              default:
 460                  $template_slug = $post_slug;
 461                  break;
 462          }
 463      }
 464  
 465      $current_template = get_block_templates( array( 'slug__in' => array( $template_slug ) ) );
 466  
 467      if ( ! empty( $current_template ) ) {
 468          $template_blocks    = parse_blocks( $current_template[0]->content );
 469          $post_content_block = wp_get_first_block( $template_blocks, 'core/post-content' );
 470  
 471          if ( isset( $post_content_block['attrs'] ) ) {
 472              return $post_content_block['attrs'];
 473          }
 474      }
 475  
 476      return null;
 477  }
 478  
 479  /**
 480   * Returns the contextualized block editor settings for a selected editor context.
 481   *
 482   * @since 5.8.0
 483   *
 484   * @param array                   $custom_settings      Custom settings to use with the given editor type.
 485   * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
 486   *
 487   * @return array The contextualized block editor settings.
 488   */
 489  function get_block_editor_settings( array $custom_settings, $block_editor_context ) {
 490      $editor_settings = array_merge(
 491          get_default_block_editor_settings(),
 492          array(
 493              'allowedBlockTypes' => get_allowed_block_types( $block_editor_context ),
 494              'blockCategories'   => get_block_categories( $block_editor_context ),
 495          ),
 496          $custom_settings
 497      );
 498  
 499      $global_styles = array();
 500      $presets       = array(
 501          array(
 502              'css'            => 'variables',
 503              '__unstableType' => 'presets',
 504              'isGlobalStyles' => true,
 505          ),
 506          array(
 507              'css'            => 'presets',
 508              '__unstableType' => 'presets',
 509              'isGlobalStyles' => true,
 510          ),
 511      );
 512      foreach ( $presets as $preset_style ) {
 513          $actual_css = wp_get_global_stylesheet( array( $preset_style['css'] ) );
 514          if ( '' !== $actual_css ) {
 515              $preset_style['css'] = $actual_css;
 516              $global_styles[]     = $preset_style;
 517          }
 518      }
 519  
 520      if ( wp_theme_has_theme_json() ) {
 521          $block_classes = array(
 522              'css'            => 'styles',
 523              '__unstableType' => 'theme',
 524              'isGlobalStyles' => true,
 525          );
 526          $actual_css    = wp_get_global_stylesheet( array( $block_classes['css'] ) );
 527          if ( '' !== $actual_css ) {
 528              $block_classes['css'] = $actual_css;
 529              $global_styles[]      = $block_classes;
 530          }
 531  
 532          /*
 533           * Add the custom CSS as a separate stylesheet so any invalid CSS
 534           * entered by users does not break other global styles.
 535           */
 536          $global_styles[] = array(
 537              'css'            => wp_get_global_stylesheet( array( 'custom-css' ) ),
 538              '__unstableType' => 'user',
 539              'isGlobalStyles' => true,
 540          );
 541      } else {
 542          // If there is no `theme.json` file, ensure base layout styles are still available.
 543          $block_classes = array(
 544              'css'            => 'base-layout-styles',
 545              '__unstableType' => 'base-layout',
 546              'isGlobalStyles' => true,
 547          );
 548          $actual_css    = wp_get_global_stylesheet( array( $block_classes['css'] ) );
 549          if ( '' !== $actual_css ) {
 550              $block_classes['css'] = $actual_css;
 551              $global_styles[]      = $block_classes;
 552          }
 553      }
 554  
 555      $editor_settings['styles'] = array_merge( $global_styles, get_block_editor_theme_styles() );
 556  
 557      $editor_settings['__experimentalFeatures'] = wp_get_global_settings();
 558      // These settings may need to be updated based on data coming from theme.json sources.
 559      if ( isset( $editor_settings['__experimentalFeatures']['color']['palette'] ) ) {
 560          $colors_by_origin          = $editor_settings['__experimentalFeatures']['color']['palette'];
 561          $editor_settings['colors'] = isset( $colors_by_origin['custom'] ) ?
 562              $colors_by_origin['custom'] : (
 563                  isset( $colors_by_origin['theme'] ) ?
 564                      $colors_by_origin['theme'] :
 565                      $colors_by_origin['default']
 566              );
 567      }
 568      if ( isset( $editor_settings['__experimentalFeatures']['color']['gradients'] ) ) {
 569          $gradients_by_origin          = $editor_settings['__experimentalFeatures']['color']['gradients'];
 570          $editor_settings['gradients'] = isset( $gradients_by_origin['custom'] ) ?
 571              $gradients_by_origin['custom'] : (
 572                  isset( $gradients_by_origin['theme'] ) ?
 573                      $gradients_by_origin['theme'] :
 574                      $gradients_by_origin['default']
 575              );
 576      }
 577      if ( isset( $editor_settings['__experimentalFeatures']['typography']['fontSizes'] ) ) {
 578          $font_sizes_by_origin         = $editor_settings['__experimentalFeatures']['typography']['fontSizes'];
 579          $editor_settings['fontSizes'] = isset( $font_sizes_by_origin['custom'] ) ?
 580              $font_sizes_by_origin['custom'] : (
 581                  isset( $font_sizes_by_origin['theme'] ) ?
 582                      $font_sizes_by_origin['theme'] :
 583                      $font_sizes_by_origin['default']
 584              );
 585      }
 586      if ( isset( $editor_settings['__experimentalFeatures']['color']['custom'] ) ) {
 587          $editor_settings['disableCustomColors'] = ! $editor_settings['__experimentalFeatures']['color']['custom'];
 588          unset( $editor_settings['__experimentalFeatures']['color']['custom'] );
 589      }
 590      if ( isset( $editor_settings['__experimentalFeatures']['color']['customGradient'] ) ) {
 591          $editor_settings['disableCustomGradients'] = ! $editor_settings['__experimentalFeatures']['color']['customGradient'];
 592          unset( $editor_settings['__experimentalFeatures']['color']['customGradient'] );
 593      }
 594      if ( isset( $editor_settings['__experimentalFeatures']['typography']['customFontSize'] ) ) {
 595          $editor_settings['disableCustomFontSizes'] = ! $editor_settings['__experimentalFeatures']['typography']['customFontSize'];
 596          unset( $editor_settings['__experimentalFeatures']['typography']['customFontSize'] );
 597      }
 598      if ( isset( $editor_settings['__experimentalFeatures']['typography']['lineHeight'] ) ) {
 599          $editor_settings['enableCustomLineHeight'] = $editor_settings['__experimentalFeatures']['typography']['lineHeight'];
 600          unset( $editor_settings['__experimentalFeatures']['typography']['lineHeight'] );
 601      }
 602      if ( isset( $editor_settings['__experimentalFeatures']['spacing']['units'] ) ) {
 603          $editor_settings['enableCustomUnits'] = $editor_settings['__experimentalFeatures']['spacing']['units'];
 604          unset( $editor_settings['__experimentalFeatures']['spacing']['units'] );
 605      }
 606      if ( isset( $editor_settings['__experimentalFeatures']['spacing']['padding'] ) ) {
 607          $editor_settings['enableCustomSpacing'] = $editor_settings['__experimentalFeatures']['spacing']['padding'];
 608          unset( $editor_settings['__experimentalFeatures']['spacing']['padding'] );
 609      }
 610      if ( isset( $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize'] ) ) {
 611          $editor_settings['disableCustomSpacingSizes'] = ! $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize'];
 612          unset( $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize'] );
 613      }
 614  
 615      if ( isset( $editor_settings['__experimentalFeatures']['spacing']['spacingSizes'] ) ) {
 616          $spacing_sizes_by_origin         = $editor_settings['__experimentalFeatures']['spacing']['spacingSizes'];
 617          $editor_settings['spacingSizes'] = isset( $spacing_sizes_by_origin['custom'] ) ?
 618              $spacing_sizes_by_origin['custom'] : (
 619                  isset( $spacing_sizes_by_origin['theme'] ) ?
 620                      $spacing_sizes_by_origin['theme'] :
 621                      $spacing_sizes_by_origin['default']
 622              );
 623      }
 624  
 625      $editor_settings['__unstableResolvedAssets']         = _wp_get_iframed_editor_assets();
 626      $editor_settings['__unstableIsBlockBasedTheme']      = wp_is_block_theme();
 627      $editor_settings['localAutosaveInterval']            = 15;
 628      $editor_settings['disableLayoutStyles']              = current_theme_supports( 'disable-layout-styles' );
 629      $editor_settings['__experimentalDiscussionSettings'] = array(
 630          'commentOrder'         => get_option( 'comment_order' ),
 631          'commentsPerPage'      => get_option( 'comments_per_page' ),
 632          'defaultCommentsPage'  => get_option( 'default_comments_page' ),
 633          'pageComments'         => get_option( 'page_comments' ),
 634          'threadComments'       => get_option( 'thread_comments' ),
 635          'threadCommentsDepth'  => get_option( 'thread_comments_depth' ),
 636          'defaultCommentStatus' => get_option( 'default_comment_status' ),
 637          'avatarURL'            => get_avatar_url(
 638              '',
 639              array(
 640                  'size'          => 96,
 641                  'force_default' => true,
 642                  'default'       => get_option( 'avatar_default' ),
 643              )
 644          ),
 645      );
 646  
 647      $post_content_block_attributes = wp_get_post_content_block_attributes();
 648  
 649      if ( isset( $post_content_block_attributes ) ) {
 650          $editor_settings['postContentAttributes'] = $post_content_block_attributes;
 651      }
 652  
 653      $editor_settings['canUpdateBlockBindings'] = current_user_can( 'edit_block_binding', $block_editor_context );
 654  
 655      /**
 656       * Filters the settings to pass to the block editor for all editor type.
 657       *
 658       * @since 5.8.0
 659       *
 660       * @param array                   $editor_settings      Default editor settings.
 661       * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
 662       */
 663      $editor_settings = apply_filters( 'block_editor_settings_all', $editor_settings, $block_editor_context );
 664  
 665      if ( ! empty( $block_editor_context->post ) ) {
 666          $post = $block_editor_context->post;
 667  
 668          /**
 669           * Filters the settings to pass to the block editor.
 670           *
 671           * @since 5.0.0
 672           * @deprecated 5.8.0 Use the {@see 'block_editor_settings_all'} filter instead.
 673           *
 674           * @param array   $editor_settings Default editor settings.
 675           * @param WP_Post $post            Post being edited.
 676           */
 677          $editor_settings = apply_filters_deprecated( 'block_editor_settings', array( $editor_settings, $post ), '5.8.0', 'block_editor_settings_all' );
 678      }
 679  
 680      return $editor_settings;
 681  }
 682  
 683  /**
 684   * Preloads common data used with the block editor by specifying an array of
 685   * REST API paths that will be preloaded for a given block editor context.
 686   *
 687   * @since 5.8.0
 688   *
 689   * @global WP_Post    $post       Global post object.
 690   * @global WP_Scripts $wp_scripts The WP_Scripts object for printing scripts.
 691   * @global WP_Styles  $wp_styles  The WP_Styles object for printing styles.
 692   *
 693   * @param (string|string[])[]     $preload_paths        List of paths to preload.
 694   * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
 695   */
 696  function block_editor_rest_api_preload( array $preload_paths, $block_editor_context ) {
 697      global $post, $wp_scripts, $wp_styles;
 698  
 699      /**
 700       * Filters the array of REST API paths that will be used to preloaded common data for the block editor.
 701       *
 702       * @since 5.8.0
 703       *
 704       * @param (string|string[])[]     $preload_paths        Array of paths to preload.
 705       * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
 706       */
 707      $preload_paths = apply_filters( 'block_editor_rest_api_preload_paths', $preload_paths, $block_editor_context );
 708  
 709      if ( ! empty( $block_editor_context->post ) ) {
 710          $selected_post = $block_editor_context->post;
 711  
 712          /**
 713           * Filters the array of paths that will be preloaded.
 714           *
 715           * Preload common data by specifying an array of REST API paths that will be preloaded.
 716           *
 717           * @since 5.0.0
 718           * @deprecated 5.8.0 Use the {@see 'block_editor_rest_api_preload_paths'} filter instead.
 719           *
 720           * @param (string|string[])[] $preload_paths Array of paths to preload.
 721           * @param WP_Post             $selected_post Post being edited.
 722           */
 723          $preload_paths = apply_filters_deprecated( 'block_editor_preload_paths', array( $preload_paths, $selected_post ), '5.8.0', 'block_editor_rest_api_preload_paths' );
 724      }
 725  
 726      if ( empty( $preload_paths ) ) {
 727          return;
 728      }
 729  
 730      /*
 731       * Ensure the global $post, $wp_scripts, and $wp_styles remain the same after
 732       * API data is preloaded.
 733       * Because API preloading can call the_content and other filters, plugins
 734       * can unexpectedly modify the global $post or enqueue assets which are not
 735       * intended for the block editor.
 736       */
 737      $backup_global_post = ! empty( $post ) ? clone $post : $post;
 738      $backup_wp_scripts  = ! empty( $wp_scripts ) ? clone $wp_scripts : $wp_scripts;
 739      $backup_wp_styles   = ! empty( $wp_styles ) ? clone $wp_styles : $wp_styles;
 740  
 741      foreach ( $preload_paths as &$path ) {
 742          if ( is_string( $path ) && ! str_starts_with( $path, '/' ) ) {
 743              $path = '/' . $path;
 744              continue;
 745          }
 746  
 747          if ( is_array( $path ) && is_string( $path[0] ) && ! str_starts_with( $path[0], '/' ) ) {
 748              $path[0] = '/' . $path[0];
 749          }
 750      }
 751  
 752      unset( $path );
 753  
 754      $preload_data = array_reduce(
 755          $preload_paths,
 756          'rest_preload_api_request',
 757          array()
 758      );
 759  
 760      // Restore the global $post, $wp_scripts, and $wp_styles as they were before API preloading.
 761      $post       = $backup_global_post;
 762      $wp_scripts = $backup_wp_scripts;
 763      $wp_styles  = $backup_wp_styles;
 764  
 765      wp_add_inline_script(
 766          'wp-api-fetch',
 767          sprintf(
 768              'wp.apiFetch.use( wp.apiFetch.createPreloadingMiddleware( %s ) );',
 769              wp_json_encode( $preload_data )
 770          ),
 771          'after'
 772      );
 773  }
 774  
 775  /**
 776   * Creates an array of theme styles to load into the block editor.
 777   *
 778   * @since 5.8.0
 779   *
 780   * @global array $editor_styles
 781   *
 782   * @return array An array of theme styles for the block editor.
 783   */
 784  function get_block_editor_theme_styles() {
 785      global $editor_styles;
 786  
 787      $styles = array();
 788  
 789      if ( $editor_styles && current_theme_supports( 'editor-styles' ) ) {
 790          foreach ( $editor_styles as $style ) {
 791              if ( preg_match( '~^(https?:)?//~', $style ) ) {
 792                  $response = wp_remote_get( $style );
 793                  if ( ! is_wp_error( $response ) ) {
 794                      $styles[] = array(
 795                          'css'            => wp_remote_retrieve_body( $response ),
 796                          '__unstableType' => 'theme',
 797                          'isGlobalStyles' => false,
 798                      );
 799                  }
 800              } else {
 801                  $file = get_theme_file_path( $style );
 802                  if ( is_file( $file ) ) {
 803                      $styles[] = array(
 804                          'css'            => file_get_contents( $file ),
 805                          'baseURL'        => get_theme_file_uri( $style ),
 806                          '__unstableType' => 'theme',
 807                          'isGlobalStyles' => false,
 808                      );
 809                  }
 810              }
 811          }
 812      }
 813  
 814      return $styles;
 815  }
 816  
 817  /**
 818   * Returns the classic theme supports settings for block editor.
 819   *
 820   * @since 6.2.0
 821   * @since 6.6.0 Add support for 'editor-spacing-sizes' theme support.
 822   *
 823   * @return array The classic theme supports settings.
 824   */
 825  function get_classic_theme_supports_block_editor_settings() {
 826      $theme_settings = array(
 827          'disableCustomColors'    => get_theme_support( 'disable-custom-colors' ),
 828          'disableCustomFontSizes' => get_theme_support( 'disable-custom-font-sizes' ),
 829          'disableCustomGradients' => get_theme_support( 'disable-custom-gradients' ),
 830          'disableLayoutStyles'    => get_theme_support( 'disable-layout-styles' ),
 831          'enableCustomLineHeight' => get_theme_support( 'custom-line-height' ),
 832          'enableCustomSpacing'    => get_theme_support( 'custom-spacing' ),
 833          'enableCustomUnits'      => get_theme_support( 'custom-units' ),
 834      );
 835  
 836      // Theme settings.
 837      $color_palette = current( (array) get_theme_support( 'editor-color-palette' ) );
 838      if ( false !== $color_palette ) {
 839          $theme_settings['colors'] = $color_palette;
 840      }
 841  
 842      $font_sizes = current( (array) get_theme_support( 'editor-font-sizes' ) );
 843      if ( false !== $font_sizes ) {
 844          $theme_settings['fontSizes'] = $font_sizes;
 845      }
 846  
 847      $gradient_presets = current( (array) get_theme_support( 'editor-gradient-presets' ) );
 848      if ( false !== $gradient_presets ) {
 849          $theme_settings['gradients'] = $gradient_presets;
 850      }
 851  
 852      $spacing_sizes = current( (array) get_theme_support( 'editor-spacing-sizes' ) );
 853      if ( false !== $spacing_sizes ) {
 854          $theme_settings['spacingSizes'] = $spacing_sizes;
 855      }
 856  
 857      return $theme_settings;
 858  }


Generated : Fri Feb 21 08:20:01 2025 Cross-referenced by PHPXref