Toweringmedia Extension Docs

User Tools

Site Tools

You are here: start » magento2 » extensions » magento-2-product-labels
magento2:extensions:magento-2-product-labels

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
magento2:extensions:magento-2-product-labels [2026/09/01 20:47] – swatwikmagento2:extensions:magento-2-product-labels [2026/09/01 20:54] (current) – swatwik
Line 1: Line 1:
-= Magento 2 Product Labels Extension – User Guide =+====== Magento 2 Product Labels Extension – User Guide ======
  
-== Extension context ==+===== Extension context =====
  
 This document provides a comprehensive guide for the Toweringmedia Product Labels Extension for Magento 2. It is intended for store administrators and developers who want to create, configure, and manage product labels across their Magento store. The extension allows administrators to display customizable labels such as **Sale, New, Best Seller, Featured, and promotional badges** on products based on configurable rules and conditions. This document provides a comprehensive guide for the Toweringmedia Product Labels Extension for Magento 2. It is intended for store administrators and developers who want to create, configure, and manage product labels across their Magento store. The extension allows administrators to display customizable labels such as **Sale, New, Best Seller, Featured, and promotional badges** on products based on configurable rules and conditions.
  
-== Overview ==+===== Overview =====
  
 The Toweringmedia Product Labels Extension for Magento 2 allows store administrators to create and display customizable labels on products throughout the storefront. These labels can be used to highlight important product information, promotions, special offers, or product characteristics. The Toweringmedia Product Labels Extension for Magento 2 allows store administrators to create and display customizable labels on products throughout the storefront. These labels can be used to highlight important product information, promotions, special offers, or product characteristics.
Line 17: Line 17:
 The Product Labels Extension is designed to provide Magento store owners with greater control over product presentation while allowing labels to be customized according to the store's branding and promotional requirements. The Product Labels Extension is designed to provide Magento store owners with greater control over product presentation while allowing labels to be customized according to the store's branding and promotional requirements.
  
-== Key features ==+===== Key features =====
  
 The Toweringmedia Product Labels Extension provides the following key features: The Toweringmedia Product Labels Extension provides the following key features:
Line 51: Line 51:
   * **Easy Label Management** – Administrators can create, update, enable, disable, and manage product labels from the Magento Admin Panel.   * **Easy Label Management** – Administrators can create, update, enable, disable, and manage product labels from the Magento Admin Panel.
  
-== What this extension does ==+===== What this extension does =====
  
 The Toweringmedia Product Labels Extension enhances the Magento 2 storefront by allowing store administrators to add visual labels and badges to products. These labels help customers quickly identify important product information, promotions, and special offers while browsing the store. The Toweringmedia Product Labels Extension enhances the Magento 2 storefront by allowing store administrators to add visual labels and badges to products. These labels help customers quickly identify important product information, promotions, and special offers while browsing the store.
Line 71: Line 71:
   * Provide customers with quick visual indicators without requiring them to open each product to view additional information.   * Provide customers with quick visual indicators without requiring them to open each product to view additional information.
  
