wp_enqueue_code_editor( array $args ): array|false

Compatibility

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

Parameters

$argsarray

Args.

• $typestring

  The MIME type of the file to be edited.

• $filestring

  Filename to be edited. Extension is used to sniff the type. Can be supplied as alternative to $type param.

• $themeWP_Theme

  Theme being edited when on the theme file editor.

• $pluginstring

  Plugin being edited when on the plugin file editor.

• $codemirrorarray

  Additional CodeMirror setting overrides.

• $csslintarray

  CSSLint rule overrides.

• $jshintarray

  JSHint rule overrides.

• $htmlhintarray

  HTMLHint rule overrides.

Return value

array|false

Settings for the enqueued code editor, or false if the editor was not enqueued.

Performance profile

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

10–89

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

Plugin surface

1 hook

Third-party callbacks on 'wp_enqueue_code_editor' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksdo_action()called directly

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 · 11 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_enqueue_code_editor() runs, in this order:

1. 1
   do_action( wp_enqueue_code_editor )actionline 4307 (+63 into the body)

   Fires when scripts and styles are enqueued for the code editor.

Uses · 9

• is_user_logged_in()Determines whether the current visitor is a logged in user.
• wp_get_current_user()Retrieves the current user object.
• wp_get_code_editor_settings()Generates and returns code editor settings.
• wp_enqueue_script()Enqueues a script.
• wp_enqueue_style()Enqueues a CSS stylesheet.
• current_user_can()Returns whether the current user has the specified capability.
• wp_add_inline_script()Adds extra code to a registered script.
• wp_json_encode()Encodes a variable into JSON, with some confidence checks.
• do_action()Calls the callback functions that have been added to an action hook.

Used by · 2

• WP_Customize_Code_Editor_Control::enqueue()Enqueue control related scripts/styles.
• WP_Widget_Custom_HTML::enqueue_admin_scripts()Loads the required scripts and styles for the widget control.

Source code

View on Trac ↗View on GitHub ↗

4244function wp_enqueue_code_editor( $args ) {4245	if ( is_user_logged_in() && 'false' === wp_get_current_user()->syntax_highlighting ) {4246		return false;4247	}4248 4249	$settings = wp_get_code_editor_settings( $args );4250 4251	if ( empty( $settings ) || empty( $settings['codemirror'] ) ) {4252		return false;4253	}4254 4255	wp_enqueue_script( 'code-editor' );4256	wp_enqueue_style( 'code-editor' );4257 4258	if ( isset( $settings['codemirror']['mode'] ) ) {4259		$mode = $settings['codemirror']['mode'];4260		if ( is_string( $mode ) ) {4261			$mode = array(4262				'name' => $mode,4263			);4264		}4265 4266		if ( ! empty( $settings['codemirror']['lint'] ) ) {4267			switch ( $mode['name'] ) {4268				case 'css':4269				case 'text/css':4270				case 'text/x-scss':4271				case 'text/x-less':4272					wp_enqueue_script( 'csslint' );4273					break;4274				case 'htmlmixed':4275				case 'text/html':4276				case 'php':4277				case 'application/x-httpd-php':4278				case 'text/x-php':4279					wp_enqueue_script( 'htmlhint' );4280					wp_enqueue_script( 'csslint' );4281					if ( ! current_user_can( 'unfiltered_html' ) ) {4282						wp_enqueue_script( 'htmlhint-kses' );4283					}4284					break;4285				case 'javascript':4286				case 'application/ecmascript':4287				case 'application/json':4288				case 'application/javascript':4289				case 'application/ld+json':4290				case 'text/typescript':4291				case 'application/typescript':4292					wp_enqueue_script( 'jsonlint' );4293					break;4294			}4295		}4296	}4297 4298	wp_add_inline_script( 'code-editor', sprintf( 'jQuery.extend( wp.codeEditor.defaultSettings, %s );', wp_json_encode( $settings, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ) ) );4299 4300	/**4301	 * Fires when scripts and styles are enqueued for the code editor.4302	 *4303	 * @since 4.9.04304	 *4305	 * @param array $settings Settings for the enqueued code editor.4306	 */4307	do_action( 'wp_enqueue_code_editor', $settings );4308 4309	return $settings;4310}

Changelog

Introduced in 4.9.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/general-template.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.