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

81–169

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

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 · 40 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 356 (+90 into the body)

   Filters the script loader source.

2. 2
   apply_filters( script_loader_src )filterline 412 (+146 into the body)

   Filters the script loader source.

3. 3
   apply_filters( script_loader_tag )filterline 441 (+175 into the body)

   Filters the HTML script tag of an enqueued script.

Uses · 17

• 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 ↗

266	public function do_item( $handle, $group = false ) {267		if ( ! parent::do_item( $handle ) ) {268			return false;269		}270 271		if ( 0 === $group && $this->groups[ $handle ] > 0 ) {272			$this->in_footer[] = $handle;273			return false;274		}275 276		if ( false === $group && in_array( $handle, $this->in_footer, true ) ) {277			$this->in_footer = array_diff( $this->in_footer, (array) $handle );278		}279 280		$obj = $this->registered[ $handle ];281 282		if ( null === $obj->ver ) {283			$ver = '';284		} else {285			$ver = $obj->ver ? $obj->ver : $this->default_version;286		}287 288		if ( isset( $this->args[ $handle ] ) ) {289			$ver = $ver ? $ver . '&amp;' . $this->args[ $handle ] : $this->args[ $handle ];290		}291 292		$src                   = $obj->src;293		$strategy              = $this->get_eligible_loading_strategy( $handle );294		$intended_strategy     = (string) $this->get_data( $handle, 'strategy' );295		$ie_conditional_prefix = '';296		$ie_conditional_suffix = '';297		$conditional           = isset( $obj->extra['conditional'] ) ? $obj->extra['conditional'] : '';298 299		if ( ! $this->is_delayed_strategy( $intended_strategy ) ) {300			$intended_strategy = '';301		}302 303		/*304		 * Move this script to the footer if:305		 * 1. The script is in the header group.306		 * 2. The current output is the header.307		 * 3. The intended strategy is delayed.308		 * 4. The actual strategy is not delayed.309		 * 5. All dependent scripts are in the footer.310		 */311		if (312			0 === $group &&313			0 === $this->groups[ $handle ] &&314			$intended_strategy &&315			! $this->is_delayed_strategy( $strategy ) &&316			$this->are_all_dependents_in_footer( $handle )317		) {318			$this->in_footer[] = $handle;319			return false;320		}321 322		if ( $conditional ) {323			$ie_conditional_prefix = "<!--[if {$conditional}]>\n";324			$ie_conditional_suffix = "<![endif]-->\n";325		}326 327		$before_script = $this->get_inline_script_tag( $handle, 'before' );328		$after_script  = $this->get_inline_script_tag( $handle, 'after' );329 330		if ( $before_script || $after_script ) {331			$inline_script_tag = $ie_conditional_prefix . $before_script . $after_script . $ie_conditional_suffix;332		} else {333			$inline_script_tag = '';334		}335 336		/*337		 * Prevent concatenation of scripts if the text domain is defined338		 * to ensure the dependency order is respected.339		 */340		$translations_stop_concat = ! empty( $obj->textdomain );341 342		$translations = $this->print_translations( $handle, false );343		if ( $translations ) {344			$translations = wp_get_inline_script_tag( $translations, array( 'id' => "{$handle}-js-translations" ) );345		}

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.7.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.