weltpixel

Guide for Magento 2 Product Labels - New, Sale, Discount Sticker.

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.6-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/ProductLabels


    • 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 Magento 2 Product Labels, please check the extension compatibility. This extension is currently compatible with the following Magento versions: 2.0.X. - 2.4.6-p3. It is recommended to install the extension on a testing server before installing it on a live (production) server.
  • Step 2.
    Copy the extension files to below paths of your magento 2 instance. If the ‘app/code/WeltPixel’ folder is missing, please create it manually:
    app/code/WeltPixel/Backend
    app/code/WeltPixel/ProductLabels


    • 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_ProductLabels --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/ProductLabels 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.

CONFIGURATION.

GENERAL SETTINGS.

    Go to Admin > WeltPixel > Product Labels > General Settings

    • Enable on product listing [Yes / No] - Enable/Disable Product Labels on Category Pages.
    • Display Mode [Always / On Hover] - Choose whether Product Labels are only displayed on Hover or Always.
    • Enable on Product Page [Yes / No] - Enable/Disable Product Labels on Product Pages.
    • Enable for Product Widgets - Enable/Disable Product Labels for Product Widgets.
    • Enable on Related Products - Enable/Disable Product Labels for Related Products.
    • Enable on Upsell Products - Enable/Disable Product Labels for Upsell Products.
    • Enable on Cross-Sell Products - Enable/Disable Product Labels for Cross-Sell Products.
weltpixel
weltpixel

Manage/Add Product Labels.

    Go to Admin > WeltPixel > Product Labels > Manage Labels

    • To manage an existing label, under the Action column, click on Select -> Edit.
    • To add a new label, click Add New Product Label in the top right corner.

Adding a new Product Label.

General.

    Go to Admin > WeltPixel > Product Labels > Magage Labels > Add New Label

    • Title - Set the current label title. Not visible in the frontend. Only for admin purposes.
    • Priority - Use 0 for high priority, and 99 for low priority. Applicable only to labels that are on the same position as other labels.
    • Status [Active / Inactive] - Set current label status.
    • Valid From - Set start validity date and time.
    • Valid To - Set end validity date and time.
    • Store View - Choose Store View to display the label on.
    • Customer Group - Choose Customer Group to display label for.
weltpixel
weltpixel

Product Page.

    • Label Text - Insert text for label.

      A set of variables can be used in order to create dynamic labels. The following variables are available: {NL} - for new line, {DAYSLEFT} - days left for current label, {PRICE} - for product price, {SPECIAL_PRICE} - for product special prices, {DISCOUNT_PERCENT} - for product discount, in percent, {DISCOUNT_AMOUNT} - for product discount, as absolute value , {SKU} - for product SKU, {QTY} - for product stock Qty.

      Example: {DISCOUNT_PERCENT} OFF - Save ${DISCOUNT_AMOUNT}

    • Text Font Color - Choose a font color for the label text.
    • Text Background Color - Choose a background color for the label.
    • Text Font Size - Choose a font size for the label's text.
    • Text Padding - Choose padding values.
    • Preview - Check out what the label would look like in the frontend.
    • Custom CSS - Add your own Custom CSS to the label.
    • Image - Upload your own image for the label. Uploading an image overrides text. To remove an image, simply click on the trash can icon in the bottom left corner.
    • Position - Choose where you want the label to be displayed.

Category Page.

    • Label Text - Insert text for label.

      A set of variables can be used in order to create dynamic labels. The following variables are available: {NL} - for new line, {DAYSLEFT} - days left for current label, {PRICE} - for product price, {SPECIAL_PRICE} - for product special prices, {DISCOUNT_PERCENT} - for product discount, in percent, {DISCOUNT_AMOUNT} - for product discount, as absolute value , {SKU} - for product SKU, {QTY} - for product stock Qty.

      Example: {DISCOUNT_PERCENT} OFF - Save ${DISCOUNT_AMOUNT}

    • Text Font Color - Choose a font color for the label text.
    • Text Background Color - Choose a background color for the label.
    • Text Font Size - Choose a font size for the label's text.
    • Text Padding - Choose padding values.
    • Preview - Check out what the label would look like in the frontend.
    • Custom CSS - Add your own Custom CSS to the label.
    • Image - Upload your own image for the label. Uploading an image overrides text. To remove an image, simply click on the trash can icon in the bottom left corner.
    • Position - Choose where you want the label to be displayed.
