Skip to content

Commit

Permalink
Block Editor: Standardize loading default block editor settings (#30245)
Browse files Browse the repository at this point in the history 
* Block Editor: Standardize loading default block editor settings

* Ensure that allowed_block_types is executed only when the post if defined

* Sync block editor shared methods with Wordpress core
  • Loading branch information
@gziolo
gziolo authored Apr 19, 2021
1 parent a68cbf6 commit bc92278
Show file tree
Hide file tree
Showing 9 changed files with 616 additions and 77 deletions.
293 changes: 293 additions & 0 deletions lib/block-editor.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,293 @@
<?php
/**
* Block Editor API.
*
* @package Gutenberg
* @subpackage Editor
* @since 10.5.0
*/

/**
* Returns the list of default categories for block types.
*
* This is a temporary solution until the Gutenberg plugin sets
* the required WordPress version to 5.8.
*
* @see https://core.trac.wordpress.org/ticket/52920
*
* @since 10.5.0.
*
* @return array[] Array of categories for block types.
*/
function gutenberg_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.
*
* This is a temporary solution until the Gutenberg plugin sets
* the required WordPress version to 5.8.
*
* @see https://core.trac.wordpress.org/ticket/52920
*
* @since 10.5.0
*
* @param string|WP_Post $editor_name_or_post The name of the editor (e.g. 'post-editor')
* or the post object.
*
* @return array[] Array of categories for block types.
*/
function gutenberg_get_block_categories( $editor_name_or_post ) {
// Assume the post editor when the WP_Post object passed.
$editor_name = is_object( $editor_name_or_post ) ? 'post-editor' : $editor_name_or_post;
$default_categories = get_default_block_categories();

/**
* Filters the default array of categories for block types.
*
* @since 5.8.0
*
* @param array[] $default_categories Array of categories for block types.
*/
$block_categories = apply_filters( "block_categories_{$editor_name}", $default_categories );
if ( 'post-editor' === $editor_name ) {
$post = is_object( $editor_name_or_post ) ? $editor_name_or_post : get_post();

/**
* Filters the default array of categories for block types.
*
* @since 5.0.0
* @deprecated 5.8.0 The hook transitioned to support also screens that don't contain the $post instance.
*
* @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_{$editor_name}" );
}

return $block_categories;
}

/**
* Gets the list of allowed block types to use in the block editor.
*
* This is a temporary solution until the Gutenberg plugin sets
* the required WordPress version to 5.8.
*
* @see https://core.trac.wordpress.org/ticket/52920
*
* @since 10.5.0
*
* @param string $editor_name The name of the editor (e.g. 'post-editor').
*
* @return bool|array Array of block type slugs, or boolean to enable/disable all.
*/
function gutenberg_get_allowed_block_types( $editor_name ) {
$allowed_block_types = true;

/**
* Filters the allowed block types for the given editor, defaulting to true (all
* registered block types supported).
*
* @since 5.8.0
*
* @param bool|array $allowed_block_types Array of block type slugs, or
* boolean to enable/disable all.
*/
$allowed_block_types = apply_filters( "allowed_block_types_{$editor_name}", $allowed_block_types );
if ( 'post-editor' === $editor_name ) {
$post = get_post();

/**
* Filters the allowed block types for the editor, defaulting to true (all
* block types supported).
*
* @since 5.0.0
* @deprecated 5.8.0 The hook transitioned to support also screens that don't contain $post instance.
*
* @param bool|array $allowed_block_types Array of block type slugs, or
* boolean to enable/disable all.
* @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_{$editor_name}" );
}

return $allowed_block_types;
}

/**
* Returns the default block editor settings.
*
* This is a temporary solution until the Gutenberg plugin sets
* the required WordPress version to 5.8.
*
* @see https://core.trac.wordpress.org/ticket/52920
*
* @since 10.5.0
*
* @return array The default block editor settings.
*/
function gutenberg_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 ) ? $image_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(
'__unstableEnableFullSiteEditingBlocks' => gutenberg_supports_block_templates(),
'alignWide' => get_theme_support( 'align-wide' ),
'allowedBlockTypes' => true,
'allowedMimeTypes' => get_allowed_mime_types(),
'blockCategories' => gutenberg_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 contextualized block editor settings settings for a selected editor type.
*
* This is a temporary solution until the Gutenberg plugin sets
* the required WordPress version to 5.8.
*
* @see https://core.trac.wordpress.org/ticket/52920
*
* @since 10.5.0
*
* @param string $editor_name The name of the editor (e.g. 'post-editor').
* @param array $custom_settings Optional custom settings to use with the editor type.
*
* @return array The contextualized block editor settings.
*/
function gutenberg_get_block_editor_settings( $editor_name, $custom_settings = array() ) {
$editor_settings = array_merge(
gutenberg_get_default_block_editor_settings( $editor_name ),
array(
'allowedBlockTypes' => gutenberg_get_allowed_block_types( $editor_name ),
'blockCategories' => gutenberg_get_block_categories( $editor_name ),
),
$custom_settings
);

/**
* Filters the settings to pass to the block editor for a given editor type.
*
* @since 5.8.0
*
* @param array $editor_settings Default editor settings.
*/
$editor_settings = apply_filters( "block_editor_settings_{$editor_name}", $editor_settings );
if ( 'post-editor' === $editor_name ) {
$post = get_post();

/**
* Filters the settings to pass to the block editor.
*
* @since 5.0.0
* @deprecated 5.8.0 The hook transitioned to support also screens that don't contain $post instance.
*
* @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_{$editor_name}" );
}

return $editor_settings;
}
69 changes: 0 additions & 69 deletions lib/editor-settings.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,71 +5,6 @@
* @package gutenberg
*/

/**
* Returns editor settings that are common to all editors:
* post, site, widgets, and navigation.
*
* All these settings are already part of core,
* see edit-form-blocks.php
*
* @return array Common editor settings.
*/
function gutenberg_get_common_block_editor_settings() {
$max_upload_size = wp_max_upload_size();
if ( ! $max_upload_size ) {
$max_upload_size = 0;
}

$available_image_sizes = array();
// This filter is documented in wp-admin/includes/media.php.
$image_size_names = apply_filters(
'image_size_names_choose',
array(
'thumbnail' => __( 'Thumbnail', 'gutenberg' ),
'medium' => __( 'Medium', 'gutenberg' ),
'large' => __( 'Large', 'gutenberg' ),
'full' => __( 'Full Size', 'gutenberg' ),
)
);
foreach ( $image_size_names as $image_size_slug => $image_size_name ) {
$available_image_sizes[] = array(
'slug' => $image_size_slug,
'name' => $image_size_name,
);
}

$settings = array(
'__unstableEnableFullSiteEditingBlocks' => gutenberg_supports_block_templates(),
'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' ),
'enableCustomUnits' => get_theme_support( 'custom-units' ),
'enableCustomSpacing' => get_theme_support( 'custom-spacing' ),
'imageSizes' => $available_image_sizes,
'isRTL' => is_rtl(),
'maxUploadFileSize' => $max_upload_size,
'allowedMimeTypes' => get_allowed_mime_types(),
);

$color_palette = current( (array) get_theme_support( 'editor-color-palette' ) );
if ( false !== $color_palette ) {
$settings['colors'] = $color_palette;
}

$font_sizes = current( (array) get_theme_support( 'editor-font-sizes' ) );
if ( false !== $font_sizes ) {
$settings['fontSizes'] = $font_sizes;
}

$gradient_presets = current( (array) get_theme_support( 'editor-gradient-presets' ) );
if ( false !== $gradient_presets ) {
$settings['gradients'] = $gradient_presets;
}

return $settings;
}

/**
* Extends the block editor with settings that are only in the plugin.
*
Expand All @@ -78,10 +13,6 @@ function gutenberg_get_common_block_editor_settings() {
* @return array Filtered settings.
*/
function gutenberg_extend_post_editor_settings( $settings ) {
$image_default_size = get_option( 'image_default_size', 'large' );
$image_sizes = wp_list_pluck( $settings['imageSizes'], 'slug' );

$settings['imageDefaultSize'] = in_array( $image_default_size, $image_sizes, true ) ? $image_default_size : 'large';
$settings['__unstableEnableFullSiteEditingBlocks'] = gutenberg_supports_block_templates();

return $settings;
Expand Down
3 changes: 1 addition & 2 deletions lib/full-site-editing/edit-site-page.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,8 @@ function gutenberg_edit_site_init( $hook ) {
$current_screen->is_block_editor( true );

$settings = array_merge(
gutenberg_get_common_block_editor_settings(),
gutenberg_get_default_block_editor_settings(),
array(
'alignWide' => get_theme_support( 'align-wide' ),
'siteUrl' => site_url(),
'postsPerPage' => get_option( 'posts_per_page' ),
'styles' => gutenberg_get_editor_styles(),
Expand Down
2 changes: 1 addition & 1 deletion lib/global-styles.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ function gutenberg_experimental_global_styles_enqueue_assets() {
return;
}

$settings = gutenberg_get_common_block_editor_settings();
$settings = gutenberg_get_default_block_editor_settings();
$theme_support_data = WP_Theme_JSON::get_from_editor_settings( $settings );

$all = WP_Theme_JSON_Resolver::get_merged_data( $theme_support_data );
Expand Down
Loading

0 comments on commit bc92278

Please sign in to comment.