WP_Dependencies::add( string $handle, string|false $src, string[] $deps = array(), string|bool|null $ver = false, mixed $args = null ): bool

Description

Compatibility

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

Parameters

$handlestring

Name of the item. Should be unique.

$srcstring|false

Full URL of the item, or path of the item relative to the WordPress root directory. If source is set to false, the item is an alias of other items it depends on.

$depsstring[]optional

An array of registered item handles this item depends on.
Default empty array.Default: array()

$verstring|bool|nulloptional

String specifying item version number, if it has one, which is added to the URL as a query string for cache busting purposes.
If version is set to false, a version number is automatically added equal to current installed WordPress version.
If set to null, no version is added.Default: false

$argsmixedoptional

Custom property of the item. NOT the class property $args.
Examples: $media, $in_footer.Default: null

Return value

bool

Whether the item has been registered. True on success, false on failure.

Performance profile

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

9–36

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

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

Uses · 2

• _WP_Dependency::__construct()Setup dependencies.
• WP_Dependencies::enqueue()Queue an item or items.

Source code

View on Trac ↗View on GitHub ↗

281	public function add( $handle, $src, $deps = array(), $ver = false, $args = null ) {282		if ( isset( $this->registered[ $handle ] ) ) {283			return false;284		}285		$this->registered[ $handle ] = new _WP_Dependency( $handle, $src, $deps, $ver, $args );286 287		// If the item was enqueued before the details were registered, enqueue it now.288		if ( array_key_exists( $handle, $this->queued_before_register ) ) {289			if ( ! is_null( $this->queued_before_register[ $handle ] ) ) {290				$this->enqueue( $handle . '?' . $this->queued_before_register[ $handle ] );291			} else {292				$this->enqueue( $handle );293			}294 295			unset( $this->queued_before_register[ $handle ] );296		}297 298		return true;299	}

Changelog

Introduced in 2.1.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-dependencies.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.