wppaste
WordPress

WP_Duotone::add_editor_settings( array $settings ): array

Since
6.3.0
Source
wp-includes/class-wp-duotone.php:1276
Adds the duotone SVGs and CSS custom properties to the editor settings.

Description

This allows the properties to be pulled in by the EditorStyles component in JS and rendered in the post editor.

Compatibility

WordPress
since 6.3.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$settingsarray
The block editor settings from the block_editor_settings_all filter.

Return value

array
The editor settings with duotone SVGs and CSS custom properties.

Performance profile

How much work a call to WP_Duotone::add_editor_settings() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
7–29

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 29.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Duotone::add_editor_settings() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
empty($global_styles_presets)7::get_all_global_styles_presets()
!empty($global_styles_presets)27–29::get_all_global_styles_presets(), ::get_svg_definitions(), ::get_global_styles_presets()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 29 instructions, 7–29 executed per call, 2 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 3

Source code

	public static function add_editor_settings( $settings ) {		$global_styles_presets = self::get_all_global_styles_presets();		if ( ! empty( $global_styles_presets ) ) {			if ( ! isset( $settings['styles'] ) ) {				$settings['styles'] = array();			} 			$settings['styles'][] = array(				// For the editor we can add all of the presets by default.				'assets'         => self::get_svg_definitions( $global_styles_presets ),				// The 'svgs' type is new in 6.3 and requires the corresponding JS changes in the EditorStyles component to work.				'__unstableType' => 'svgs',				// These styles not generated by global styles, so this must be false or they will be stripped out in wp_get_block_editor_settings.				'isGlobalStyles' => false,			); 			$settings['styles'][] = array(				// For the editor we can add all of the presets by default.				'css'            => self::get_global_styles_presets( $global_styles_presets ),				// This must be set and must be something other than 'theme' or they will be stripped out in the post editor <Editor> component.				'__unstableType' => 'presets',				// These styles are no longer generated by global styles, so this must be false or they will be stripped out in wp_get_block_editor_settings.				'isGlobalStyles' => false,			);		} 		return $settings;	}

Changelog

Introduced in 6.3.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/class-wp-duotone.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.