weltpixel

Guide for Lazy Load Products and Images for Magento 2

This extension is also included in the Pearl Theme.

1 MINUTE INSTALLATION GUI.

  • Step 1:
    Before installing please check the extension compatibility. This extension is currently compatible with the following Magento versions 2.0.X. - 2.4.7-p3. It is recommended to install the extension first on a testing server before you install it on a live (production) server.
  • Step 2:
    Copy the extension files to below paths of your magento 2 instance. If ‘app/code/WeltPixel’ folder is missing, please create it manually:
    app/code/WeltPixel/Backend
    app/code/WeltPixel/LazyLoading


    • Optional
    Copy the extension files into the below path of your Magento 2 instance. If the ‘app/code/WeSupply’ folder is missing, please create it manually:
    app/code/WeSupply/Toolbox

  • Step 3:
    Copy the installation GUI folder 'weltpixel-extension-installation' in the root of your Magento installation. In some Magento configurations the public root folder may be under 'pub' directory.
    www.yourmagentostore.com/weltpixel-extension-installation/
  • Step 4:
    In your browser go to www.yourmagentostore.com/weltpixel-extension-installation/ and simply follow the installation steps from the graphical interface, presented in your browser. See the installation video: 1 Minute Module Installation via browser GUI.
  • Step 5:
    Wooohooo! The extension is now installed on your Magento store! Congrats!

Troubleshooting

If you experienced any issues or limitations with this quick GUI installation, see also SSH Installation below. SSH installation does the same thing but you are required to issue the commands step by step via CLI. Some servers may have high security configurations and may limit the functionality of this GUI Installer.

How to Install via SSH.

  • Step 1:
    Before installing Lazy Loading for Magento 2 store please check the extension compatibility. This extension is currently compatible with the following Magento versions 2.0.X. - 2.4.7-p3. It is recommended to install the extension first on a testing server before you install it on a live (production) server.
  • Step 2:
    Copy the extension files to below paths of your magento 2 instance. If ‘app/code/WeltPixel’ folder is missing, please create it manually:
    app/code/WeltPixel/Backend
    app/code/WeltPixel/LazyLoading


    • Optional
    Copy the extension files into the below path of your Magento 2 instance. If the ‘app/code/WeSupply’ folder is missing, please create it manually:
    app/code/WeSupply/Toolbox

  • Step 3:
    Access the root of your magento 2 project from command line and run the following commands:
    php bin/magento module:enable WeltPixel_Backend --clear-static-content
    php bin/magento module:enable WeltPixel_LazyLoading --clear-static-content
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy -f
  • Step 4:
    Flush any cache that you might still have enabled on your server or in Magento.
  • Step 5:
    Woohoo, the extension is installed!

How to Upgrade the extension.

  • Step 1. Remove extension code under app/code/WeltPixel/LazyLoading before adding the new extension files. The extension may be refactored and old unused files may cause random issues so it's best to only keep the latest version of the files.
  • Step 2. Follow normal installation instructions above.

Magento Marketplace Installation.

HOW TO USE THE EXTENSION.

Quick Setup.

After installing the extension is it enough to Enable it from Magento Admin > WeltPixel > Lazy Loading > Enable [ Yes / No ] and the lazy loading functionality will apply out of the box for:

  • Listing pages.
  • Search pages.
  • Product pages.
  • Related, cross sell, up sell products.
weltpixel
weltpixel

Advanced Setup.

The PRO version of the module comes with an Advanced Feature: Start Loading Early. To enable this feature, head into Admin -> WeltPixel -> Lazy Loading Settings -> Advanced Settings -> Start Loading Early -> Yes.

  • Negative Margin - Insert a threshold at which images are loaded before they appear on the screen. For example, you can insert the value "300", and images will be loaded when they're at 300px from the viewport.
  • Effect Speed - Effect speed in milliseconds. Example: Insert 1000 to get an animation speed of 1 second.
  • Loading Placeholder - This option enables you to upload your own image instead of the default Lazy Loading placeholder.
  • Placeholder Width - Allows you to set a width for the placeholder image. Example: Set the value to 50 for a width of 50px.

