Table of Contents
Toweringmedia Product Labels Extension User Guide
Related overview
For a shopper-friendly overview of features and setup, see the Magento 2 Product Labels User Guide - Sale & New Badges on the storefront. This wiki page remains the full technical documentation.
Extension context
This is a Toweringmedia Magento 2 extension guide for the current admin extension catalog.
Product page
- Toweringmedia Product Labels Extension (SKU
tm-product-labels)
Overview
This extension adds merchandising labels and badges — Sale, New, Out of Stock, and any custom badge you define — to product images on category listings and product pages. Labels are created once and then applied through rules, so badges appear automatically as catalog conditions change rather than being set product by product.
What this extension does
- Create reusable image or text labels and badges.
- Apply labels automatically through rules rather than per-product edits.
- Display labels on category listing and product detail pages.
- Limit how many labels can appear on a single product.
- Optionally hide labels whose variables resolve to empty or zero.
Requirements
- Magento 2.4.x (Open Source or Adobe Commerce).
- PHP: ^8.1 || ^8.2 || ^8.3 || ^8.4 (as declared by the published package).
- A current Toweringmedia license and Composer credentials for
https://composer.toweringmedia.com/. - Composer resolves
toweringmedia/module-baseautomatically.
Installation
Install and validate in a staging environment before production rollout.
cd /path/to/magento composer require toweringmedia/module-product-labels bin/magento module:enable Toweringmedia_ProductLabels bin/magento setup:upgrade bin/magento setup:di:compile bin/magento setup:static-content:deploy -f bin/magento cache:flush
Currently published versions at the time of writing:
toweringmedia/module-product-labels— 1.0.4
Toweringmedia packages are served from the licensed Composer repository https://composer.toweringmedia.com/. If Composer reports that the package could not be found, your credentials are missing or the license does not cover this package yet. Retrieve your keys from My Account on toweringmedia.com, or contact support@toweringmedia.com.
General installation notes that apply to every Toweringmedia extension are in the installation guide.
Configuration
- Stores > Configuration > Catalog > Product Labels (config section
toweringmedia_productlabels). Note this section sits under the Catalog tab, not the Towering Media tab. - Groups:
general(enable, debug, image base path, hide empty or zero variables) andlimits(default maximum labels per product). - Admin screens: Catalog > Product Labels > Manage Labels and Manage Rules.
Basic usage and what to expect
- Create the label artwork or text under Catalog > Product Labels > Manage Labels.
- Create a rule under Manage Rules that decides which products receive that label.
- Flush cache and check a category page to confirm the badge renders in the expected position.
Validation checklist
bin/magento module:statusshows the module(s) as enabled.- Extension configuration saves without errors in Admin.
- The admin screens listed above are reachable and load without error.
- Expected storefront/admin behavior is present after a cache flush.
- No critical PHP/JS errors appear in
var/log/during the primary test flow.
Troubleshooting
- Composer cannot find the package: confirm the
https://composer.toweringmedia.com/repository and your credentials are present inauth.json, and that your license covers this package. - Feature not visible: verify module status, flush cache, and redeploy static content.
- Admin setting not applying: clear cache and confirm the config scope (default / website / store view).
- Unexpected behavior: retest with only the required related modules enabled.
