wp_img_tag_add_loading_attr() │ WP 5.5.0

Adds loading attribute to an img HTML tag.

Return

String. Converted img tag with loading attribute added.

Usage

wp_img_tag_add_loading_attr( $image, $context );

$image(string) (required)

The HTML img tag where the attribute should be added.

$context(string) (required)

Additional context to pass to the filters.

Notes

• See: wp_img_tag_add_loading_optimization_attrs()

Changelog

wp_img_tag_add_loading_attr() wp img tag add loading attr code ^{WP 6.7.1}

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