-== Installation ==+===== Installation =====
  
 Please refer to the installation guide in the following article [[https://toweringmedia.com/installation|https://toweringmedia.com/installation]] Please refer to the installation guide in the following article [[https://toweringmedia.com/installation|https://toweringmedia.com/installation]]
  
-== Admin setup ==+===== Admin setup =====
  
 The Product Labels Extension provides a dedicated section in the Magento Admin Panel for creating and managing product labels. The Product Labels Extension provides a dedicated section in the Magento Admin Panel for creating and managing product labels.
  
-=== Product Labels grid ===+==== Product Labels grid ====
  
 Navigate to the Product Labels section in the Magento Admin Panel to view and manage existing labels. Navigate to the Product Labels section in the Magento Admin Panel to view and manage existing labels.
Line 100: Line 100:
 {{:magento2:extensions:label-grid.png?400|}} {{:magento2:extensions:label-grid.png?400|}}
  
-=== Creating a product label ===+==== Creating a product label ====
  
 The label configuration page contains several sections that allow the administrator to define the label, select products, configure display locations, and customize its appearance. The label configuration page contains several sections that allow the administrator to define the label, select products, configure display locations, and customize its appearance.
  
-=== General ===+==== General ====
  
 The **General** section contains the basic label configuration. The **General** section contains the basic label configuration.
  
-==== Status ====+=== Status ===
  
 Enable or disable the label using the **Status** option. Enable or disable the label using the **Status** option.
Line 115: Line 115:
   * **No** – The label is disabled.   * **No** – The label is disabled.
  
-==== Name ====+=== Name ===
  
 Enter a unique name for the label. Enter a unique name for the label.
Line 121: Line 121:
 The name is used to identify the label in the Magento Admin Panel. The name is used to identify the label in the Magento Admin Panel.
  
-==== Priority ====+=== Priority ===
  
 Enter a numeric priority for the label. Enter a numeric priority for the label.
Line 127: Line 127:
 Priority can be used to control the processing order when multiple labels apply to the same product. Priority can be used to control the processing order when multiple labels apply to the same product.
  
-==== Use For Child Products ====+=== Use For Child Products ===
  
 Enable this option when the label should also be applicable to child products of **Configurable, Bundle, or Grouped** products. Enable this option when the label should also be applicable to child products of **Configurable, Bundle, or Grouped** products.
  
-==== Stores ====+=== Stores ===
  
 Select the Magento stores/store views where the label should be available. Select the Magento stores/store views where the label should be available.
Line 137: Line 137:
 This allows administrators to use different labels or label configurations across multiple store views. This allows administrators to use different labels or label configurations across multiple store views.
  
-==== Customer Groups ====+=== Customer Groups ===
  
 Select the customer groups for which the label should be displayed. Select the customer groups for which the label should be displayed.
Line 148: Line 148:
   * Retailer   * Retailer
  
-==== Stop Processing ====+=== Stop Processing ===
  
 Enable **Stop Processing** when the current label should prevent further label processing according to the extension's priority and processing rules. Enable **Stop Processing** when the current label should prevent further label processing according to the extension's priority and processing rules.
Line 154: Line 154:
 {{:magento2:extensions:label-new-general.png?400|}} {{:magento2:extensions:label-new-general.png?400|}}
  
-=== Products Selection ===+==== Products Selection ====
  
 The **Products Selection** section determines which products will receive the label. The **Products Selection** section determines which products will receive the label.
  
-==== Products Selection ====+=== Products Selection ===
  
 Select how products should be assigned to the label. Select how products should be assigned to the label.
Line 164: Line 164:
 The extension provides an option for **Only manually assigned products**, while condition-based product selection can also be configured through product conditions. The extension provides an option for **Only manually assigned products**, while condition-based product selection can also be configured through product conditions.
  
-==== Manual Product IDs ====+=== Manual Product IDs ===
  
 When **Only manually assigned products** is selected, enter the product IDs in the **Manual Product IDs** field. When **Only manually assigned products** is selected, enter the product IDs in the **Manual Product IDs** field.
Line 176: Line 176:
 </code> </code>
  
-==== Display On ====+=== Display On ===
  
 Select the storefront areas where the label should be displayed. Select the storefront areas where the label should be displayed.
Line 191: Line 191:
 A label can therefore be displayed in multiple product presentation areas across the Magento storefront. A label can therefore be displayed in multiple product presentation areas across the Magento storefront.
  
-=== Product Conditions ===+==== Product Conditions ====
  
 The **Product Conditions** section allows administrators to control label assignment based on product conditions. The **Product Conditions** section allows administrators to control label assignment based on product conditions.
  
-==== Active From Date ====+=== Active From Date ===
  
 Specify the date from which the label should become active. Specify the date from which the label should become active.
  
-==== Active To Date ====+=== Active To Date ===
  
 Specify the date until which the label should remain active. Specify the date until which the label should remain active.
Line 206: Line 206:
  
  
-==== Product Conditions ====+=== Product Conditions ===
  
 Configure conditions that determine which products match the label. Configure conditions that determine which products match the label.
Line 214: Line 214:
 The matching products section can be used to review products that satisfy the configured conditions. The matching products section can be used to review products that satisfy the configured conditions.
  
-=== Source Type ===+==== Source Type ====
  
 The **Source Type** option determines how the label's product selection is sourced. The **Source Type** option determines how the label's product selection is sourced.
Line 220: Line 220:
 For manually selected products, **Manual** can be selected as the source type. For manually selected products, **Manual** can be selected as the source type.
  
-=== Tooltip ===+==== Tooltip ====
  
 The extension provides tooltip configuration for product labels. The extension provides tooltip configuration for product labels.
  
-==== Enabled ====+=== Enabled ===
  
 Enable or disable the tooltip. Enable or disable the tooltip.
  
-==== Tooltip Color ====+=== Tooltip Color ===
  
 Specify the background color used for the tooltip. Specify the background color used for the tooltip.
  
-==== Tooltip Text Color ====+=== Tooltip Text Color ===
  
 Specify the color of the tooltip text. Specify the color of the tooltip text.
  
-==== Tooltip Text ====+=== Tooltip Text ===
  
 Enter the tooltip content that should be displayed when the customer interacts with the label. Enter the tooltip content that should be displayed when the customer interacts with the label.
Line 254: Line 254:
 Basic HTML tags can also be used where supported. Basic HTML tags can also be used where supported.
  
-=== Label appearance ===+==== Label appearance ====
  
 The label appearance can be configured separately for different storefront areas. The label appearance can be configured separately for different storefront areas.
Line 272: Line 272:
 {{:magento2:extensions:label-new-selection1.png?400|}} {{:magento2:extensions:label-new-selection1.png?400|}}
  
-==== Label Type ====+=== Label Type ===
  
 Select how the label should be rendered. Select how the label should be rendered.
Line 282: Line 282:
   * **Text & Image**   * **Text & Image**
  
-==== Shape ====+=== Shape ===
  
 Select the shape used for the label. Select the shape used for the label.
Line 288: Line 288:
 For example, **None (default chip)** can be used for a standard label appearance. For example, **None (default chip)** can be used for a standard label appearance.
  
-==== Label Position ====+=== Label Position ===
  
 Select the position of the label using the 3 × 3 position selector. Select the position of the label using the 3 × 3 position selector.
Line 304: Line 304:
   * Bottom-right   * Bottom-right
  
-==== Label Text ====+=== Label Text ===
  
 Enter the text that should be displayed on the label. Enter the text that should be displayed on the label.
Line 324: Line 324:
 These variables allow the label to display dynamic product information. These variables allow the label to display dynamic product information.
  
-==== Text Color ====+=== Text Color ===
  
 Select the color of the label text. Select the color of the label text.
  
-==== Text Size ====+=== Text Size ===
  
 Specify the font size of the label text in pixels. Specify the font size of the label text in pixels.
Line 338: Line 338:
 </code> </code>
  
-==== Image ====+=== Image ===
  
 Upload an image to use as the product label. Upload an image to use as the product label.
Line 349: Line 349:
 The supported image formats and maximum file size are displayed in the corresponding configuration section. The supported image formats and maximum file size are displayed in the corresponding configuration section.
  
-==== CSS Class ====+=== CSS Class ===
  
 Enter a custom CSS class for the label. Enter a custom CSS class for the label.
Line 355: Line 355:
 This can be used when additional storefront styling is required. This can be used when additional storefront styling is required.
  
-==== Container Style ====+=== Container Style ===
  
 Enter inline CSS for the label container. Enter inline CSS for the label container.
Line 365: Line 365:
 </code> </code>
  
-=== Category Page ===+==== Category Page ====
  
 The **Category Page** section controls how the label is displayed on category product tiles. The **Category Page** section controls how the label is displayed on category product tiles.
Line 385: Line 385:
 {{:magento2:extensions:label-new-category.png?400|}} {{:magento2:extensions:label-new-category.png?400|}}
  
-=== Product Page ===+==== Product Page ====
  
 The **Product Page** section controls label display on the individual product detail page. The **Product Page** section controls label display on the individual product detail page.
Line 395: Line 395:
 {{:magento2:extensions:label-new-product.png?400|}} {{:magento2:extensions:label-new-product.png?400|}}
  
-=== Cart, Mini-Cart and Checkout Pages ===+==== Cart, Mini-Cart and Checkout Pages ====
  
 The extension also provides configuration for labels displayed in cart-related areas. The extension also provides configuration for labels displayed in cart-related areas.
Line 411: Line 411:
 {{:magento2:extensions:label-new-minicart.png?400|}} {{:magento2:extensions:label-new-minicart.png?400|}}
  
-== Frontend user experience ==+===== Frontend user experience =====
  
 Product labels are displayed directly on product images or product presentation areas, allowing customers to identify important product information while browsing the store. Product labels are displayed directly on product images or product presentation areas, allowing customers to identify important product information while browsing the store.
  
-=== Category and product listing pages ===+==== Category and product listing pages ====
  
 On category pages, labels can appear directly on product tiles. On category pages, labels can appear directly on product tiles.
Line 434: Line 434:
 {{:magento2:extensions:label-new-product-list.png?400|}} {{:magento2:extensions:label-new-product-list.png?400|}}
  
-=== Product detail page ===+==== Product detail page ====
  
 On the product detail page, the label can be displayed alongside the product image. On the product detail page, the label can be displayed alongside the product image.
Line 442: Line 442:
 For example, a product can display a **Featured** label above the product image. For example, a product can display a **Featured** label above the product image.
  
-=== Multiple product presentation areas ===+==== Multiple product presentation areas ====
  
 Depending on the administrator's configuration, product labels can also appear in: Depending on the administrator's configuration, product labels can also appear in:
Line 457: Line 457:
 {{:magento2:extensions:label-new-product-details.png?400|}} {{:magento2:extensions:label-new-product-details.png?400|}}
  
-=== Label customization experience ===+==== Label customization experience ====
  
 Customers see labels according to the configuration defined by the administrator. Customers see labels according to the configuration defined by the administrator.
Line 473: Line 473:
 This allows labels to match the visual design of the Magento storefront. This allows labels to match the visual design of the Magento storefront.
  
-=== Dynamic label information ===+==== Dynamic label information ====
  
 Labels can display dynamic product information using supported variables. Labels can display dynamic product information using supported variables.
Line 481: Line 481:
 This allows administrators to create labels that automatically reflect product-specific information without manually creating separate label text for every product. This allows administrators to create labels that automatically reflect product-specific information without manually creating separate label text for every product.
  
-=== Scheduled label visibility ===+==== Scheduled label visibility ====
  
 When **Active From Date** and **Active To Date** are configured, labels can be displayed only during the specified period. When **Active From Date** and **Active To Date** are configured, labels can be displayed only during the specified period.
Line 495: Line 495:
 Once the configured active period ends, the label is no longer displayed according to the extension's scheduling rules. Once the configured active period ends, the label is no longer displayed according to the extension's scheduling rules.
  
-=== Tooltip experience ===+==== Tooltip experience ====
  
 When tooltips are enabled, customers can receive additional information associated with a product label. When tooltips are enabled, customers can receive additional information associated with a product label.
Line 502: Line 502:
  
  
-== Validation checklist ==+===== Validation checklist =====
  
   * Verify that the extension is successfully installed and enabled.   * Verify that the extension is successfully installed and enabled.
Line 553: Line 553:
  
  
-== Troubleshooting ==+===== Troubleshooting =====
  
-=== Product label is not displayed on the frontend ===+==== Product label is not displayed on the frontend ====
  
 If a configured label is not visible on the storefront: If a configured label is not visible on the storefront:
Line 568: Line 568:
   * Clear Magento cache and refresh the storefront.   * Clear Magento cache and refresh the storefront.
  
-=== Label appears on some pages but not others ===+==== Label appears on some pages but not others ====
  
 Check the **Display On** configuration for the label. The extension supports different product locations, such as: Check the **Display On** configuration for the label. The extension supports different product locations, such as:
Line 583: Line 583:
 Also check the **Hide Label on Pages** configuration for Shopping Cart, Mini-Cart, and Checkout pages. Also check the **Hide Label on Pages** configuration for Shopping Cart, Mini-Cart, and Checkout pages.
  
-=== Product is not included in the label ===+==== Product is not included in the label ====
  
 If a product does not match the label: If a product does not match the label:
Line 592: Line 592:
   * Verify that the product status and visibility allow it to appear on the storefront.   * Verify that the product status and visibility allow it to appear on the storefront.
  
-=== Wrong label is displayed when multiple labels apply ===+==== Wrong label is displayed when multiple labels apply ====
  
 If multiple labels match the same product: If multiple labels match the same product:
Line 601: Line 601:
   * Make sure there are no overlapping product conditions causing an unexpected label to be selected.   * Make sure there are no overlapping product conditions causing an unexpected label to be selected.
  
-=== Label is displayed for the wrong customer group ===+==== Label is displayed for the wrong customer group ====
  
 Check the **Customer Groups** configuration of the label. Check the **Customer Groups** configuration of the label.
Line 607: Line 607:
 Make sure the intended customer group is selected and test the storefront using an account belonging to that customer group. Also test the page as a guest if **NOT LOGGED IN** is selected. Make sure the intended customer group is selected and test the storefront using an account belonging to that customer group. Also test the page as a guest if **NOT LOGGED IN** is selected.
  
-=== Label is not displayed for child products ===+==== Label is not displayed for child products ====
  
 For configurable, bundle, or grouped products, check the **Use For Child Products** setting. For configurable, bundle, or grouped products, check the **Use For Child Products** setting.
Line 613: Line 613:
 Enable this option when the label should also apply to the associated child products. Enable this option when the label should also apply to the associated child products.
  
-=== Label image is not displayed ===+==== Label image is not displayed ====
  
 If an image-based label is not visible: If an image-based label is not visible:
Line 623: Line 623:
   * Check the browser developer console for image-loading or permission errors.   * Check the browser developer console for image-loading or permission errors.
  
-=== Tooltip is not working ===+==== Tooltip is not working ====
  
 If the tooltip does not appear: If the tooltip does not appear:
Line 633: Line 633:
   * Clear Magento cache and test again.   * Clear Magento cache and test again.
  
-=== Label position or appearance is incorrect ===+==== Label position or appearance is incorrect ====
  
 If the label is not positioned or styled as expected: If the label is not positioned or styled as expected:
Line 644: Line 644:
   * Test the label with the default styling to determine whether the issue is caused by custom CSS.   * Test the label with the default styling to determine whether the issue is caused by custom CSS.
  
-=== Label changes are not visible after saving ===+==== Label changes are not visible after saving ====
  
 If changes made in the Admin Panel are not immediately visible: If changes made in the Admin Panel are not immediately visible:
Line 654: Line 654:
   - Test the page in a private/incognito browser window to rule out browser caching.   - Test the page in a private/incognito browser window to rule out browser caching.
  
-=== Labels overlap or affect the product layout ===+==== Labels overlap or affect the product layout ====
  
 If labels overlap product content or other labels: If labels overlap product content or other labels:
Line 664: Line 664:
   * If multiple labels apply to the same product, review their **Priority** and **Stop Processing** settings.   * If multiple labels apply to the same product, review their **Priority** and **Stop Processing** settings.
   * Test the layout on different screen sizes to ensure responsive behavior.   * Test the layout on different screen sizes to ensure responsive behavior.
 +
magento2/extensions/magento-2-product-labels.txt · Last modified: by swatwik