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

This extension is also included in the Pearl Theme.

HOW TO INSTALL

This extension is installed via Composer, which is the official and only supported installation method.

Step 1: Prerequisites

Ensure your Magento version is compatible (2.3.0 - 2.4.8 and all Security Patches)
Install on a testing/development environment first
Set Magento to developer mode before installation
Make sure you have Composer installed on your server

php bin/magento deploy:mode:set developer

Step 2: Access Composer Configuration

Head into the Downloadable Products section of your weltpixel.com account. This is where you'll be able to see your Composer Configuration Commands.

You'll need to have Composer installation enabled for your account. If you don't see the Composer Configuration Commands, please contact our support team.

Step 3: Configure Repository

Run the generated commands from your account. Example commands:

composer config repositories.weltpixel composer https://weltpixel.repo.packagist.com/your-id/

composer config --global --auth http-basic.weltpixel.repo.packagist.com token your-token

These commands will provide you access to the WeltPixel repository. Replace 'your-id' and 'your-token' with the actual values from your account.

Step 4: Install via Composer

Run the following command in your Magento root directory:

composer require weltpixel/m2-weltpixel-product-labels

Step 5: Enable and Setup

Run the following commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy -f

Step 6: Cache Management

Flush any caches:

php bin/magento cache:flush

Step 7: Production Mode

If your store was in production mode, switch it back:

php bin/magento deploy:mode:set production

Wooohooo! The extension is now installed on your Magento store! Congrats!

How to Upgrade the Extension

Step 1: Run: composer update (for the package)
Step 2: Run setup commands: php bin/magento setup:upgrade, php bin/magento setup:di:compile, php bin/magento setup:static-content:deploy -f
Step 3: Flush cache: php bin/magento cache:flush

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.

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.

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.

Same As on Product Page - Select Yes if you want to have same options as on the 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.

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

Change Log.

What's new in v.1.16.0 - January 7, 2026

Giving back: As a celebration of over 10 years of activity within the Magento 2 ecosystem, and as a way to give back to the community, a number of WeltPixel extensions (both FREE and paid) have officially gone fully Open Source via public Github repositories. Find the full list on Github.
New Feature: Introduced composer as the official and singular installation method for all WeltPixel products. Previously, this was only available for the PRO version of the Google Analytics 4 extension, as well as the Marketing Suite Pro.

What’s new in v.1.15.9 - October 28, 2025

Magento Compatibility: Introduced compatibility with the latest released Magento 2 Security Patches - Magento 2.4.8-p3, Magento 2.4.7-p8, Magento 2.4.6-p13, Magento 2.4.5-p15 & Magento 2.4.4-p16.
New Feature: Added improvements to Magento Admin messaging around Product Updates to ensure visual clarity for users not running the latest product release.
New Feature: Added .ddev.site and .cloudwaysapps.com as accepted development domains. These domains will no longer require additional license keys.

What’s new in v.1.15.7 - September 2, 2025

Magento Compatibility: Introduced compatibility with the latest released Magento 2 Security Patches - Magento 2.4.8-p2, Magento 2.4.7-p7, Magento 2.4.6-p12, Magento 2.4.5-p14 & Magento 2.4.4-p15.
Added additional validations to prevent Magento Admin errors when the Backend extension could not fetch the current server user due to permissions issues.
Added adjustments to frontend templates to adhere to Magento Best Practices regarding XSS validations.
Fixed a CSP issue that would sometimes prevent orders from being created via the Magento Admin.

What’s new in v.1.15.3 - June 20, 2025

Magento Compatibility: Introduced compatibility with the latest Magento 2.4.8-p1, 2.4.7-p6, 2.4.6-p11 & 2.4.5-p13 Security Patches releases. Upgrade ASAP to keep your store secure.
Fixed the Backend functionality that enables users to change the default Magento CSP Restriction Mode via the Magento Admin. This was broken starting with Magento 2.4.7.

What’s new in v.1.15.0 - April 22, 2025

Magento Compatibility: Introduced compatibility with the new Magento 2.4.8 release, as well as the accompanying 2.4.7-p5, 2.4.6-p10, 2.4.5-p12 and 2.4.4-p13 Security Patches.
PHP Compatibility: Introduced compatibilty with PHP 8.4, which is now officially compatible with the latest Magento 2.4.8 version.
New Feature: Added magento2.docker as a valid domain for development purposes.
New Feature: Added ddev.site as a valid domain for development purposes.
Fixed an issue that would prevent certain extension options from correctly applying in Single Store Mode instances.
Added backend licensing adjustments for compatibility with the Google Analytics & Social Marketing Suite PRO.
Fixed a CSS display issue apparent when using custom CSS on labels added to Category Page images.

What’s new in v.1.14.13 - February 17, 2025

Magento Compatibility: Introduced compatibility with the newly released Magento 2.4.7-p4, 2.4.6-p9, 2.4.5-p11 and 2.4.4-p12 versions.
Fixed an issue related to licensing which would prevent license keys from being validated various subdomains.

What’s new in v.1.14.11 - January 15, 2025

Removed deprecated Magento 2.2.x code version from extension package.

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

New Feature: Added a new Magento Admin option that allows for setting Category Page label configurations to be the same as the ones used for the Product Page, eliminating the need to reconfigure the same settings in cases in which the same label is used for both.
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.
Fixed an issue that would sometimes result in labels generated by the extension being shown inconsistently via Stock Status conditions when using the Magento Multi Source Inventory functionality.
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.

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

Fixed a bug that would cause labels to be duplicated in cases in which a page included multiple iterations of the same product. This was most apparent when using Product List widgets.
Fixed an issue that would prevent labels created by the extension with stock-based conditions from displaying when using Magento's MSI functionality.
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

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