wp_omit_loading_attr_threshold( bool $force = false ): int
Gets the threshold for how many of the first content media elements to not lazy-load.
Contents
Description
This function runs the ‘wp_omit_loading_attr_threshold’ filter, which uses a default threshold value of 3.
The filter is only run once per page load, unless the $force
parameter is used.
Parameters
-
$force
bool Optional -
If set to true, the filter will be (re-)applied even if it already has been before.
Default:
false
Return
int The number of content media elements to not lazy-load.
Source
File: wp-includes/media.php
.
View all references
function wp_omit_loading_attr_threshold( $force = false ) {
static $omit_threshold;
// This function may be called multiple times. Run the filter only once per page load.
if ( ! isset( $omit_threshold ) || $force ) {
/**
* Filters the threshold for how many of the first content media elements to not lazy-load.
*
* For these first content media elements, the `loading` attribute will be omitted. By default, this is the case
* for only the very first content media element.
*
* @since 5.9.0
* @since 6.3.0 The default threshold was changed from 1 to 3.
*
* @param int $omit_threshold The number of media elements where the `loading` attribute will not be added. Default 3.
*/
$omit_threshold = apply_filters( 'wp_omit_loading_attr_threshold', 3 );
}
return $omit_threshold;
}
Hooks
-
apply_filters( 'wp_omit_loading_attr_threshold',
int $omit_threshold ) -
Filters the threshold for how many of the first content media elements to not lazy-load.
Changelog
Version | Description |
---|---|
5.9.0 | Introduced. |