WP_Scripts::do_item( string $handle, int|false $group = false ): bool

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

The script's registered handle.

$groupint|falseoptional

Group level: level (int), no groups (false).
Default false.Default: false

Return value

bool

True on success, false on failure.

Performance profile

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

84–153

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

Plugin surface

2 hooks

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

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach option, cache, serialize, query 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 · 6 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 3

3 hooks fire while WP_Scripts::do_item() runs, in this order:

1. 1
   apply_filters( script_loader_src )filterline 374 (+94 into the body)

   Filters the script loader source.

2. 2
   apply_filters( script_loader_src )filterline 420 (+140 into the body)

   Filters the script loader source.

3. 3
   apply_filters( script_loader_tag )filterline 468 (+188 into the body)

   Filters the HTML script tag of an enqueued script.

Uses · 19

• wp_get_inline_script_tag()Constructs an inline script tag.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• _print_scripts()Prints scripts (internal use only)
• str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
• add_query_arg()Retrieves a modified URL query string.
• esc_url_raw()Sanitizes a URL for database or redirect usage.
• wp_get_script_tag()Formats `` loader tags.
• WP_Dependencies::do_item()Processes a dependency.
• WP_Scripts::get_eligible_loading_strategy()Gets the best eligible loading strategy for a script.
• WP_Scripts::get_data()
• WP_Scripts::is_delayed_strategy()Checks if the strategy passed is a valid delayed (non-blocking) strategy.
• WP_Scripts::are_all_dependents_in_footer()Checks whether all dependents of a given handle are in the footer.

Source code

View on Trac ↗View on GitHub ↗

280	public function do_item( $handle, $group = false ) {281		if ( ! parent::do_item( $handle ) ) {282			return false;283		}284 285		if ( 0 === $group && $this->groups[ $handle ] > 0 ) {286			$this->in_footer[] = $handle;287			return false;288		}289 290		if ( false === $group && in_array( $handle, $this->in_footer, true ) ) {291			$this->in_footer = array_diff( $this->in_footer, (array) $handle );292		}293 294		$obj = $this->registered[ $handle ];295		if ( $obj->extra['conditional'] ?? false ) {296			return false;297		}298 299		if ( null === $obj->ver ) {300			$ver = '';301		} else {302			$ver = $obj->ver ? $obj->ver : $this->default_version;303		}304 305		if ( isset( $this->args[ $handle ] ) ) {306			$ver = $ver ? $ver . '&' . $this->args[ $handle ] : $this->args[ $handle ];307		}308 309		$src               = $obj->src;310		$strategy          = $this->get_eligible_loading_strategy( $handle );311		$intended_strategy = (string) $this->get_data( $handle, 'strategy' );312 313		if ( ! $this->is_delayed_strategy( $intended_strategy ) ) {314			$intended_strategy = '';315		}316 317		/*318		 * Move this script to the footer if:319		 * 1. The script is in the header group.320		 * 2. The current output is the header.321		 * 3. The intended strategy is delayed.322		 * 4. The actual strategy is not delayed.323		 * 5. All dependent scripts are in the footer.324		 */325		if (326			0 === $group &&327			0 === $this->groups[ $handle ] &&328			$intended_strategy &&329			! $this->is_delayed_strategy( $strategy ) &&330			$this->are_all_dependents_in_footer( $handle )331		) {332			$this->in_footer[] = $handle;333			return false;334		}335 336		$before_script = $this->get_inline_script_tag( $handle, 'before' );337		$after_script  = $this->get_inline_script_tag( $handle, 'after' );338 339		if ( $before_script || $after_script ) {340			$inline_script_tag = $before_script . $after_script;341		} else {342			$inline_script_tag = '';343		}344 345		/*346		 * Prevent concatenation of scripts if the text domain is defined347		 * to ensure the dependency order is respected.348		 */349		$translations_stop_concat = ! empty( $obj->textdomain );350 351		$translations = $this->print_translations( $handle, false );352		if ( $translations ) {353			/*354			 * The sourceURL comment is not included by WP_Scripts::print_translations()355			 * when `$display` is `false` to prevent issues where the script tag contents are used356			 * by extenders for other purposes, for example concatenated with other script content.357			 *358			 * Include the sourceURL comment here as it would be when printed directly.359			 */

Changelog

Introduced in 2.6.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 6.9.7 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.