wp_omit_loading_attr_threshold( bool $force = false ): int

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

$forcebooloptional

If set to true, the filter will be (re-)applied even if it already has been before.
Default false.Default: false

Return value

int

The number of content media elements to not lazy-load.

Performance profile

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

6–11

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

Plugin surface

1 hook

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

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 callbacksapply_filters()called directly

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

Hooks and filters fired · 1

One hook fires while wp_omit_loading_attr_threshold() runs, in this order:

1. 1
   apply_filters( wp_omit_loading_attr_threshold )filterline 6302 (+16 into the body)

   Filters the threshold for how many of the first content media elements to not lazy-load.

Uses · 1

• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 2

• wp_get_loading_attr_default()Gets the default value to use for a `loading` attribute on an element.
• wp_get_loading_optimization_attributes()Gets loading optimization attributes.

Source code

View on Trac ↗View on GitHub ↗

6286function wp_omit_loading_attr_threshold( $force = false ) {6287	static $omit_threshold;6288 6289	// This function may be called multiple times. Run the filter only once per page load.6290	if ( ! isset( $omit_threshold ) || $force ) {6291		/**6292		 * Filters the threshold for how many of the first content media elements to not lazy-load.6293		 *6294		 * For these first content media elements, the `loading` attribute will be omitted. By default, this is the case6295		 * for only the very first content media element.6296		 *6297		 * @since 5.9.06298		 * @since 6.3.0 The default threshold was changed from 1 to 3.6299		 *6300		 * @param int $omit_threshold The number of media elements where the `loading` attribute will not be added. Default 3.6301		 */6302		$omit_threshold = apply_filters( 'wp_omit_loading_attr_threshold', 3 );6303	}6304 6305	return $omit_threshold;6306}

Changelog

Introduced in 5.9.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.0.4 tag, from src/wp-includes/media.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.