--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/wp/wp-includes/block-editor.php Wed Sep 21 18:19:35 2022 +0200
@@ -0,0 +1,508 @@
+<?php
+/**
+ * Block Editor API.
+ *
+ * @package WordPress
+ * @subpackage Editor
+ * @since 5.8.0
+ */
+
+/**
+ * Returns the list of default categories for block types.
+ *
+ * @since 5.8.0
+ *
+ * @return array[] Array of categories for block types.
+ */
+function get_default_block_categories() {
+ return array(
+ array(
+ 'slug' => 'text',
+ 'title' => _x( 'Text', 'block category' ),
+ 'icon' => null,
+ ),
+ array(
+ 'slug' => 'media',
+ 'title' => _x( 'Media', 'block category' ),
+ 'icon' => null,
+ ),
+ array(
+ 'slug' => 'design',
+ 'title' => _x( 'Design', 'block category' ),
+ 'icon' => null,
+ ),
+ array(
+ 'slug' => 'widgets',
+ 'title' => _x( 'Widgets', 'block category' ),
+ 'icon' => null,
+ ),
+ array(
+ 'slug' => 'theme',
+ 'title' => _x( 'Theme', 'block category' ),
+ 'icon' => null,
+ ),
+ array(
+ 'slug' => 'embed',
+ 'title' => _x( 'Embeds', 'block category' ),
+ 'icon' => null,
+ ),
+ array(
+ 'slug' => 'reusable',
+ 'title' => _x( 'Reusable Blocks', 'block category' ),
+ 'icon' => null,
+ ),
+ );
+}
+
+/**
+ * Returns all the categories for block types that will be shown in the block editor.
+ *
+ * @since 5.0.0
+ * @since 5.8.0 It is possible to pass the block editor context as param.
+ *
+ * @param WP_Post|WP_Block_Editor_Context $post_or_block_editor_context The current post object or
+ * the block editor context.
+ *
+ * @return array[] Array of categories for block types.
+ */
+function get_block_categories( $post_or_block_editor_context ) {
+ $block_categories = get_default_block_categories();
+ $block_editor_context = $post_or_block_editor_context instanceof WP_Post ?
+ new WP_Block_Editor_Context(
+ array(
+ 'post' => $post_or_block_editor_context,
+ )
+ ) : $post_or_block_editor_context;
+
+ /**
+ * Filters the default array of categories for block types.
+ *
+ * @since 5.8.0
+ *
+ * @param array[] $block_categories Array of categories for block types.
+ * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
+ */
+ $block_categories = apply_filters( 'block_categories_all', $block_categories, $block_editor_context );
+ if ( ! empty( $block_editor_context->post ) ) {
+ $post = $block_editor_context->post;
+
+ /**
+ * Filters the default array of categories for block types.
+ *
+ * @since 5.0.0
+ * @deprecated 5.8.0 Use the {@see 'block_categories_all'} filter instead.
+ *
+ * @param array[] $block_categories Array of categories for block types.
+ * @param WP_Post $post Post being loaded.
+ */
+ $block_categories = apply_filters_deprecated( 'block_categories', array( $block_categories, $post ), '5.8.0', 'block_categories_all' );
+ }
+
+ return $block_categories;
+}
+
+/**
+ * Gets the list of allowed block types to use in the block editor.
+ *
+ * @since 5.8.0
+ *
+ * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
+ *
+ * @return bool|array Array of block type slugs, or boolean to enable/disable all.
+ */
+function get_allowed_block_types( $block_editor_context ) {
+ $allowed_block_types = true;
+
+ /**
+ * Filters the allowed block types for all editor types.
+ *
+ * @since 5.8.0
+ *
+ * @param bool|array $allowed_block_types Array of block type slugs, or boolean to enable/disable all.
+ * Default true (all registered block types supported).
+ * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
+ */
+ $allowed_block_types = apply_filters( 'allowed_block_types_all', $allowed_block_types, $block_editor_context );
+ if ( ! empty( $block_editor_context->post ) ) {
+ $post = $block_editor_context->post;
+
+ /**
+ * Filters the allowed block types for the editor.
+ *
+ * @since 5.0.0
+ * @deprecated 5.8.0 Use the {@see 'allowed_block_types_all'} filter instead.
+ *
+ * @param bool|array $allowed_block_types Array of block type slugs, or boolean to enable/disable all.
+ * Default true (all registered block types supported)
+ * @param WP_Post $post The post resource data.
+ */
+ $allowed_block_types = apply_filters_deprecated( 'allowed_block_types', array( $allowed_block_types, $post ), '5.8.0', 'allowed_block_types_all' );
+ }
+
+ return $allowed_block_types;
+}
+
+/**
+ * Returns the default block editor settings.
+ *
+ * @since 5.8.0
+ *
+ * @return array The default block editor settings.
+ */
+function get_default_block_editor_settings() {
+ // Media settings.
+ $max_upload_size = wp_max_upload_size();
+ if ( ! $max_upload_size ) {
+ $max_upload_size = 0;
+ }
+
+ /** This filter is documented in wp-admin/includes/media.php */
+ $image_size_names = apply_filters(
+ 'image_size_names_choose',
+ array(
+ 'thumbnail' => __( 'Thumbnail' ),
+ 'medium' => __( 'Medium' ),
+ 'large' => __( 'Large' ),
+ 'full' => __( 'Full Size' ),
+ )
+ );
+
+ $available_image_sizes = array();
+ foreach ( $image_size_names as $image_size_slug => $image_size_name ) {
+ $available_image_sizes[] = array(
+ 'slug' => $image_size_slug,
+ 'name' => $image_size_name,
+ );
+ }
+
+ $default_size = get_option( 'image_default_size', 'large' );
+ $image_default_size = in_array( $default_size, array_keys( $image_size_names ), true ) ? $default_size : 'large';
+
+ $image_dimensions = array();
+ $all_sizes = wp_get_registered_image_subsizes();
+ foreach ( $available_image_sizes as $size ) {
+ $key = $size['slug'];
+ if ( isset( $all_sizes[ $key ] ) ) {
+ $image_dimensions[ $key ] = $all_sizes[ $key ];
+ }
+ }
+
+ $editor_settings = array(
+ 'alignWide' => get_theme_support( 'align-wide' ),
+ 'allowedBlockTypes' => true,
+ 'allowedMimeTypes' => get_allowed_mime_types(),
+ 'blockCategories' => get_default_block_categories(),
+ 'disableCustomColors' => get_theme_support( 'disable-custom-colors' ),
+ 'disableCustomFontSizes' => get_theme_support( 'disable-custom-font-sizes' ),
+ 'disableCustomGradients' => get_theme_support( 'disable-custom-gradients' ),
+ 'enableCustomLineHeight' => get_theme_support( 'custom-line-height' ),
+ 'enableCustomSpacing' => get_theme_support( 'custom-spacing' ),
+ 'enableCustomUnits' => get_theme_support( 'custom-units' ),
+ 'isRTL' => is_rtl(),
+ 'imageDefaultSize' => $image_default_size,
+ 'imageDimensions' => $image_dimensions,
+ 'imageEditing' => true,
+ 'imageSizes' => $available_image_sizes,
+ 'maxUploadFileSize' => $max_upload_size,
+ );
+
+ // Theme settings.
+ $color_palette = current( (array) get_theme_support( 'editor-color-palette' ) );
+ if ( false !== $color_palette ) {
+ $editor_settings['colors'] = $color_palette;
+ }
+
+ $font_sizes = current( (array) get_theme_support( 'editor-font-sizes' ) );
+ if ( false !== $font_sizes ) {
+ $editor_settings['fontSizes'] = $font_sizes;
+ }
+
+ $gradient_presets = current( (array) get_theme_support( 'editor-gradient-presets' ) );
+ if ( false !== $gradient_presets ) {
+ $editor_settings['gradients'] = $gradient_presets;
+ }
+
+ return $editor_settings;
+}
+
+/**
+ * Returns the block editor settings needed to use the Legacy Widget block which
+ * is not registered by default.
+ *
+ * @since 5.8.0
+ *
+ * @return array Settings to be used with get_block_editor_settings().
+ */
+function get_legacy_widget_block_editor_settings() {
+ $editor_settings = array();
+
+ /**
+ * Filters the list of widget-type IDs that should **not** be offered by the
+ * Legacy Widget block.
+ *
+ * Returning an empty array will make all widgets available.
+ *
+ * @since 5.8.0
+ *
+ * @param array $widgets An array of excluded widget-type IDs.
+ */
+ $editor_settings['widgetTypesToHideFromLegacyWidgetBlock'] = apply_filters(
+ 'widget_types_to_hide_from_legacy_widget_block',
+ array(
+ 'pages',
+ 'calendar',
+ 'archives',
+ 'media_audio',
+ 'media_image',
+ 'media_gallery',
+ 'media_video',
+ 'search',
+ 'text',
+ 'categories',
+ 'recent-posts',
+ 'recent-comments',
+ 'rss',
+ 'tag_cloud',
+ 'custom_html',
+ 'block',
+ )
+ );
+
+ return $editor_settings;
+}
+
+/**
+ * Returns the contextualized block editor settings for a selected editor context.
+ *
+ * @since 5.8.0
+ *
+ * @param array $custom_settings Custom settings to use with the given editor type.
+ * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
+ *
+ * @return array The contextualized block editor settings.
+ */
+function get_block_editor_settings( array $custom_settings, $block_editor_context ) {
+ $editor_settings = array_merge(
+ get_default_block_editor_settings(),
+ array(
+ 'allowedBlockTypes' => get_allowed_block_types( $block_editor_context ),
+ 'blockCategories' => get_block_categories( $block_editor_context ),
+ ),
+ $custom_settings
+ );
+
+ $theme_json = WP_Theme_JSON_Resolver::get_merged_data( $editor_settings );
+
+ if ( WP_Theme_JSON_Resolver::theme_has_support() ) {
+ $editor_settings['styles'][] = array(
+ 'css' => $theme_json->get_stylesheet( 'block_styles' ),
+ '__unstableType' => 'globalStyles',
+ );
+ $editor_settings['styles'][] = array(
+ 'css' => $theme_json->get_stylesheet( 'css_variables' ),
+ '__experimentalNoWrapper' => true,
+ '__unstableType' => 'globalStyles',
+ );
+ }
+
+ $editor_settings['__experimentalFeatures'] = $theme_json->get_settings();
+ // These settings may need to be updated based on data coming from theme.json sources.
+ if ( isset( $editor_settings['__experimentalFeatures']['color']['palette'] ) ) {
+ $colors_by_origin = $editor_settings['__experimentalFeatures']['color']['palette'];
+ $editor_settings['colors'] = isset( $colors_by_origin['user'] ) ?
+ $colors_by_origin['user'] : (
+ isset( $colors_by_origin['theme'] ) ?
+ $colors_by_origin['theme'] :
+ $colors_by_origin['core']
+ );
+ }
+ if ( isset( $editor_settings['__experimentalFeatures']['color']['gradients'] ) ) {
+ $gradients_by_origin = $editor_settings['__experimentalFeatures']['color']['gradients'];
+ $editor_settings['gradients'] = isset( $gradients_by_origin['user'] ) ?
+ $gradients_by_origin['user'] : (
+ isset( $gradients_by_origin['theme'] ) ?
+ $gradients_by_origin['theme'] :
+ $gradients_by_origin['core']
+ );
+ }
+ if ( isset( $editor_settings['__experimentalFeatures']['typography']['fontSizes'] ) ) {
+ $font_sizes_by_origin = $editor_settings['__experimentalFeatures']['typography']['fontSizes'];
+ $editor_settings['fontSizes'] = isset( $font_sizes_by_origin['user'] ) ?
+ $font_sizes_by_origin['user'] : (
+ isset( $font_sizes_by_origin['theme'] ) ?
+ $font_sizes_by_origin['theme'] :
+ $font_sizes_by_origin['core']
+ );
+ }
+ if ( isset( $editor_settings['__experimentalFeatures']['color']['custom'] ) ) {
+ $editor_settings['disableCustomColors'] = ! $editor_settings['__experimentalFeatures']['color']['custom'];
+ unset( $editor_settings['__experimentalFeatures']['color']['custom'] );
+ }
+ if ( isset( $editor_settings['__experimentalFeatures']['color']['customGradient'] ) ) {
+ $editor_settings['disableCustomGradients'] = ! $editor_settings['__experimentalFeatures']['color']['customGradient'];
+ unset( $editor_settings['__experimentalFeatures']['color']['customGradient'] );
+ }
+ if ( isset( $editor_settings['__experimentalFeatures']['typography']['customFontSize'] ) ) {
+ $editor_settings['disableCustomFontSizes'] = ! $editor_settings['__experimentalFeatures']['typography']['customFontSize'];
+ unset( $editor_settings['__experimentalFeatures']['typography']['customFontSize'] );
+ }
+ if ( isset( $editor_settings['__experimentalFeatures']['typography']['customLineHeight'] ) ) {
+ $editor_settings['enableCustomLineHeight'] = $editor_settings['__experimentalFeatures']['typography']['customLineHeight'];
+ unset( $editor_settings['__experimentalFeatures']['typography']['customLineHeight'] );
+ }
+ if ( isset( $editor_settings['__experimentalFeatures']['spacing']['units'] ) ) {
+ $editor_settings['enableCustomUnits'] = $editor_settings['__experimentalFeatures']['spacing']['units'];
+ unset( $editor_settings['__experimentalFeatures']['spacing']['units'] );
+ }
+ if ( isset( $editor_settings['__experimentalFeatures']['spacing']['customPadding'] ) ) {
+ $editor_settings['enableCustomSpacing'] = $editor_settings['__experimentalFeatures']['spacing']['customPadding'];
+ unset( $editor_settings['__experimentalFeatures']['spacing']['customPadding'] );
+ }
+
+ /**
+ * Filters the settings to pass to the block editor for all editor type.
+ *
+ * @since 5.8.0
+ *
+ * @param array $editor_settings Default editor settings.
+ * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
+ */
+ $editor_settings = apply_filters( 'block_editor_settings_all', $editor_settings, $block_editor_context );
+ if ( ! empty( $block_editor_context->post ) ) {
+ $post = $block_editor_context->post;
+
+ /**
+ * Filters the settings to pass to the block editor.
+ *
+ * @since 5.0.0
+ * @deprecated 5.8.0 Use the {@see 'block_editor_settings_all'} filter instead.
+ *
+ * @param array $editor_settings Default editor settings.
+ * @param WP_Post $post Post being edited.
+ */
+ $editor_settings = apply_filters_deprecated( 'block_editor_settings', array( $editor_settings, $post ), '5.8.0', 'block_editor_settings_all' );
+ }
+
+ return $editor_settings;
+}
+
+/**
+ * Preloads common data used with the block editor by specifying an array of
+ * REST API paths that will be preloaded for a given block editor context.
+ *
+ * @since 5.8.0
+ *
+ * @global WP_Post $post Global post object.
+ *
+ * @param array $preload_paths List of paths to preload.
+ * @param WP_Block_Editor_Context $block_editor_context The current block editor context.
+ *
+ * @return void
+ */
+function block_editor_rest_api_preload( array $preload_paths, $block_editor_context ) {
+ global $post;
+
+ /**
+ * Filters the array of REST API paths that will be used to preloaded common data for the block editor.
+ *
+ * @since 5.8.0
+ *
+ * @param string[] $preload_paths Array of paths to preload.
+ */
+ $preload_paths = apply_filters( 'block_editor_rest_api_preload_paths', $preload_paths, $block_editor_context );
+ if ( ! empty( $block_editor_context->post ) ) {
+ $selected_post = $block_editor_context->post;
+
+ /**
+ * Filters the array of paths that will be preloaded.
+ *
+ * Preload common data by specifying an array of REST API paths that will be preloaded.
+ *
+ * @since 5.0.0
+ * @deprecated 5.8.0 Use the {@see 'block_editor_rest_api_preload_paths'} filter instead.
+ *
+ * @param string[] $preload_paths Array of paths to preload.
+ * @param WP_Post $selected_post Post being edited.
+ */
+ $preload_paths = apply_filters_deprecated( 'block_editor_preload_paths', array( $preload_paths, $selected_post ), '5.8.0', 'block_editor_rest_api_preload_paths' );
+ }
+
+ if ( empty( $preload_paths ) ) {
+ return;
+ }
+
+ /*
+ * Ensure the global $post remains the same after API data is preloaded.
+ * Because API preloading can call the_content and other filters, plugins
+ * can unexpectedly modify $post.
+ */
+ $backup_global_post = ! empty( $post ) ? clone $post : $post;
+
+ $preload_data = array_reduce(
+ $preload_paths,
+ 'rest_preload_api_request',
+ array()
+ );
+
+ // Restore the global $post as it was before API preloading.
+ $post = $backup_global_post;
+
+ wp_add_inline_script(
+ 'wp-api-fetch',
+ sprintf(
+ 'wp.apiFetch.use( wp.apiFetch.createPreloadingMiddleware( %s ) );',
+ wp_json_encode( $preload_data )
+ ),
+ 'after'
+ );
+}
+
+/**
+ * Creates an array of theme styles to load into the block editor.
+ *
+ * @since 5.8.0
+ *
+ * @global array $editor_styles
+ *
+ * @return array An array of theme styles for the block editor. Includes default font family
+ * style and theme stylesheets.
+ */
+function get_block_editor_theme_styles() {
+ global $editor_styles;
+
+ if ( ! WP_Theme_JSON_Resolver::theme_has_support() ) {
+ $styles = array(
+ array(
+ 'css' => 'body { font-family: -apple-system,BlinkMacSystemFont,"Segoe UI",Roboto,Oxygen-Sans,Ubuntu,Cantarell,"Helvetica Neue",sans-serif }',
+ '__unstableType' => 'core',
+ ),
+ );
+ } else {
+ $styles = array();
+ }
+
+ if ( $editor_styles && current_theme_supports( 'editor-styles' ) ) {
+ foreach ( $editor_styles as $style ) {
+ if ( preg_match( '~^(https?:)?//~', $style ) ) {
+ $response = wp_remote_get( $style );
+ if ( ! is_wp_error( $response ) ) {
+ $styles[] = array(
+ 'css' => wp_remote_retrieve_body( $response ),
+ '__unstableType' => 'theme',
+ );
+ }
+ } else {
+ $file = get_theme_file_path( $style );
+ if ( is_file( $file ) ) {
+ $styles[] = array(
+ 'css' => file_get_contents( $file ),
+ 'baseURL' => get_theme_file_uri( $style ),
+ '__unstableType' => 'theme',
+ );
+ }
+ }
+ }
+ }
+
+ return $styles;
+}