automattic/jetpack-lazy-images

Speed up your site and create a smoother viewing experience by loading images as visitors scroll down the screen, instead of all at once. Modern browsers now support lazy loading, and WordPress itself bundles lazy loading features for images and videos. This feature will consequently be deprecated i

v3.0.0 2024-02-07 20:38 UTC

Requires

• php: >=7.0
• automattic/jetpack-assets: ^2.1.0
• automattic/jetpack-constants: ^2.0.0
• automattic/jetpack-status: ^2.1.0

Requires (Dev)

• automattic/jetpack-changelogger: ^4.1.0
• automattic/wordbless: dev-master
• yoast/phpunit-polyfills: 1.1.0

Suggests

• automattic/jetpack-autoloader: Allow for better interoperability with other plugins that use this package.

GPL-2.0-or-later

README

Speed up your site and create a smoother viewing experience by loading images as visitors scroll down the screen, instead of all at once.

Usage

/*
 * Initialize lazy images on the wp action so that conditional
 * tags are safe to use.
 *
 * As an example, this is important if a theme wants to disable lazy images except
 * on single posts, pages, or attachments by short-circuiting lazy images when
 * is_singular() returns false.
 *
 * See: https://github.com/Automattic/jetpack/issues/8888
 */

add_action( 'wp', array( 'Automattic\\Jetpack\\Jetpack_Lazy_Images', 'instance' ) );

Development

Running tests requires working svn, composer and pnpm commands.

Once these are installed, you install the composer dependencies by running:

$ composer install --ignore-platform-reqs

Generate minified JavaScript

The JavaScript file can be minified from the root of the Jetpack repository:

$ cd ../../
$ pnpm build-packages

Run PHP unit tests

On a local development environment run:

$ composer phpunit

Lint PHP source code

The PHP code can be linted from the root of the Jetpack repository:

$ cd ../../
$ composer phpcs:compatibility packages/lazy-images
$ composer phpcs:lint packages/lazy-images

Using this package in your WordPress plugin

If you plan on using this package in your WordPress plugin, we would recommend that you use Jetpack Autoloader as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.

Security

Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.

License

jetpack-lazy-images is licensed under GNU General Public License v2 (or later)