WP_Script_Modules::enqueue( string $id, string $src = '', array $deps = array(), string|false|null $version = false )

Description

Compatibility

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

Parameters

$idstring

The identifier of the script module. Should be unique. It will be used in the final import map.

$srcstringoptional

Full URL of the script module, or path of the script module relative to the WordPress root directory. If it is provided and the script module has not been registered yet, it will be registered.Default: ''

$depsarrayoptional

List of dependencies. @type string|array ...$0 { An array of script module identifiers of the dependencies of this script module. The dependencies can be strings or arrays. If they are arrays, they need an id key with the script module identifier, and can contain an import key with either static or dynamic. By default, dependencies that don't contain an import key are considered static.Default: array()

• $idstring

  The script module identifier.

• $importstring

  Optional. Import type. May be either static or dynamic. Defaults to static. }

$versionstring|false|nulloptional

String specifying the script module version number. Defaults to false.
It is added to the URL as a query string for cache busting purposes. If $version is set to false, the version number is the currently installed WordPress version.
If $version is set to null, no version is added.Default: false

Performance profile

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

12–19

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

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_Script_Modules::enqueue() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• WP_Script_Modules::register()Registers the script module if no script module with that script module identifier has already been registered.

Source code

View on Trac ↗View on GitHub ↗

140	public function enqueue( string $id, string $src = '', array $deps = array(), $version = false ) {141		if ( isset( $this->registered[ $id ] ) ) {142			$this->registered[ $id ]['enqueue'] = true;143		} elseif ( $src ) {144			$this->register( $id, $src, $deps, $version );145			$this->registered[ $id ]['enqueue'] = true;146		} else {147			$this->enqueued_before_registered[ $id ] = true;148		}149	}

Changelog

Introduced in 6.5.0. One change between 6.7.10 and 7.1.3.

1. 6.7.10
2. 6.8.11
3. 6.9.10
4. 7.0.7
5. 7.1.3

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

About this page

Parsed data

Generated from the wordpress-develop 6.7.10 tag, from src/wp-includes/class-wp-script-modules.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.