weltpixel
weltpixel

Conditions.

  • Allows for customization of conditions that must be met must be met before the Product Labels are visible on the frontend. If left blank, the labels are applied to all products.

  • Note: Normally, the labels should show up automatically after the save. However, depending on the conditions configured, if you encounter cases in which the labels don't show up, just run the command below to manually trigger the label reindex:

    • php bin/magento indexer:reindex weltpixel_products_labels_rule

Troubleshooting.

  • If you enable/disable the module and in the Magento Admin, the Index Management page is broken (showcased in the image on the right), you need to run the following command in the CLI: 
    • php bin/magento indexer:reset
weltpixel
weltpixel

Change Log.

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

  • New Feature: Added a new functionality that allows for duplicating an existing Product Label, with all the current settings/configuration options, via the Product Labels Grid.
  • Added various optimizations for ADA compliance to ensure a high degree of compatibility and increased scores across testing platforms.
  • 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

  • Fixed an error that would sometimes be thrown when using labels on products with a price of 0 and/or similar combinations of pricing and special pricing.
  • Fixed an issue that prevented the description of the Label Text Magento Admin setting from being displayed, which explains the usage of variables.
  • 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

  • Fixed an issue that would cause the indexation of Product Label-specific URLs.
  • 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 a bug that would occasionally prevent certain frontend notification messages from being displayed.
  • 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.7 - September 1, 2022

  • Fixed an error related to PHP 8.1 that was thrown in some cases when creating a Product Label via the Magento Admin.
  • Fixed a bug that prevented the Product Label Position Grid from showing in the Label Configuration section.
  • 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

  • New Feature: Added a new functionality that allows for dynamic label construction with variables. Show your customers discount percentages for products with Special Prices or implement the FOMO effect by making it obvious when discounts end. Different combinations are possible and result in conversions going up.
  • 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

  • Fixed an issue that prevented labels from updating on schedule when using the Stock Status Magento Condition.
  • 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

  • New feature: Added an integration with our Owl Carousel module which now allows for displaying Product Labels on Product Carousels, both via widgets and Related/Up-Sell Carousels on Product Pages. Requires the WeltPixel Owl Carousel and Banner Slider extension.
  • Fixed an issue which prevented proper functionality with the Stock Condition. Product Labels would not disappear from the frontend when a product went out of stock.
  • Fixed a bug that prevented images from being uploaded via the Product Labels Magento Admin configuration.
  • Fixed a popup display issue that occurred when deleting a record from the Magento Admin.
  • 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.
  • Backend module code optimizations.


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

  • Confirmed compatibility with the newly released Magento 2.4.1 version.


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

  • Fixed an error that occurred in certain cases when Product SKUs had quotation marks in them.
  • 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

  • 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

  • Fixed a bug that caused an error to be thrown when deleting a Product Label from the label grid in the Magento Backend.
  • 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

  • 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.2 - November 27, 2019

  • Fixed an issue on the Product Page which caused Product Labels to display under the info area in the Pearl Theme, when the option to move tabs under the info area was enabled, and when the label was configured to display under the Short Description.
  • Added Magento and PHP version in the WeltPixel Developer section.


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

  • Added padding for labels introduced after the Short Description.
  • Fixed an issue related to Mobile Usability for Product Labels (Google Search Console).
  • 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

  • Introduced a new functionality which allows for positioning Product Labels under the Short Description.
  • Fixed a sorting issue that occured when labels were positioned in the same location on the product image.
  • Fixed an bug whereby Product Labels were not appearing on Category Pages.
  • Fixed a console error that was displayed on the Product Page.
  • 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

  • CSS adjustments.
  • Confirmed compatibility for Magento 2.3.1.


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

  • Fixed an issue related to Magento 2.3. Upload image JS error does not occur anymore.
  • 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

  • Fixed an issue related to product namespace paramater which was throwing an error when using Rest API.
  • 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 23, 2018

  • Initial release