Enhanced Setup.

    You can enhance default configuration by easily adding lazy load functionality to images in your store. Please note that the class will not apply to images that were originally hidden or images in elements with a display:none property.

  • 1. Add the html class "lazy" to the img element
  • 2. Add the html data-original attribute with the path to the image
  • 3. Add a image in "src" attribute which will be displayed before the image loads, usually it's a gif animated image. Below is a full example: 
    •             <img class="lazy" src="path/to/loader-image/loading.gif" data-original="path/to/image/image.jpg" alt="">
weltpixel

Change Log.

What’s new in v.1.14.9 - November 26, 2024

  • Added minor Magento Admin adjustments to the module status section for increased clarity and compatibility with server-side Social Pixel addons.


What’s new in v.1.14.7 - October 11, 2024

  • Compatibility: Introduced compatibility with the latest Magento 2.4.7-p3, 2.4.6-p8, 2.4.5-p10 and 2.4.4-p11 versions, which come with critical security adjustments for the platform. Magento 2 merchants are urged to upgrade to the latest patches ASAP.
  • Added various code updates for increased security around the licensing functionality as well as the Help Center and WeltPixel Developer Magento Admin sections.


What’s new in v.1.14.5 - August 23, 2024

  • Compatibility: Introduced compatibility with the latest Magento 2.4.7-p2, 2.4.6-p7, 2.4.5-p9 and 2.4.4-p10 versions, which come with critical security adjustments for the platform. Magento 2 merchants are urged to upgrade to the latest patches ASAP.
  • Added an optimization to the extension's code which aligns the module's extended ImageFactory.php file with the core Magento equivalent to prevent potential errors.


What’s new in v.1.14.3 - June 20, 2024

  • Compatibility: Introduced compatibility with the latest Magento 2.4.7-p1, 2.4.6-p6, 2.4.5-p8, 2.4.4-p9 versions, which come with critical security adjustments for the platform. Magento 2 merchants are urged to upgrade to the latest patches ASAP.
  • New Feature: Added a new section in the Magento Admin that checks to make sure the latest product version is installed and notifies in case an update is available, as well as a button that allows for new features to be requested.


What’s new in v.1.14.1 - April 19, 2024

  • Confirmed compatibility with the latest Magento 2.4.7 release, as well as newly released 2.4.6-p5, 2.4.5-p7 & 2.4.4-p8 Security Patches.
  • Confirmed compatibility with PHP 8.3 on the Magento 2.4.7 release. PHP 8.2 is also supported for this Magento version.
  • Added security improvements to the Backend module's license verification process.


What’s new in v.1.11.21 - January 9, 2024

  • Fixed an error that would be thrown in the WeltPixel -> Extensions Version admin section when a module's composer.json file was missing the version node.


What’s new in v.1.11.19 - October 19, 2023

  • Optimized the license verification process for increased Magento Admin performance, as well as to account for licensing server downtimes.
  • Fixed an issue that would sometimes result in an error being thrown when using older PHP versions, such as PHP 7.4.
  • Confirmed compatibility with the newly released Magento 2.4.6-p3, 2.4.5-p5, and 2.4.4-p6 Security Patches.


What’s new in v.1.11.17 - June 28, 2023

  • Confirmed compatibility with the latest Magento Security Patch releases 2.4.6-p1, 2.4.5-p3 and 2.4.4-p4.
  • Fixed an error related to PHP 8.2 that would show when accessing the WeltPixel Debugger.
  • Added .localdev as a universally accepted licensing domain.


What’s new in v.1.11.15 - March 22, 2023

  • Fixed an error that would sometimes be thrown in the WeltPixel Debugger, depending on various server permissions.
  • Added compatibility with the latest Magento 2.4.6 and 2.4.5-p2 versions.


What’s new in v.1.11.11 - November 23, 2022

  • Confirmed compatibility with the latest Magento Security Patch releases 2.4.5-p1 and 2.4.4-p2.


