wppaste
WordPress

wp_check_widget_editor_deps()

Since
5.8.0
Source
wp-includes/widgets.php:2108
Displays a _doing_it_wrong() message for conflicting widget editor scripts.

Description

The 'wp-editor' script module is exposed as window.wp.editor. This overrides the legacy TinyMCE editor module which is required by the widgets editor.
Because of that conflict, these two shouldn't be enqueued together.
See https://core.trac.wordpress.org/ticket/53569.

There is also another conflict related to styles where the block widgets editor is hidden if a block enqueues 'wp-edit-post' stylesheet.
See https://core.trac.wordpress.org/ticket/53569.

Compatibility

WordPress
since 5.8.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.

Performance profile

How much work a call to wp_check_widget_editor_deps() 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
Heavy

Reaches the database via ->query().

Scaling
Constant

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

Instructions
13–51

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

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 it touches

  • sqldatabase query->query()called directly
  • hookthird-party callbacksdo_action()one call below wp_check_widget_editor_deps()

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 9 distinct outcomes

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

WhenInstructionsCalls it makes
!->query()13->query(), ->query()
always18->query(), ->query(), ->query()
always23->query(), ->query(), ->query(), ->query()
always32->query(), ->query(), ->query(), __(), sprintf(), _doing_it_wrong()
always32->query(), ->query(), __(), sprintf(), _doing_it_wrong(), ->query()
always37->query(), ->query(), ->query(), ->query(), __(), sprintf(), _doing_it_wrong()
always37->query(), ->query(), ->query(), __(), sprintf(), _doing_it_wrong(), ->query()
->query()46->query(), ->query(), __(), sprintf(), _doing_it_wrong(), ->query(), __(), sprintf(), _doing_it_wrong()
always51->query(), ->query(), ->query(), __(), sprintf(), _doing_it_wrong(), ->query(), __(), sprintf(), _doing_it_wrong()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 51 instructions, 13–51 executed per call, 4 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 · 2

Source code

function wp_check_widget_editor_deps() {	global $wp_scripts, $wp_styles; 	if (		$wp_scripts->query( 'wp-edit-widgets', 'enqueued' ) ||		$wp_scripts->query( 'wp-customize-widgets', 'enqueued' )	) {		if ( $wp_scripts->query( 'wp-editor', 'enqueued' ) ) {			_doing_it_wrong(				'wp_enqueue_script()',				sprintf(					/* translators: 1: 'wp-editor', 2: 'wp-edit-widgets', 3: 'wp-customize-widgets'. */					__( '"%1$s" script should not be enqueued together with the new widgets editor (%2$s or %3$s).' ),					'wp-editor',					'wp-edit-widgets',					'wp-customize-widgets'				),				'5.8.0'			);		}		if ( $wp_styles->query( 'wp-edit-post', 'enqueued' ) ) {			_doing_it_wrong(				'wp_enqueue_style()',				sprintf(					/* translators: 1: 'wp-edit-post', 2: 'wp-edit-widgets', 3: 'wp-customize-widgets'. */					__( '"%1$s" style should not be enqueued together with the new widgets editor (%2$s or %3$s).' ),					'wp-edit-post',					'wp-edit-widgets',					'wp-customize-widgets'				),				'5.8.0'			);		}	}}

Changelog

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.0.4 tag, from src/wp-includes/widgets.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.