get_block_editor_settings( array $custom_settings, WP_Block_Editor_Context $block_editor_context ): array

Parameters

$custom_settingsarray

Custom settings to use with the given editor type.

$block_editor_contextWP_Block_Editor_Context

The current block editor context.

Return

array

The contextualized block editor settings.

Hooks fired · 2

2 hooks fire while get_block_editor_settings() runs, in this order:

1. 1
   apply_filters( block_editor_settings_all )filterline 645 (+155 into the body)

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

2. 2
   do_action( block_editor_settings )filter_deprecatedline 659 (+169 into the body)

   Filters the settings to pass to the block editor.

Uses · 19

• get_default_block_editor_settings()Returns the default block editor settings.
• get_allowed_block_types()Gets the list of allowed block types to use in the block editor.
• get_block_categories()Returns all the categories for block types that will be shown in the block editor.
• get_block_bindings_supported_attributes()Retrieves the list of block attributes supported by block bindings.
• wp_get_global_stylesheet()Returns the stylesheet resulting of merging core, theme, and user data.
• wp_get_custom_css()Fetches the saved Custom CSS content for rendering.
• get_block_editor_theme_styles()Creates an array of theme styles to load into the block editor.
• wp_get_global_settings()Gets the settings resulting of merging core, theme, and user data.
• _wp_get_iframed_editor_assets()Collect the block editor assets that need to be loaded into the editor's iframe.
• wp_is_block_theme()Returns whether the active theme is a block-based theme or not.
• current_theme_supports()Checks a theme's support for a given feature.
• get_option()Retrieves an option value based on an option name.

Used by · 1

• WP_Customize_Widgets::enqueue_scripts()Enqueues scripts and styles for Customizer panel and export data to JavaScript.

Source

View on Trac ↗View on GitHub ↗

490function 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_settings498	);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 CSS549	 * 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'] ) ) {

History

Introduced in 5.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/block-editor.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.