wp_img_tag_add_loading_attr() – Function

Adds loading attribute to an img HTML tag.

Description

Parameters

$imagestringrequired: The HTML img tag where the attribute should be added.
$contextstringrequired: Additional context to pass to the filters.

Return

string Converted img tag with loading attribute added.

Source

function wp_img_tag_add_loading_attr( $image, $context ) {
	_deprecated_function( __FUNCTION__, '6.3.0', 'wp_img_tag_add_loading_optimization_attrs()' );
	/*
	 * Get loading attribute value to use. This must occur before the conditional check below so that even images that
	 * are ineligible for being lazy-loaded are considered.
	 */
	$value = wp_get_loading_attr_default( $context );

	// Images should have source and dimension attributes for the `loading` attribute to be added.
	if ( ! str_contains( $image, ' src="' ) || ! str_contains( $image, ' width="' ) || ! str_contains( $image, ' height="' ) ) {
		return $image;
	}

	/** This filter is documented in wp-admin/includes/media.php */
	$value = apply_filters( 'wp_img_tag_add_loading_attr', $value, $image, $context );

	if ( $value ) {
		if ( ! in_array( $value, array( 'lazy', 'eager' ), true ) ) {
			$value = 'lazy';
		}

		return str_replace( '<img', '<img loading="' . esc_attr( $value ) . '"', $image );
	}

	return $image;
}

View all references View on Trac View on GitHub

Uses	Description
wp_get_loading_attr_default()`wp-includes/deprecated.php`	Gets the default value to use for a `loading` attribute on an element.
esc_attr()`wp-includes/formatting.php`	Escaping for HTML attributes.
_deprecated_function()`wp-includes/functions.php`	Marks a function as deprecated and inform when it has been used.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 2 more Show less

Changelog

Version	Description
6.3.0	Use wp_img_tag_add_loading_optimization_attrs() instead.
5.5.0	Introduced.

User Contributed Notes

Lukasz 3 years ago

If you want to remove loading attribute from specific images.

add_filter( 'wp_img_tag_add_loading_attr', 'skip_lazy_load', 10, 3 );

function skip_lazy_load( $value, $image, $context ) {

if ( 'the_content' === $context ) {
	// Check if needle found https://www.php.net/manual/en/function.strpos.php
	if ( false !== strpos( $image, 'hero-image.png' ) ) {
		return false; // Set to false so lazy loading attribute is omitted.
	}
}
return $value;
}

wp_img_tag_add_loading_attr( string $image, string $context ): string

In this article

Description

See also

Parameters

Return

Source

Changelog

User Contributed Notes