WP_Scripts::add_data( string $handle, string $key, mixed $value ): bool
- Since
- 6.3.0
- Source
wp-includes/class-wp-scripts.php:866
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
$handlestring- Name of the item. Should be unique.
$keystring- The data key.
$valuemixed- The data value.
Return value
bool- True on success, false on failure.
Performance profile
How much work a call to WP_Scripts::add_data() 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
- Light
- Scaling
- Scales with input
- Instructions
- 7–46
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 176.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below WP_Scripts::add_data()
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 · 10 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Scripts::add_data() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!isset($handle) | 7 | none |
isset($handle) | 20–33 | ::add_data() |
isset($handle) && $key === "strategy" | 26–30 | ->is_delayed_strategy(), ::add_data() |
isset($handle) && $key !== "strategy" && $key === "fetchpriority" && ->is_valid_fetchpriority() | 28–33 | ->is_valid_fetchpriority(), ::add_data() |
isset($handle) && $key !== "strategy" && $key !== "fetchpriority" && $key === "module_dependencies" && !is_array($value) | 30–34 | __(), sprintf(), _doing_it_wrong() |
isset($handle) && $key === "strategy" && !empty($value) | 30–34 | ->is_delayed_strategy(), ->is_delayed_strategy(), ::add_data() |
isset($handle) && $key === "strategy" | 33–42 | ->is_delayed_strategy(), __(), sprintf(), _doing_it_wrong() |
isset($handle) && $key !== "strategy" && $key === "fetchpriority" | 35–45 | ->is_valid_fetchpriority(), __(), sprintf(), _doing_it_wrong() |
isset($handle) && $key !== "strategy" && $key !== "fetchpriority" && $key === "module_dependencies" && is_array($value) | 41–46 | __(), sprintf(), _doing_it_wrong(), ::add_data() |
isset($handle) && $key === "strategy" && !empty($value) && ->is_delayed_strategy() | 41–46 | ->is_delayed_strategy(), ->is_delayed_strategy(), __(), sprintf(), _doing_it_wrong() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 176 | 7–46 | 24 | |
| 8.5 | 176 | 7–46 | 24 | |
| 8.4 | 176 | 7–46 | 24 | |
| 8.3 | 176 | 7–46 | 24 | |
| 8.2 | 176 | 7–46 | 24 | |
| 8.1 | 176 | 7–46 | 24 | 4 fewer instructions than PHP 7.4 |
| 7.4 | 180 | 7–46 | 24 |
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 · 5
- _doing_it_wrong()Marks something as being incorrectly called.
- __()Retrieves the translation of $text.
- WP_Scripts::is_delayed_strategy()Checks if the strategy passed is a valid delayed (non-blocking) strategy.
- WP_Scripts::is_valid_fetchpriority()Checks if the provided fetchpriority is valid.
- WP_Dependencies::add_data()Add extra item data.
Used by · 2
- WP_Scripts::add_inline_script()Adds extra code to a registered script.
- WP_Scripts::localize()Localizes a script, only if the script has already been added.
Source code
public function add_data( $handle, $key, $value ) { if ( ! isset( $this->registered[ $handle ] ) ) { return false; } if ( 'conditional' === $key ) { // If a dependency is declared by a conditional script, remove it. $this->registered[ $handle ]->deps = array(); } if ( 'strategy' === $key ) { if ( ! empty( $value ) && ! $this->is_delayed_strategy( $value ) ) { _doing_it_wrong( __METHOD__, sprintf( /* translators: 1: $strategy, 2: $handle */ __( 'Invalid strategy `%1$s` defined for `%2$s` during script registration.' ), is_string( $value ) ? $value : gettype( $value ), $handle ), '6.3.0' ); return false; } elseif ( ! $this->registered[ $handle ]->src && $this->is_delayed_strategy( $value ) ) { _doing_it_wrong( __METHOD__, sprintf( /* translators: 1: $strategy, 2: $handle */ __( 'Cannot supply a strategy `%1$s` for script `%2$s` because it is an alias (it lacks a `src` value).' ), is_string( $value ) ? $value : gettype( $value ), $handle ), '6.3.0' ); return false; } } elseif ( 'fetchpriority' === $key ) { if ( empty( $value ) ) { $value = 'auto'; } if ( ! $this->is_valid_fetchpriority( $value ) ) { _doing_it_wrong( __METHOD__, sprintf( /* translators: 1: $fetchpriority, 2: $handle */ __( 'Invalid fetchpriority `%1$s` defined for `%2$s` during script registration.' ), is_string( $value ) ? $value : gettype( $value ), $handle ), '6.9.0' ); return false; } elseif ( ! $this->registered[ $handle ]->src ) { _doing_it_wrong( __METHOD__, sprintf( /* translators: 1: $fetchpriority, 2: $handle */ __( 'Cannot supply a fetchpriority `%1$s` for script `%2$s` because it is an alias (it lacks a `src` value).' ), is_string( $value ) ? $value : gettype( $value ), $handle ), '6.9.0' ); return false; } } elseif ( 'module_dependencies' === $key ) { if ( ! is_array( $value ) ) { _doing_it_wrong( __METHOD__, sprintf( /* translators: 1: 'module_dependencies', 2: Script handle. */ __( 'The value for "%1$s" must be an array for the "%2$s" script.' ), 'module_dependencies', $handle ), '7.0.0' ); return false; }Changelog
Introduced in 6.3.0. Unchanged from 6.7.7 through 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-scripts.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.