innocode-digital/wp-hybrid-lazy-loading

A Progressive Migration To Native Lazy Loading.

1.3.2 2021-02-09 15:03 UTC

Requires

• php: >=7.0
• ext-dom: *
• ext-libxml: *
• ext-mbstring: *
• composer/installers: ~1.0

GPL-2.0-or-later

• Innocode
• Viktor Kuliebiakin

README

Description

A Progressive Migration To Native Lazy Loading.

The idea of plugin is to use Native Lazy Loading when browser supports it and for all others implements lazy loading through lazysizes library that loads only when needed.

Plugin adds loading attribute for all attachments, oEmbed iframes, images and iframes that are inserted to content through editor, also CSS class lazyload adds to those elements as well as data-src, data-srcset and data-sizes are created from corresponding attributes.

Installation

Clone this repo to wp-content/plugins/:

cd wp-content/plugins/
git clone [e-mail]:innocode-digital/wp-hybrid-lazy-loading.git

or use Composer for that.

Activate Hybrid Lazy Loading from Plugins page or WP-CLI: wp plugin activate wp-hybrid-lazy-loading.

Documentation

By default plugin loads lazysizes lazily, which means only for ones that are w/o Native Lazy Loading support but it's possible to change this behaviour with filter:

add_filter( 'innocode_wp_hybrid_lazy_loading_lazy_enqueue_lazysizes', '__return_false' ); // Default is "true"

It makes sense when e.g. lazysizes is using also for other functionality.

By default CSS class "lazyload" removes from elements in browsers with Native Lazy Loading support but it's possible to change this behaviour with filter:

add_filter( 'innocode_wp_hybrid_lazy_loading_force_use_lazysizes', '__return_true' ); // Default is "false"

It makes sense when e.g. it's needed to use lazysizes CSS classes that are adding to element during loading process in all browsers.

By default all attachments are loading lazily but it's possible to change this behaviour with filter:

add_filter( 'innocode_wp_hybrid_lazy_loading_attachment_loading', function ( $type, $attachment_id ) {
    $type = 'eager'; // Default is "lazy"
    
    return $type;
}, 10, 2 );

It makes sense when e.g. featured image should be loaded immediately.

If there are images and iframes that are rendered in PHP code of theme or plugin and they should be loaded lazily, it's possible to use next methods:

/**
 * Adds "loading" attribute and "lazyload" CSS class to images in HTML code
 *
 * @param string $html
 * @return string
 */
\Innocode\WPHybridLazyLoading\DOM::images( $html );

/**
 * Adds "loading" attribute and "lazyload" CSS class to iframes in HTML code
 *
 * @param string $html
 * @return string
 */
\Innocode\WPHybridLazyLoading\DOM::iframes( $html );

/**
 * Adds "loading" attribute and "lazyload" CSS class to elements in HTML code by tag
 *
 * @param string $tag
 * @param string $html
 * @return string
 */
\Innocode\WPHybridLazyLoading\DOM::elements( $tag, $html );