wpseek.com
A WordPress-centric search engine for devs and theme authors



wp_omit_loading_attr_threshold › WordPress Function

Since5.9.0
Deprecatedn/a
› wp_omit_loading_attr_threshold ( $force = false )
Parameters:
  • (bool) $force Optional. If set to true, the filter will be (re-)applied even if it already has been before. Default false.
    Required: No
    Default: false
Returns:
  • (int) The number of content media elements to not lazy-load.
Defined at:
Codex:

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

This function runs the {@see '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.


Related Functions: wp_get_loading_attr_default, wp_img_tag_add_loading_attr, wp_iframe_tag_add_loading_attr, wp_get_loading_optimization_attributes, wp_lazy_loading_enabled

Source 

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;
}