云策 WordPress 开发者社区

函数文档

get_block_editor_settings()

查看官方原文 ↗
💡 云策文档标注

概述

get_block_editor_settings() 函数用于返回针对特定编辑器上下文的块编辑器设置。它整合了默认设置、自定义设置、全局样式和实验性功能，并通过过滤器允许开发者进行自定义。

关键要点

  • 函数接受两个参数：$custom_settings（自定义设置数组）和 $block_editor_context（WP_Block_Editor_Context 对象），返回上下文化的编辑器设置数组。
  • 核心逻辑包括合并默认设置、允许的块类型、块分类，并处理全局样式（如变量、预设、主题 JSON 数据）。
  • 集成实验性功能如块绑定支持属性、颜色、渐变、字体大小等设置，并根据主题 JSON 调整相关配置。
  • 提供过滤器 block_editor_settings_all（自 5.8.0 起）和已弃用的 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
	);
	// ... 更多代码处理全局样式和实验性功能
	return $editor_settings;
}

注意事项

  • 自 WordPress 5.8.0 引入，建议使用 block_editor_settings_all 过滤器替代已弃用的 block_editor_settings。
  • 函数依赖于多个辅助函数如 wp_get_global_stylesheet() 和 wp_get_global_settings()，确保主题 JSON 文件存在时正确加载样式。
  • 设置中包含实验性功能（如 __experimentalFeatures），可能在未来版本中变更，使用时需注意兼容性。
📄 原文内容

Returns the contextualized block editor settings for a selected editor context.

Parameters

$custom_settingsarrayrequired
Custom settings to use with the given editor type.
$block_editor_contextWP_Block_Editor_Contextrequired
The current block editor context.

Return

array The contextualized block editor settings.

