_wp_scripts_add_args_data( WP_Scripts $wp_scripts, string $handle, array $args )

Compatibility

Present in 2 of the 5 tracked releases, added in 7.0.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$wp_scriptsWP_Scripts

WP_Scripts instance.

$handlestring

Script handle.

$argsarray

Array of extra args for the script.

Performance profile

How much work a call to _wp_scripts_add_args_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

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

23–130

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

Plugin surface

None

Nothing here hands control to plugin code.

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()one call below _wp_scripts_add_args_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 · 18 distinct outcomes

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

Uses · 3

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• wp_get_list_item_separator()Retrieves the list item separator based on the locale.

Used by · 2

• wp_enqueue_script()Enqueues a script.
• wp_register_script()Registers a new script.

Source code

View on Trac ↗View on GitHub ↗

92function _wp_scripts_add_args_data( WP_Scripts $wp_scripts, string $handle, array $args ): void {93	$allowed_keys = array( 'strategy', 'in_footer', 'fetchpriority', 'module_dependencies' );94	$unknown_keys = array_diff( array_keys( $args ), $allowed_keys );95	if ( ! empty( $unknown_keys ) ) {96		$trace         = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS, 2 );97		$function_name = ( $trace[1]['class'] ?? '' ) . ( $trace[1]['type'] ?? '' ) . ( $trace[1]['function'] ?? __FUNCTION__ );98		_doing_it_wrong(99			$function_name,100			sprintf(101				/* translators: 1: $args, 2: List of unrecognized keys, 3: List of supported keys. */102				__( 'Unrecognized key(s) in the %1$s param: %2$s. Supported keys: %3$s' ),103				'$args',104				implode( wp_get_list_item_separator(), $unknown_keys ),105				implode( wp_get_list_item_separator(), $allowed_keys )106			),107			'7.0.0'108		);109	}110 111	$in_footer = ! empty( $args['in_footer'] );112	if ( $in_footer ) {113		$wp_scripts->add_data( $handle, 'group', 1 );114	}115	if ( ! empty( $args['strategy'] ) ) {116		$wp_scripts->add_data( $handle, 'strategy', $args['strategy'] );117	}118	if ( ! empty( $args['fetchpriority'] ) ) {119		$wp_scripts->add_data( $handle, 'fetchpriority', $args['fetchpriority'] );120	}121	if ( ! empty( $args['module_dependencies'] ) ) {122		$wp_scripts->add_data( $handle, 'module_dependencies', $args['module_dependencies'] );123 124		/*125		 * A classic script with module dependencies must either be printed in the126		 * footer or use the 'defer' loading strategy. Otherwise, the script may be127		 * evaluated before the script modules import map is printed, causing128		 * dynamic imports to fail with a "Failed to resolve module specifier" error.129		 */130		$is_deferred = 'defer' === ( $args['strategy'] ?? null );131		if ( ! $in_footer && ! $is_deferred ) {132			$trace         = debug_backtrace( DEBUG_BACKTRACE_IGNORE_ARGS, 2 );133			$function_name = ( $trace[1]['class'] ?? '' ) . ( $trace[1]['type'] ?? '' ) . ( $trace[1]['function'] ?? __FUNCTION__ );134			_doing_it_wrong(135				$function_name,136				sprintf(137					/* translators: 1: 'module_dependencies', 2: Script handle, 3: 'in_footer', 4: 'strategy', 5: 'defer'. */138					__( 'When the %1$s arg is provided, the "%2$s" script must either be printed in the footer (%3$s set to true) or use a deferred loading %4$s (%5$s) so that the import map is printed before the script is evaluated.' ),139					'<code>module_dependencies</code>',140					$handle,141					'<code>in_footer</code>',142					'<code>strategy</code>',143					'<code>defer</code>'144				),145				'7.0.0'146			);147		}148	}149}

Changelog

Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

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

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/functions.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.