wp_lazy_loading_enabled( string $tag_name, string $context )
Determines whether to add the loading attribute to the specified tag in the specified context.
Parameters
- $tag_name
-
(string) (Required) The tag name.
- $context
-
(string) (Required) Additional context, like the current filter name or the function name from where this was called.
Return
(bool) Whether to add the attribute.
Source
File: wp-includes/media.php
function wp_lazy_loading_enabled( $tag_name, $context ) {
// By default add to all 'img' and 'iframe' tags.
// See https://html.spec.whatwg.org/multipage/embedded-content.html#attr-img-loading
// See https://html.spec.whatwg.org/multipage/iframe-embed-object.html#attr-iframe-loading
$default = ( 'img' === $tag_name || 'iframe' === $tag_name );
/**
* Filters whether to add the `loading` attribute to the specified tag in the specified context.
*
* @since 5.5.0
*
* @param bool $default Default value.
* @param string $tag_name The tag name.
* @param string $context Additional context, like the current filter name
* or the function name from where this was called.
*/
return (bool) apply_filters( 'wp_lazy_loading_enabled', $default, $tag_name, $context );
}
Expand full source code Collapse full source code View on Trac View on GitHub
Changelog
| Version | Description |
|---|---|
| 5.7.0 | Now returns true by default for iframe tags. |
| 5.5.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
wp_lazy_loading_enabledreturns true for alltags, which is every time this function is called by default. Hooking into thewp_lazy_loading_enabledfilter is the primary way of enabling or disabling this feature, however it does not readily allow this to be enabled or disabled for specific attachments or mime-types.1. To change how this feature works for specific attachments, the ‘loading’ attribute can be supplied to the
wp_get_attachment_imagefunction, or you can modify or remove the attribute using thewp_get_attachment_image_attributesfilter.Or
add_filter( 'wp_get_attachment_image_attributes', function( $attr, $attachment, $size ) { if ( $attachment->post_mime_type === 'image/svg+xml' ) { unset( $attr['loading'] ); } return $attr; } );2. To change how this works for specific avatars, you can either redefine the
get_avatarfunction, supply the ‘loading’ attribute within the ‘extra_attr’ argument, or replace the HTML using theget_avatarfilter.3.
the_content,the_excerptandwidget_text_filterswill call thewp_filter_content_tagsfilter on the content, which will also add the ‘loading’ attribute to image tags. To adjust this, thewp_img_tag_add_loading_attrfilter can be used to manage the ‘loading’ attribute on a tag by tag basis.