Source

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
	);

	$editor_settings['__experimentalBlockBindingsSupportedAttributes'] = array();
	foreach ( array_keys( WP_Block_Type_Registry::get_instance()->get_all_registered() ) as $block_type ) {
		$supported_block_attributes = get_block_bindings_supported_attributes( $block_type );
		if ( ! empty( $supported_block_attributes ) ) {
			$editor_settings['__experimentalBlockBindingsSupportedAttributes'][ $block_type ] = $supported_block_attributes;
		}
	}

	$global_styles = array();
	$presets       = array(
		array(
			'css'            => 'variables',
			'__unstableType' => 'presets',
			'isGlobalStyles' => true,
		),
		array(
			'css'            => 'presets',
			'__unstableType' => 'presets',
			'isGlobalStyles' => true,
		),
	);
	foreach ( $presets as $preset_style ) {
		$actual_css = wp_get_global_stylesheet( array( $preset_style['css'] ) );
		if ( '' !== $actual_css ) {
			$preset_style['css'] = $actual_css;
			$global_styles[]     = $preset_style;
		}
	}

	if ( wp_theme_has_theme_json() ) {
		$block_classes = array(
			'css'            => 'styles',
			'__unstableType' => 'theme',
			'isGlobalStyles' => true,
		);
		$actual_css    = wp_get_global_stylesheet( array( $block_classes['css'] ) );
		if ( '' !== $actual_css ) {
			$block_classes['css'] = $actual_css;
			$global_styles[]      = $block_classes;
		}

		/*
		 * Add the custom CSS as a separate stylesheet so any invalid CSS
		 * entered by users does not break other global styles.
		 */
		$global_styles[] = array(
			'css'            => wp_get_global_stylesheet( array( 'custom-css' ) ),
			'__unstableType' => 'user',
			'isGlobalStyles' => true,
		);
	} else {
		// If there is no `theme.json` file, ensure base layout styles are still available.
		$block_classes = array(
			'css'            => 'base-layout-styles',
			'__unstableType' => 'base-layout',
			'isGlobalStyles' => true,
		);
		$actual_css    = wp_get_global_stylesheet( array( $block_classes['css'] ) );
		if ( '' !== $actual_css ) {
			$block_classes['css'] = $actual_css;
			$global_styles[]      = $block_classes;
		}
	}

	$editor_settings['styles'] = array_merge( $global_styles, get_block_editor_theme_styles() );

	$editor_settings['__experimentalFeatures'] = wp_get_global_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['custom'] ) ?
			$colors_by_origin['custom'] : (
				isset( $colors_by_origin['theme'] ) ?
					$colors_by_origin['theme'] :
					$colors_by_origin['default']
			);
	}
	if ( isset( $editor_settings['__experimentalFeatures']['color']['gradients'] ) ) {
		$gradients_by_origin          = $editor_settings['__experimentalFeatures']['color']['gradients'];
		$editor_settings['gradients'] = isset( $gradients_by_origin['custom'] ) ?
			$gradients_by_origin['custom'] : (
				isset( $gradients_by_origin['theme'] ) ?
					$gradients_by_origin['theme'] :
					$gradients_by_origin['default']
			);
	}
	if ( isset( $editor_settings['__experimentalFeatures']['typography']['fontSizes'] ) ) {
		$font_sizes_by_origin         = $editor_settings['__experimentalFeatures']['typography']['fontSizes'];
		$editor_settings['fontSizes'] = isset( $font_sizes_by_origin['custom'] ) ?
			$font_sizes_by_origin['custom'] : (
				isset( $font_sizes_by_origin['theme'] ) ?
					$font_sizes_by_origin['theme'] :
					$font_sizes_by_origin['default']
			);
	}
	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']['lineHeight'] ) ) {
		$editor_settings['enableCustomLineHeight'] = $editor_settings['__experimentalFeatures']['typography']['lineHeight'];
		unset( $editor_settings['__experimentalFeatures']['typography']['lineHeight'] );
	}
	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']['padding'] ) ) {
		$editor_settings['enableCustomSpacing'] = $editor_settings['__experimentalFeatures']['spacing']['padding'];
		unset( $editor_settings['__experimentalFeatures']['spacing']['padding'] );
	}
	if ( isset( $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize'] ) ) {
		$editor_settings['disableCustomSpacingSizes'] = ! $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize'];
		unset( $editor_settings['__experimentalFeatures']['spacing']['customSpacingSize'] );
	}

	if ( isset( $editor_settings['__experimentalFeatures']['spacing']['spacingSizes'] ) ) {
		$spacing_sizes_by_origin         = $editor_settings['__experimentalFeatures']['spacing']['spacingSizes'];
		$editor_settings['spacingSizes'] = isset( $spacing_sizes_by_origin['custom'] ) ?
			$spacing_sizes_by_origin['custom'] : (
				isset( $spacing_sizes_by_origin['theme'] ) ?
					$spacing_sizes_by_origin['theme'] :
					$spacing_sizes_by_origin['default']
			);
	}

	$editor_settings['__unstableResolvedAssets']         = _wp_get_iframed_editor_assets();
	$editor_settings['__unstableIsBlockBasedTheme']      = wp_is_block_theme();
	$editor_settings['localAutosaveInterval']            = 15;
	$editor_settings['disableLayoutStyles']              = current_theme_supports( 'disable-layout-styles' );
	$editor_settings['__experimentalDiscussionSettings'] = array(
		'commentOrder'         => get_option( 'comment_order' ),
		'commentsPerPage'      => get_option( 'comments_per_page' ),
		'defaultCommentsPage'  => get_option( 'default_comments_page' ),
		'pageComments'         => get_option( 'page_comments' ),
		'threadComments'       => get_option( 'thread_comments' ),
		'threadCommentsDepth'  => get_option( 'thread_comments_depth' ),
		'defaultCommentStatus' => get_option( 'default_comment_status' ),
		'avatarURL'            => get_avatar_url(
			'',
			array(
				'size'          => 96,
				'force_default' => true,
				'default'       => get_option( 'avatar_default' ),
			)
		),
	);

	$post_content_block_attributes = wp_get_post_content_block_attributes();

	if ( isset( $post_content_block_attributes ) ) {
		$editor_settings['postContentAttributes'] = $post_content_block_attributes;
	}

	$editor_settings['canUpdateBlockBindings'] = current_user_can( 'edit_block_binding', $block_editor_context );

	/**
	 * 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 '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;
}

View all references View on Trac View on GitHub

Hooks

apply_filters_deprecated( ‘block_editor_settings’, array $editor_settings, WP_Post $post )

Filters the settings to pass to the block editor.

apply_filters( ‘block_editor_settings_all’, array $editor_settings, WP_Block_Editor_Context $block_editor_context )

Filters the settings to pass to the block editor for all editor type.

Uses Description
get_block_bindings_supported_attributes()wp-includes/block-bindings.php

Retrieves the list of block attributes supported by block bindings.
wp_get_post_content_block_attributes()wp-includes/block-editor.php

Retrieves Post Content block attributes from the current post template.
wp_theme_has_theme_json()wp-includes/global-styles-and-settings.php

Checks whether a theme or its parent has a theme.json file.
_wp_get_iframed_editor_assets()wp-includes/block-editor.php

Collect the block editor assets that need to be loaded into the editor’s iframe.
wp_get_global_stylesheet()wp-includes/global-styles-and-settings.php

Returns the stylesheet resulting of merging core, theme, and user data.
wp_get_global_settings()wp-includes/global-styles-and-settings.php

Gets the settings resulting of merging core, theme, and user data.
wp_is_block_theme()wp-includes/theme.php

Returns whether the active theme is a block-based theme or not.
get_block_editor_theme_styles()wp-includes/block-editor.php

Creates an array of theme styles to load into the block editor.
get_default_block_editor_settings()wp-includes/block-editor.php

Returns the default block editor settings.
get_allowed_block_types()wp-includes/block-editor.php

Gets the list of allowed block types to use in the block editor.
WP_Block_Type_Registry::get_instance()wp-includes/class-wp-block-type-registry.php

Utility method to retrieve the main instance of the class.
get_block_categories()wp-includes/block-editor.php

Returns all the categories for block types that will be shown in the block editor.
apply_filters_deprecated()wp-includes/plugin.php

Fires functions attached to a deprecated filter hook.
get_avatar_url()wp-includes/link-template.php

Retrieves the avatar URL.
current_user_can()wp-includes/capabilities.php

Returns whether the current user has the specified capability.
current_theme_supports()wp-includes/theme.php

Checks a theme’s support for a given feature.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Show 13 moreShow less

Used by Description
WP_Customize_Widgets::enqueue_scripts()wp-includes/class-wp-customize-widgets.php

Enqueues scripts and styles for Customizer panel and export data to JavaScript.

Changelog

Version Description
5.8.0 Introduced.