What’s new in v.1.11.7 - September 1, 2022

  • Confirmed compatibility with the latest Magento 2.4.5 and 2.4.4-p1 versions.
  • Updated installation/upgrade scripts to use data patches.


What’s new in v.1.11.1 - April 25, 2022

  • Fixed an incorrect licensing message on B2B Magento Enterprise instances which would display when an invalid license was entered.
  • Confirmed compatibility with the latest Magento 2.4.4 and 2.3.7-p3 versions as well as PHP 8.1.


What’s new in v.1.10.17 - October 22, 2021

  • Confirmed compatibility with the latest Magento 2.4.3-p1 and 2.3.7-p2 versions.


What’s new in v.1.10.15 - August 31, 2021

  • Confirmed compatibility with the newly released Magento 2.4.3, 2.4.2-p2 and 2.3.7-p1 versions.
  • Added .localhost as an accepted domain termination for the licensing process.


What’s new in v.1.10.11 - July 7, 2021

  • Added improvments to the WeltPixel Developer Magento Admin section. Latest Cron Jobs now lists the last 100 executed Cron Jobs.


What’s new in v.1.10.9 - May 18, 2021

  • Confirmed compatibility with the newly released Magento 2.3.7 and 2.4.2-p1 versions.


What’s new in v.1.10.7 - March 26, 2021

  • Excluded Magento 2.0.x - 2.2.x from new features and fixes starting with this release.
  • Adjusted WeltPixel Developer section comments.


What’s new in v.1.10.5 - February 12, 2021

  • Confirmed compatibility with the newly released Magento 2.4.2 version.
  • Added additional backend versioning verifications.
  • ackend module code optimizations.


What’s new in v.1.10.1 - October 22, 2020

  • Fixed an issue related to image rendering on Magento 2.4.x.
  • Confirmed compatibility with the newly released Magento 2.4.1 version.


What’s new in v.1.10.0 - August 10, 2020

  • Confirmed compatibility with the newly released Magento 2.4.0 version.


What’s new in v.1.9.8 - July 6, 2020

  • Whitelisted domain for Content Security Policies introduced in Magento 2.3.5.


What’s new in v.1.9.7 - May 7, 2020

  • Added the possibility of using Lazy Loading on Instagram Feeds (requires the Instagram Feed Widget extension).
  • Confirmed compatibility with Magento 2.3.5.
  • Implemented small Backend performance optimizations.
  • Added nxcli.net (Nexcess temporary URL) as a valid domain in the licensing process.
  • Added an option in the Developer section to allow for switching Magento's CSP between "report-only" and "restrict".


What’s new in v.1.9.6 - April 9, 2020

  • Code cleanup: removed a few duplicated functions.
  • Fixed a Backend issue on Magento Commerce whereby the Category Schedule functionality was not working properly.


What’s new in v.1.9.5 - March 10, 2020

  • Fixed a small incomatibility with Ajax Infinte Scroll that caused images to become small when switching pages.
  • Added backend Google reCaptcha compatibility for Magento 2.3.x


What’s new in v.1.9.4 - February 5, 2020

  • Code enhancements for increased security. Changed User Group info collection method.
  • Confirmed compatibility for Magento 2.3.4.


What’s new in v.1.9.3 - January 10, 2019

  • Released the PRO version of this extension, with 3 new features:
    • Start Loading Early
    • Animation Effect Speed
    • Custom Loading Placeholder


What’s new in v.1.9.2 - November 27, 2019

  • Added Magento and PHP version in the WeltPixel Developer section.


What’s new in v.1.9.1 - October 16, 2019

  • Confirmed compatibility with the latst Magento 2.3.3 version.
  • Included the WeSupply Toolbox integration extension - Proactive Notifications Email & SMS, Returns & RMA, Store Locator, Delivery Date Estimate, Logistics Analytics, NPS & CSAT score. Get Free on-boarding and launch within 24 hours.


What’s new in v.1.9.0 - July 18, 2019

  • Confirmed compatibility with Magento 2.3.2.
  • Added HTTPS endpoint for licensing process.


What’s new in v.1.8.5 - June 7, 2019

  • Small performance improvements.


What’s new in v.1.8.4 - April 25, 2019

  • Added PHP version in the WeltPixel Developer Section.


What’s new in v.1.8.3 - April 3rd, 2019

  • Confirmed compatibility for Magento 2.3.1.


What’s new in v.1.8.2 - January 24, 2019

  • Helpcenter adjustment, removed zendesk iframe and added a simple link to our Support Center in order to avoid any potential conflicts with other admin js added by 3rd party extensions.
  • Fix for multiple rewritten ImageFactory classes, rewrite check validity, rewrite checks optimizations.


What’s new in v.1.8.0 - December 8, 2018

  • Compatibility adjustments for Magento 2.1.16/2.2.7/2.3.0.
  • PHP 7.2 compatibility added.
  • As Magento 2.3 comes with major core changes, we have provided a different set of files in order to achieve the best performance on each version.


What’s new in v.1.7.5 - October 24, 2018

  • Added detailed error messages for invalid licenses for an easier identification of the cause.
  • License improvements, added *.magento.cloud as a valid test domain for Enterprise Cloud environments. Now both ‘magentosite.cloud’ and ‘magneto.cloud’ can be used for testing purpose with the production domain license.


What’s new in v.1.7.4 - September 25, 2018

  • Fixed bundle js error / production mode.
  • Fix for wishlist email templates lazyload image usage.
  • Admin menu styling to fit screen size 1366px.
  • Fix for production mode with merged JS - missing color pallet display now fixed.


What’s new in v.1.7.3 - August 23, 2018

  • License improvements, adding *.magento.cloud as a valid test domain.


What’s new in v.1.7.2 - August 2, 2018

  • Fixed admin random logout issue.
  • Licensing improvements, allowing 3 letter domain as valid domain.


What’s new in v.1.7.1 - July 12, 2018

  • Compatibility with Magento 2.2.5 both Open Source & Commerce Cloud B2B.
  • Added domain.test & [any_subdomain].domain.test to the list of valid urls for staging/development environments. Added domain validation with port number included for licensing purpose.
  • Added licensing compatibility with Magento B2B.


What’s new in v.1.7.0 - July 5, 2018

  • Remove request dependancy as already exist in parent, Magento 2.1.x compilation fix.
  • Compatibility notice message visibility update.
  • Added option to enable/disable WeltPixel admin notifications.
  • Show store and server related information under debugging tab: Magento Mode, Magento Edition, Server User, Magento Installation Path, Current server time, Latest cron jobs.
  • Added licensing, license key needs to be generated under weltpixel.com account for purchased product, based on domain name and added under your magento installation.


What’s new in v.1.6.4 - May 16, 2018

  • Compatibility with Magento 2.2.4, logger broken reference fix, changed to rewrite from plugin.
  • Added compatibility check notice, based on existing installed extensions notify admin if any compatibility modules are necessary to be installed.


What’s new in v.1.6.3 - April 10, 2018

  • Fix for cases when ajax loaded images with white source.


What’s new in v.1.6.0 - March 1st, 2018

  • Adding back fix for lazyload hover image on Pearl Theme category page.


What’s new in v.1.5.8 - January 12, 2018

  • Added version control for installed WeltPixel modules, including latest version check.
  • Fixed lazy load issues on IE browsers.
  • Fixed configurable product swatch filtered listing image change.



What’s new in v.1.5.7 - December 14, 2017

  • Added Support Center functionality in Magento Admin.
  • Added Debugger functionality, checks for rewrites and points potential issues.
  • Adding fix for lazyload and hover images mouse over image on page load issue.

What’s new in v.1.5.5 - October 20, 2017

  • Added fade loader functionality and image.
  • Added fade img for static pages lazy load.

What’s new in v.1.0.0 - October 6, 2017

  • Initial relese.
weltpixel