PHPackages mage2kishan/module-sale-filter - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Search & Filtering](/categories/search) 4. / 5. mage2kishan/module-sale-filter ActiveMagento2-module[Search & Filtering](/categories/search) mage2kishan/module-sale-filter ============================== Panth Sale Filter — "On Sale" layered navigation filter for Magento 2, backed by a custom indexer that respects catalog rules, special prices, customer groups, websites, and all product types (simple, configurable, grouped, bundle, virtual, downloadable). Hyva and Luma compatible. 1.0.18(1mo ago)001proprietaryPHPPHP ~8.1.0||~8.2.0||~8.3.0||~8.4.0 Since Apr 22Pushed yesterdayCompare [ Source](https://github.com/mage2sk/module-sale-filter)[ Packagist](https://packagist.org/packages/mage2kishan/module-sale-filter)[ Docs](https://kishansavaliya.com)[ RSS](/packages/mage2kishan-module-sale-filter/feed)WikiDiscussions main Synced 1w ago READMEChangelogDependencies (13)Versions (19)Used By (1) Panth Sale Filter — "On Sale" Layered Navigation Filter for Magento 2 | Panth Infotech ====================================================================================== [](#panth-sale-filter--on-sale-layered-navigation-filter-for-magento-2--panth-infotech) [![Magento 2.4.4 - 2.4.8](https://camo.githubusercontent.com/079c832211eed4f9451ebe264e3865f825b0f9f31b041cbf03676c6e254535d4/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d6167656e746f2d322e342e342532302d2d253230322e342e382d6f72616e67653f6c6f676f3d6d6167656e746f266c6f676f436f6c6f723d7768697465)](https://magento.com)[![PHP 8.1 - 8.4](https://camo.githubusercontent.com/56b3cce18841623e2cbed2ebf09b06be1be8807e99e6e054a89d304ab4790b8e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e312532302d2d253230382e342d626c75653f6c6f676f3d706870266c6f676f436f6c6f723d7768697465)](https://php.net)[![Hyva Compatible](https://camo.githubusercontent.com/e2560f479f1f16f2796c4e6f8011eb6a2eea56db6e5d7421f97c8d6d1dda4110/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f487976612d436f6d70617469626c652d313462386136)](https://hyva.io)[![Elasticsearch / OpenSearch](https://camo.githubusercontent.com/f8679ba149219470f04fb692d6856d482470a6e0489f0b1ffbd425db483811fa/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5365617263682d456c61737469637365617263682532302537432532304f70656e5365617263682d3030353537313f6c6f676f3d656c6173746963736561726368266c6f676f436f6c6f723d7768697465)](https://www.elastic.co/)[![Packagist](https://camo.githubusercontent.com/b6f35cd9cd54ca992cc2539cbf7985d7a22496654b863a7aefef37b98ccae0d2/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5061636b61676973742d6d616765326b697368616e2532466d6f64756c652d2d73616c652d2d66696c7465722d6f72616e67653f6c6f676f3d7061636b6167697374266c6f676f436f6c6f723d7768697465)](https://packagist.org/packages/mage2kishan/module-sale-filter)[![GitHub](https://camo.githubusercontent.com/730e527917a20366073efa96dca24574c1c3e71a8eb4e1ebec02ceb4d0f4213d/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4769744875622d6d61676532736b2532466d6f64756c652d2d73616c652d2d66696c7465722d3138313731373f6c6f676f3d676974687562266c6f676f436f6c6f723d7768697465)](https://github.com/mage2sk/module-sale-filter)[![Upwork Top Rated Plus](https://camo.githubusercontent.com/6f72584179420c41ed90432fd2579a4ed36199d4229e8181d20f353c1c4ee4eb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5570776f726b2d546f702532305261746564253230506c75732d3134613830303f6c6f676f3d7570776f726b266c6f676f436f6c6f723d7768697465)](https://www.upwork.com/freelancers/~016dd1767321100e21)[![Panth Infotech Agency](https://camo.githubusercontent.com/401a792e990131002e91054d1b04494af5a2152fcc891ca000eb683786770abf/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4167656e63792d50616e7468253230496e666f746563682d3134613830303f6c6f676f3d7570776f726b266c6f676f436f6c6f723d7768697465)](https://www.upwork.com/agencies/1881421506131960778/)[![Website](https://camo.githubusercontent.com/f1ae86d28e2b505aee60f240d3e5508e390b0a8dc7a9b7ecf1b450fad862053f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f576562736974652d6b697368616e736176616c6979612e636f6d2d304439343838)](https://kishansavaliya.com)[![Get a Quote](https://camo.githubusercontent.com/0b6c02cc1ad00f11bf1b0164a9998734bd716473db36cc2a5c1517e3d3578d1b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4765742532306125323051756f74652d46726565253230457374696d6174652d444332363236)](https://kishansavaliya.com/get-quote) > **Let shoppers narrow any category or search result to discounted products in one click.** A fast, indexer-driven *On Sale* layered-navigation filter that respects catalog price rules, special prices, tier prices, dated discounts, and customer-group pricing — with parent aggregation for configurables, grouped, and bundle products. Works on Luma out of the box; install the companion Hyvä module for a Hyvä-native Alpine.js template. **Panth Sale Filter** adds a **Shop By → Sale Status** option to Magento 2's layered navigation so customers can instantly filter a category or search result down to *discounted only* or *regular-price only*. Every option shows a **real-time count** (`On Sale (12)`) that reflects the current category + visibility scope, not a global tally. Discount detection is driven by a dedicated indexer (`panth_salefilter_product`) that evaluates **every product × customer group × website** and resolves the effective sale status from: - **Catalog price rules** (including scheduled `from_date` / `to_date` windows) - **Per-product special prices** with start/end dates - **Tier prices** that fall below the regular price - **Customer-group-specific prices** - **Parent aggregation** for composite products — a configurable, grouped, or bundle is *On Sale* as soon as any eligible child is Dated discounts flip automatically at the minute they come into / go out of effect via Magento's built-in `catalogrule_apply_all` nightly cron — no custom cron of our own. --- 🚀 Need Custom Magento 2 Development? ------------------------------------ [](#-need-custom-magento-2-development) > **Get a free quote for your project in 24 hours** — custom modules, Hyvä themes, performance optimization, M1 → M2 migrations, and Adobe Commerce Cloud. [ ![Get a Free Quote](https://camo.githubusercontent.com/eac8c45d21cff8b139ddc392325f3bd6c8266a6f3d7b23f15131c958f3d3c8d0/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f476574253230612532304672656525323051756f74652532302545322538362539322d5265706c7925323077697468696e2532303234253230686f7572732d4443323632363f7374796c653d666f722d7468652d6261646765) ](https://kishansavaliya.com/get-quote) ### 🏆 Kishan Savaliya [](#-kishan-savaliya) **Top Rated Plus on Upwork** [![Hire on Upwork](https://camo.githubusercontent.com/b69353d3c6e192f4d03cc36bb8883612004e32f54dd2dbcc1e700dd791acd875/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f486972652532306f6e2532305570776f726b2d546f702532305261746564253230506c75732d3134613830303f7374796c653d666f722d7468652d6261646765266c6f676f3d7570776f726b266c6f676f436f6c6f723d7768697465)](https://www.upwork.com/freelancers/~016dd1767321100e21) 100% Job Success • 10+ Years Magento Experience Adobe Certified • Hyvä Specialist ### 🏢 Panth Infotech Agency [](#-panth-infotech-agency) **Magento Development Team** [![Visit Agency](https://camo.githubusercontent.com/bbf04bdd2aff502082508568ec42ace3a7475c98756f596e2013056c89726ed6/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f56697369742532304167656e63792d50616e7468253230496e666f746563682d3134613830303f7374796c653d666f722d7468652d6261646765266c6f676f3d7570776f726b266c6f676f436f6c6f723d7768697465)](https://www.upwork.com/agencies/1881421506131960778/) Custom Modules • Theme Design • Migrations Performance • SEO • Adobe Commerce Cloud **Visit our website:** [kishansavaliya.com](https://kishansavaliya.com) | **Get a quote:** [kishansavaliya.com/get-quote](https://kishansavaliya.com/get-quote) --- Table of Contents ----------------- [](#table-of-contents) - [Screenshots](#screenshots) - [Key Features](#key-features) - [Why a Sale Filter](#why-a-sale-filter) - [Compatibility](#compatibility) - [Installation](#installation) - [Configuration](#configuration) - [How It Works](#how-it-works) - [Caching — Per Customer Group, Per Category, Per Filter State](#caching--per-customer-group-per-category-per-filter-state) - [Admin Index Grid](#admin-index-grid) - [Indexing](#indexing) - [Dated Discounts — When Does the Index Refresh?](#dated-discounts--when-does-the-index-refresh) - [URL Parameters](#url-parameters) - [CLI Reference](#cli-reference) - [Uninstall](#uninstall) - [Changelog](#changelog) - [Troubleshooting](#troubleshooting) - [FAQ](#faq) - [Support](#support) - [About Panth Infotech](#about-panth-infotech) --- Screenshots ----------- [](#screenshots) ### Storefront (Luma) [](#storefront-luma) Sidebar filterFilter applied — On SaleFilter applied — Regular[![Luma sidebar](docs/images/luma-sidebar.png)](docs/images/luma-sidebar.png)[![On Sale active](docs/images/luma-active-on-sale.png)](docs/images/luma-active-on-sale.png)[![Regular active](docs/images/luma-active-regular.png)](docs/images/luma-active-regular.png)### Storefront (Hyvä) [](#storefront-hyvä) [![Hyvä sidebar](docs/images/hyva-sidebar.png)](docs/images/hyva-sidebar.png) ### Admin — live demo [](#admin--live-demo) [![Admin configuration demo](docs/images/admin-config-demo.gif)](docs/images/admin-config-demo.gif) ### Admin — configuration, grid, indexer [](#admin--configuration-grid-indexer) ConfigurationSale Filter Index gridIndexer registration[![Admin configuration](docs/images/admin-configuration.png)](docs/images/admin-configuration.png)[![Sale Filter Index](docs/images/admin-index-grid.png)](docs/images/admin-index-grid.png)[![Indexer list](docs/images/admin-index-management.png)](docs/images/admin-index-management.png)--- Key Features ------------ [](#key-features) ### Storefront [](#storefront) - **Shop By → Sale Status** option in layered navigation on category AND search-result pages - **"On Sale" and "Regular" options** with configurable labels per store view - **Real counts** next to each option (`On Sale (12)`) that exactly match the grid total post-click — scoped to the current category + visibility, never a global store-wide tally - **Stock-aware counts** — when *Display Out of Stock Products* is *No* (Magento default), the `(N)` excludes OOS rows; when *Yes*, it includes them. Works identically in both modes. - **Cross-filter accurate** — when Brand = Nike, Pattern, Color, Size, or Price range is already active, the "On Sale" count shows the intersection, not the category-wide total. Super-attribute filters on configurables (color / pattern / size on variants) resolve via `catalog_product_index_eav` + `catalog_product_super_link` so configurable parents matching at least one on-attribute child are counted. - **Accurate pager totals** — `Items 1-12 of 24` reflects the post-filter result even under the Elasticsearch-backed `Fulltext\Collection` - **Sort-aware** — price asc/desc, name asc/desc, position — all honoured while the filter is active - **"Now Shopping by" chip** with a one-click clear, integrated with Magento's standard active-filter UI - **Pagination-safe** — filter state is preserved across `?p=2`, `?product_list_limit=24`, and any sort dropdown; sidebar count is invariant across pages ### Discount detection [](#discount-detection) - **Catalog price rules** — all operators (by\_percent, by\_fixed, to\_percent, to\_fixed), dated rules, priority order - **Per-product special prices** — with `special_from_date` and `special_to_date` awareness - **Tier prices** that fall below the regular price - **Customer-group-specific pricing** — NOT LOGGED IN, General, Wholesale, Retailer, or any custom group - **Parent aggregation** — a configurable, grouped, or bundle is *On Sale* as soon as any eligible child is - **All product types** — simple, configurable, grouped, bundle, virtual, downloadable ### Indexer [](#indexer) - **Dedicated indexer** `panth_salefilter_product` appearing in System → Tools → Index Management - **MView subscriptions** on `catalog_product_entity_decimal`, `catalog_product_entity_datetime`, `catalogrule_product_price`, `catalog_product_relation`, `catalog_product_super_link`, `catalog_product_bundle_selection` - **Two index modes** — *Update by Schedule* (default, cron-driven, recommended for production) and *Update on Save* (synchronous, great for staging and debugging) - **Dated-discount aware** — flips automatically at discount start/end time via Magento's nightly `catalogrule_apply_all` cron, no custom cron needed ### Admin & Ops [](#admin--ops) - **Admin index grid** at System → Panth Infotech → Sale Filter Index (UI component, filters, column chooser, export) - **Columns**: product id, SKU, type, website, customer group, regular price, special price, is-on-sale, updated-at, rule price, discount %, active catalog rules, **match source** (`Catalog Rule` / `Special Price` / `Both`) - **CLI helpers** — `bin/magento panth_salefilter:reindex` and `panth_salefilter:status` - **Cache-friendly** — invalidates `panth_salefilter`, `block_html`, and `full_page` tags on every change ### Quality & Compliance [](#quality--compliance) - **MEQP-compliant** — passes Adobe's Magento Extension Quality Program with zero severity-10 violations - **Declarative schema** (`db_schema.xml` + whitelist) - **Zero third-party PHP dependencies** — uses only Magento framework classes - **PHPDoc + strict types** throughout --- Why a Sale Filter ----------------- [](#why-a-sale-filter) Magento's stock layered navigation can filter by price range or attribute, but there's no out-of-the-box way to say *"show me only the products currently on sale"* across catalog rules, special prices, and tier prices in one option. Common workarounds (dedicated *Sale* category, custom attribute flag) fall apart the moment: - A catalog rule is dated (flips on/off at midnight) - A special price expires and the product is no longer on sale - A configurable's children have varying discount state - A customer group has its own pricing tier **Panth Sale Filter fixes this** with a dedicated indexer that resolves the *effective* sale status per (product, customer group, website) and writes it to a flat table the layered-nav plugin can hit in microseconds. Everything stays accurate as rules come online, expire, or are re-applied — automatically. --- Compatibility ------------- [](#compatibility) RequirementVersions SupportedMagento Open Source2.4.4, 2.4.5, 2.4.6, 2.4.7, 2.4.8Adobe Commerce2.4.4, 2.4.5, 2.4.6, 2.4.7, 2.4.8Adobe Commerce Cloud2.4.4 — 2.4.8PHP8.1.x, 8.2.x, 8.3.x, 8.4.xMySQL8.0+MariaDB10.4+Search EngineElasticsearch 7/8, OpenSearch 1/2Hyvä Theme1.3+ (via companion module)Luma ThemeNative supportTested on: - Magento 2.4.8-p4 with PHP 8.4 and Elasticsearch 8 - Magento 2.4.7 with PHP 8.3 and OpenSearch 2 - Magento 2.4.6 with PHP 8.2 and Elasticsearch 7 --- Installation ------------ [](#installation) ### Composer (Recommended) [](#composer-recommended) ``` composer require mage2kishan/module-sale-filter bin/magento module:enable Panth_SaleFilter bin/magento setup:upgrade bin/magento setup:di:compile bin/magento indexer:reindex panth_salefilter_product bin/magento cache:flush ``` ### Hyvä storefronts [](#hyvä-storefronts) Also install the companion module — it ships the Alpine.js / Tailwind template and the Hyvä *Appearance* admin group: ``` composer require mage2kishan/module-sale-filter-hyva bin/magento module:enable Panth_SaleFilterHyva bin/magento setup:upgrade bin/magento setup:di:compile bin/magento cache:flush ``` ### Manual installation via ZIP [](#manual-installation-via-zip) 1. Download the latest release ZIP from [Packagist](https://packagist.org/packages/mage2kishan/module-sale-filter) or [GitHub Releases](https://github.com/mage2sk/module-sale-filter/releases) 2. Extract to `app/code/Panth/SaleFilter/` in your Magento installation 3. Run the same commands starting from `bin/magento module:enable Panth_SaleFilter` ### Verify installation [](#verify-installation) ``` bin/magento module:status Panth_SaleFilter # Expected: Module is enabled bin/magento indexer:status panth_salefilter_product # Expected: Ready / Update by Schedule / idle ``` After installation, navigate to: ``` Admin → Stores → Configuration → Panth Extensions → Sale Filter ``` --- Configuration ------------- [](#configuration) **Stores → Configuration → Panth Extensions → Sale Filter** FieldDefaultDescriptionEnabledYesMaster switch. Off = filter vanishes from layered nav and `?sale_filter=…` URL params become no-ops.Filter TitleSale StatusHeading shown above the options in the sidebar.Option Label — On SaleOn SaleLabel for the discounted option.Show "Not On Sale" OptionNoWhen on, a second option surfaces so shoppers can toggle to regular-price products.Option Label — Not On SaleRegularLabel for the regular-price option.Show Product CountYesToggles the `(12)` counter next to each option.Include Special PricesYesWhen off, the indexer ignores per-product `special_price`.Include Catalog RulesYesWhen off, the indexer ignores catalog price rules.Filter Position100Sort order within layered navigation — lower values appear higher in the sidebar.All fields are **store-scoped** — you can set different labels per store view for multi-locale installations. --- How It Works ------------ [](#how-it-works) 1. **Indexer** `Panth\SaleFilter\Model\Indexer\ProductIndexer` walks every product × customer-group × website, resolves the effective "is on sale" flag (catalog-rule price vs special price vs regular), and writes a row into `panth_salefilter_product_index`. 2. **MView subscriptions** on the relevant upstream tables keep the index fresh without a cron run — product saves, rule re-applies, price changes all propagate through the changelog. 3. **Layered-navigation plugin** runs `afterGetProductCollection` on `Catalog\Model\Layer\Category` and `Catalog\Model\Layer\Search`. It intersects the index with the current category + visibility, stashes the ordered id list on the collection, and swaps Magento's `SearchResultApplier` for a filter-aware variant so the ES page slice is **taken from the filtered list** rather than narrowed by it after the fact. 4. **`getSize()` plugin** returns the pre-computed post-filter count so the toolbar pager shows `N of true-total`, not `N of unfiltered`. --- Caching — Per Customer Group, Per Category, Per Filter State ------------------------------------------------------------ [](#caching--per-customer-group-per-category-per-filter-state) The "On Sale" filter shows **different counts to different customer groups** (a Wholesale customer's discount is not a Retailer's discount). Cached naively, the first visitor's view would be served to everyone — wrong counts, missing options. This module solves it with two well-known Magento hooks plus a multi-frontend tag invalidator. [![How the cache works](docs/images/how-cache-is-working.png)](docs/images/how-cache-is-working.png) ### The smart label — `Block/LayeredNavigation/FilterRenderer.php` [](#the-smart-label--blocklayerednavigationfilterrendererphp) `FilterRenderer` extends `Template` and implements `IdentityInterface`. Two methods do all the work: - **`getCacheKeyInfo()`** — returns an array Magento hashes into the block-cache key. We mix in **store id, website id, customer group, currency, current category id, and the active `sale_filter` URL param**. Each unique combination gets its own cached HTML fragment, so a Guest never sees a Wholesale-warmed render. - **`getIdentities()`** — returns the cache tags stamped on every cached entry: `cat_p` (catalog product) and `panth_salefilter` (our own). Whenever a product or catalog rule changes, we clean by these tags and only matching entries are evicted — surrounding pages stay warm. > **Critical:** customer group is read from `HttpContext`, **not** `CustomerSession`. Magento's `DepersonalizePlugin` wipes the session to guest before cacheable blocks render, so the session would always lie. `HttpContext` is the only safe source. ### The trigger — `Observer/CatalogRuleSaveAfter.php` [](#the-trigger--observercatalogrulesaveafterphp) Wired in `etc/events.xml` to four events: - `catalogrule_rule_save_commit_after` / `catalogrule_rule_delete_commit_after` - `catalog_product_save_after` / `catalog_product_delete_after` We listen on `_save_commit_after` (not `_save_after`) for rules because Magento's catalog-rule save runs a **commit callback** that rebuilds `catalogrule_product_price` *after* the transaction. Listening earlier would race the rebuild and reindex against stale data. The observer reindexes (in realtime mode only — schedule mode lets cron catch up) and then calls the cache invalidator unconditionally. ### The cleaner — `Model/Cache/TagInvalidator.php` [](#the-cleaner--modelcachetaginvalidatorphp) Why a dedicated class instead of `CacheInterface::clean()`? Because some installs put the `default` and `page_cache` (FPC) frontends on **different Redis databases**. `CacheInterface::clean()` only touches the default frontend → FPC stays stale. Cleaning by cache *type* (`full_page`) is the opposite mistake — it nukes every FPC entry in the store and tanks hit rate. `TagInvalidator::invalidate()` iterates `Cache\Frontend\Pool` (which enumerates *every* configured frontend) and calls `clean(MATCHING_ANY_TAG, [cat_p, panth_salefilter])` on each. Surgical, safe across split Redis setups, and defensive — a single backend failure never stops the others. ### The Magento 2.4.7 FPC fix — `Plugin/Framework/App/PageCache/IdentifierGroupAwarePlugin.php` [](#the-magento-247-fpc-fix--pluginframeworkapppagecacheidentifiergroupawarepluginphp) Magento 2.4.7 moved FPC identifier logic to `IdentifierForSave`, which keys only on `$context->getVaryString()`. That string is empty at LOAD time because the customer ContextPlugin runs on `beforeExecute` (during dispatch) while FPC load happens earlier in `aroundDispatch`. Net effect: **whichever user warms the cache for a URL dictates what every other user sees** on the built-in FPC. A guest-warmed category page hides the "Yes" option for logged-in General / Wholesale / Retailer shoppers. This plugin's `aroundGetValue()` reads `X-Magento-Vary` straight off the incoming request cookie (the pre-2.4.7 behavior) and mixes it into the cache key, so each group ends up with its own FPC entry. The cookie is stable from request arrival to response dispatch, so LOAD and SAVE produce the same key within a single request. Wired in `etc/di.xml` against **both** `Identifier` and `IdentifierForSave` because Magento injects them separately for load vs save — patching only one gives mismatched keys and zero cache hits. ### Reading order [](#reading-order) FileWhat it does[`Block/LayeredNavigation/FilterRenderer.php`](Block/LayeredNavigation/FilterRenderer.php)Smart cache key (`getCacheKeyInfo`) + identity tags (`getIdentities`)[`etc/events.xml`](etc/events.xml)Subscribe observer to product / rule save / delete events[`Observer/CatalogRuleSaveAfter.php`](Observer/CatalogRuleSaveAfter.php)Reindex + call the invalidator[`Model/Cache/TagInvalidator.php`](Model/Cache/TagInvalidator.php)Walk every cache frontend, clean by tag[`Plugin/Framework/App/PageCache/IdentifierGroupAwarePlugin.php`](Plugin/Framework/App/PageCache/IdentifierGroupAwarePlugin.php)Restore cookie-aware FPC keying on Magento 2.4.7+--- Admin Index Grid ---------------- [](#admin-index-grid) **System → Panth Infotech → Sale Filter Index** — a UI-component grid over `panth_salefilter_product_index`. Useful for debugging a specific product or diffing the catalog after a rule change. [![Sale Filter Index grid](docs/images/admin-index-grid.png)](docs/images/admin-index-grid.png) ColumnDescriptionProduct IDMagento entity idSKUProduct SKUTypesimple / configurable / grouped / bundle / virtual / downloadableWebsiteWebsite code + idCustomer GroupGroup name + idRegular PricePre-discount priceSpecial PriceConfigured special price (if any)On SaleYes / No — the effective sale stateUpdated AtLast indexer write timestampRule PriceFinal price after the best applicable catalog ruleDiscount %Relative discount vs regular priceActive Catalog RulesComma list of matching rulesMatch Source`Catalog Rule` · `Special Price` · `Both`Grid filters include **on-sale only**, **match source**, and an **applicable rules** text filter. --- Indexing -------- [](#indexing) `panth_salefilter_product` appears in **System → Tools → Index Management**: [![Index Management](docs/images/admin-index-management.png)](docs/images/admin-index-management.png) ### Modes [](#modes) - **Update by Schedule** *(default)* — MView changelog captures changed product ids, Magento's `indexer_update_all_views` cron (runs every 1 minute by default) processes them. Recommended for production. - **Update on Save** — observers fire `reindexRow` inline on every relevant save. More DB writes during imports, but the storefront reflects changes instantly. Great for staging and debugging. Switch modes from the Index Management grid (Actions → Update Mode) or via CLI: ``` bin/magento indexer:set-mode schedule panth_salefilter_product bin/magento indexer:set-mode realtime panth_salefilter_product ``` --- Dated Discounts — When Does the Index Refresh? ---------------------------------------------- [](#dated-discounts--when-does-the-index-refresh) Our indexer is **event-driven**, not polling. Three triggers keep it fresh: ### 1. Immediate — save observers [](#1-immediate--save-observers) When you save a product or a catalog rule, `CatalogRuleSaveAfter` fires: - *Update on Save* → calls `$indexer->reindexRow($productId)` synchronously in the same request - *Update by Schedule* → the MView framework writes the changed ids into `panth_salefilter_product_cl` ### 2. MView changelog + Magento's indexer cron [](#2-mview-changelog--magentos-indexer-cron) The `mview.xml` subscription tracks: - `catalog_product_entity_decimal` (special\_price, price) - `catalog_product_entity_datetime` (special\_from\_date, special\_to\_date) - `catalogrule_product_price` (rule-computed per-product prices) - `catalog_product_relation` + `catalog_product_super_link` + `catalog_product_bundle_selection` (child/parent links) Magento's `indexer_update_all_views` cron runs **every 1 minute**. In *Update by Schedule* mode, our indexer catches up to any change within ~60 seconds. ### 3. The critical piece — daily catalog-rule refresh [](#3-the-critical-piece--daily-catalog-rule-refresh) **This is what handles dated discounts.** Magento ships a cron job `catalogrule_apply_all` (from `Magento\CatalogRule\Cron\DailyCatalogUpdate`) configured to run **every day at midnight**: ``` 0 0 * * * ``` It: 1. Recomputes `catalogrule_product_price` for the **current date** — rules whose window starts today come online, rules whose window ended yesterday drop out. 2. Fires `catalogrule_after_apply` — our observer catches this (realtime) or the mview changelog captures the `catalogrule_product_price` inserts (schedule). The same mechanism handles **dated `special_price`** via Magento's `catalog_product_price` indexer, which is invalidated nightly and rebuilds against today's date. ### Concrete timeline example [](#concrete-timeline-example) Create rule **"Summer Sale — 25% off"** with `from_date = 2026-06-01`, `to_date = 2026-06-30`, saved on 2026-04-20. Date/TimeWhat happens2026-04-20 14:33Rule saved. Our observer runs → index built **as of 2026-04-20**. Rule inactive, products NOT on sale yet.2026-04-20 14:34MView cron ticks — nothing to do, changelog empty.2026-05-31 23:59Last cron of the month — nothing changes, products still not on sale.**2026-06-01 00:00**`catalogrule_apply_all` fires. Rule is now active. `catalogrule_product_price` gets fresh rows. Our mview subscription detects the inserts.2026-06-01 00:01`indexer_update_all_views` ticks, processes our changelog → products flip to **On Sale**.2026-06-01 00:02First shopper hits `?sale_filter=1` and sees the newly-discounted products.**2026-07-01 00:00**`catalogrule_apply_all` runs. Rule expired. Rows deleted from `catalogrule_product_price`. Mview captures → products flip back to **Regular** within a minute.**Worst-case lag** for a discount starting/ending at a specific time: ~1 minute after midnight, bounded by the `index` cron group's schedule. ### Prerequisites [](#prerequisites) ``` # Magento's own cron must be running bin/magento cron:install # once, at setup # OS cron then invokes bin/magento cron:run every minute ``` If `bin/magento cron:run` is not firing, nothing time-gated works — not just our module, but **all** Magento price/rule scheduling. This is a baseline Magento requirement, not something our module adds. ### Force an immediate re-check [](#force-an-immediate-re-check) ``` bin/magento catalog:rule:apply-all # behave as if it's midnight right now bin/magento indexer:reindex panth_salefilter_product bin/magento cache:flush ``` --- URL Parameters -------------- [](#url-parameters) - `?sale_filter=1` — on-sale only - `?sale_filter=0` — regular-price only (honoured only while *Show Not On Sale Option* is enabled) Parameters are preserved across pagination (`&p=2`), per-page override (`&product_list_limit=24`), and sort (`&product_list_order=price&product_list_dir=desc`). --- CLI Reference ------------- [](#cli-reference) ``` # Full reindex bin/magento indexer:reindex panth_salefilter_product # …or our dedicated command (same effect, friendlier output) bin/magento panth_salefilter:reindex # Health check bin/magento panth_salefilter:status bin/magento indexer:status panth_salefilter_product # Switch modes bin/magento indexer:set-mode schedule panth_salefilter_product bin/magento indexer:set-mode realtime panth_salefilter_product # Refresh only catalog rules (as if midnight) bin/magento catalog:rule:apply-all # Clear caches tagged by this module bin/magento cache:clean panth_salefilter ``` --- Uninstall --------- [](#uninstall) ``` bin/magento module:disable Panth_SaleFilter composer remove mage2kishan/module-sale-filter bin/magento setup:upgrade ``` The `panth_salefilter_product_index` table and MView changelog are dropped automatically by `setup:upgrade` once the module is removed. --- Changelog --------- [](#changelog) ### 1.0.14 [](#1014) - **Fix:** sidebar "On Sale (N)" now mirrors every grid-applied constraint so the number always equals the post-click grid total. Covers: stock filter (`Display Out of Stock Products` Yes/No), every other active layered-nav filter (Brand, Color, Pattern, Size, Price range, category drill-down), and super-attribute filters on configurable products (resolved via `catalog_product_index_eav` expanded through `catalog_product_super_link`). - **Fix:** `?pattern=X&sale_filter=1` no longer broadens the grid. The plugin's `afterGetProductCollection` hook runs BEFORE the layered-navigation block populates `Layer::getState()`, so state-based filter mirroring silently missed every sibling filter and the module's custom `SearchResultApplier` (which bypasses ES when `ITEMS_FLAG` is set) then rendered the full category-wide on-sale set. Plugin now reads active filters from `$request->getParams()` and resolves each non-reserved key via `EavConfig`. - **Safety:** if a mirrored filter would zero the count (EAV super-attribute values tied to children outside the current category), skip the mirror rather than hide the sidebar option — wider approximate count is strictly better than a missing filter. - **Verified:** 56/56 PASS across indexer mode (realtime / schedule) × `show_out_of_stock` (0 / 1) × theme (Hyvä / Luma) × 3 categories × 4 cross-filter combinations (none, color=49, pattern=196, color+pattern) × pagination. ### 1.0.13 [](#1013) - **Fix:** stock filter is now honoured in the sidebar count and in the Plugin's `COUNT_FLAG`/`ITEMS_FLAG`. Previously a category with 48 in-stock on-sale items displayed "On Sale (69)" because the count collection included OOS products Magento core had already removed from the grid. ### 1.0.5 [](#105) - **Docs:** complete README rewrite with screenshots, animated admin-configuration GIF, full compatibility matrix, FAQ, and indexer-timing deep dive. ### 1.0.4 [](#104) - **Fix:** *Update on Save* mode now actually reindexes on product save (previously only flagged the index as stale, so changes weren't visible until someone ran `indexer:reindex` manually). ### 1.0.3 [](#103) - **Fix:** honour storefront sort (position / price asc-desc / name asc-desc) while the sale filter is active. Previously all sort directions returned the same slice in category position order. ### 1.0.2 [](#102) - **Fix:** correct grid + pager total under the ES-backed `Fulltext\Collection`. Replaces the default `SearchResultApplier` with a filter-aware variant; plugs `getSize()` to return the post-filter count. ### 1.0.1 [](#101) - **Fix:** count the full category, not just the visible page (toolbar pagination was leaking into the count query). ### 1.0.0 [](#100) - Initial release. --- Troubleshooting --------------- [](#troubleshooting) IssueCauseResolutionFilter option doesn't appear in sidebarModule disabled or indexer empty`bin/magento module:enable Panth_SaleFilter` and `bin/magento indexer:reindex panth_salefilter_product`Counts are wrong / staleFPC serving old markup`bin/magento cache:clean full_page block_html`Dated discount hasn't flipped on/offMagento cron not runningVerify `bin/magento cron:run` is scheduled in your OS crontab every minuteSidebar shows Regular option when it shouldn't"Show Not On Sale Option" is enabled but no regular products exist in scopeToggle it off in Stores → Configuration → Sale Filter, or verify your category has at least one non-discounted product`Consumer with the same name is running` when starting queue consumerStale MySQL lock from a crashed consumerClear stuck locks: `TRUNCATE queue_lock;` (backup first) or restart MySQLPager total wrong under ES (`of 24` with 12 filtered)Running < v1.0.2Upgrade to `^1.0.2`, reindex, flush FPCSort dropdown ignored with filter activeRunning < v1.0.3Upgrade to `^1.0.3`Sidebar "On Sale (N)" overcounts vs grid — includes out-of-stock products when *Display Out of Stock Products* is *No*Running < v1.0.13Upgrade to `^1.0.14`, reindex, flush FPCSidebar "On Sale (N)" doesn't shift when Brand/Color/Pattern is also activeRunning < v1.0.13Upgrade to `^1.0.14`, reindex, flush FPC`?pattern=X&sale_filter=1` renders MORE products than `?pattern=X` aloneRunning < v1.0.14 (plugin lost ES attribute filter when `ITEMS_FLAG` took over the Fulltext applier)Upgrade to `^1.0.14`, reindex, flush FPC"On Sale" sidebar missing entirely on a page with other filters activeRunning < v1.0.14 — an EAV-index mirror zeroed out the countUpgrade to `^1.0.14` (sidebar stays visible with a conservative count when EAV doesn't cover a super-attribute)Enable `bin/magento deploy:mode:set developer` and tail `var/log/system.log` for diagnostic output. --- FAQ --- [](#faq) ### Does this respect dated catalog rules? [](#does-this-respect-dated-catalog-rules) **Yes.** Dated rules flip automatically at the minute they start/end via Magento's built-in `catalogrule_apply_all` nightly cron, plus the `indexer_update_all_views` cron that runs every minute. See the [Dated Discounts](#dated-discounts--when-does-the-index-refresh) section for the full timeline. ### Will a configurable show as On Sale if one of its children is discounted? [](#will-a-configurable-show-as-on-sale-if-one-of-its-children-is-discounted) **Yes.** Parent aggregation is on by default — a configurable / grouped / bundle is marked on sale as soon as any eligible child is. Works for nested configurables too. ### Does it work with Elasticsearch / OpenSearch? [](#does-it-work-with-elasticsearch--opensearch) **Yes.** Tested on Elasticsearch 7/8 and OpenSearch 1/2. The module ships a custom `SearchResultApplier` that intersects the ES result set with our on-sale id list *before* paging slicing, so the grid shows the first N filtered products on page 1 (not the intersection of "first N ES ids" ∩ "on-sale ids"). ### Does it work on search-result pages, not just categories? [](#does-it-work-on-search-result-pages-not-just-categories) **Yes.** The filter is wired to both `Catalog\Model\Layer\Category` and `Catalog\Model\Layer\Search`. ### How fast is the filter? [](#how-fast-is-the-filter) On a 10 k SKU catalog with 4 customer groups, the index table is ~40 k rows and the layered-nav query hits it in <5 ms (btree index on `entity_id + customer_group_id + website_id`). The pager total is pre-computed once per request. ### Does it support multi-store / multi-website? [](#does-it-support-multi-store--multi-website) **Yes.** The index table is keyed by `(entity_id, customer_group_id, website_id)` so you get per-website discount states. Labels are store-scoped so each view can have its own translations. ### What's the difference between "Include Special Prices" and "Include Catalog Rules"? [](#whats-the-difference-between-include-special-prices-and-include-catalog-rules) Turn one off and the indexer ignores that discount source. Useful when a merchant only wants the filter to react to explicit special prices (not the dynamic catalog rules that affect the whole catalog). ### Can I style the filter differently on Luma vs Hyvä? [](#can-i-style-the-filter-differently-on-luma-vs-hyvä) **Yes.** Luma uses the default Knockout template; Hyvä uses the Alpine.js + Tailwind template shipped in the companion module. Both can be overridden in your theme via standard Magento template overrides. ### Does it support custom customer groups? [](#does-it-support-custom-customer-groups) **Yes.** The indexer walks all customer groups in the `customer_group` table, so a store with `NOT LOGGED IN`, `General`, `Wholesale`, `Retailer`, and any custom groups all get accurate per-group discount state. ### Can I uninstall cleanly? [](#can-i-uninstall-cleanly) **Yes.** `composer remove mage2kishan/module-sale-filter` + `setup:upgrade` drops the index table and mview changelog via declarative schema. ### Does it affect the Elasticsearch index size? [](#does-it-affect-the-elasticsearch-index-size) **No.** The filter uses a dedicated MySQL table; ES results are intersected post-query via our custom applier. ### Is the source code available? [](#is-the-source-code-available) **Yes.** MIT-style proprietary code, full source on GitHub at [github.com/mage2sk/module-sale-filter](https://github.com/mage2sk/module-sale-filter). --- Support ------- [](#support) ChannelContactEmailWebsite[kishansavaliya.com](https://kishansavaliya.com)WhatsApp+91 84012 70422GitHub Issues[github.com/mage2sk/module-sale-filter/issues](https://github.com/mage2sk/module-sale-filter/issues)Upwork (Top Rated Plus)[Hire Kishan Savaliya](https://www.upwork.com/freelancers/~016dd1767321100e21)Upwork Agency[Panth Infotech](https://www.upwork.com/agencies/1881421506131960778/)Packagist[mage2kishan/module-sale-filter](https://packagist.org/packages/mage2kishan/module-sale-filter)Response time: 1–2 business days. ### 💼 Need Custom Magento Development? [](#-need-custom-magento-development) Looking for **custom Magento module development**, **Hyvä theme customization**, **store migrations**, or **performance optimization**? Get a free quote in 24 hours: [ ![Get a Free Quote](https://camo.githubusercontent.com/0d9512dc4f89ef40179e9f650fd0786b6bc846d289ab2cb04a223a43f2833eeb/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f254630253946253932254143253230476574253230612532304672656525323051756f74652d6b697368616e736176616c6979612e636f6d2532466765742d2d71756f74652d4443323632363f7374796c653d666f722d7468652d6261646765) ](https://kishansavaliya.com/get-quote) [ ![Hire on Upwork](https://camo.githubusercontent.com/fad56e8be7896e39593f090cd2ed32e6bf86b4b6e75974cf292aee99d45f5077/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f486972652532304b697368616e2d546f702532305261746564253230506c75732d3134613830303f7374796c653d666f722d7468652d6261646765266c6f676f3d7570776f726b266c6f676f436f6c6f723d7768697465) ](https://www.upwork.com/freelancers/~016dd1767321100e21) [ ![Visit Agency](https://camo.githubusercontent.com/fdf45a9d937d72b896f5e2557337d47efebc0e06b7ad4d4c162c0a64375a62fa/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f56697369742d50616e7468253230496e666f746563682532304167656e63792d3134613830303f7374796c653d666f722d7468652d6261646765266c6f676f3d7570776f726b266c6f676f436f6c6f723d7768697465) ](https://www.upwork.com/agencies/1881421506131960778/) [ ![Visit Website](https://camo.githubusercontent.com/7455559317a374eb3eb536c5ea201ca2c2a29bc13d82cc127278975a680d552c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5669736974253230576562736974652d6b697368616e736176616c6979612e636f6d2d3044393438383f7374796c653d666f722d7468652d6261646765) ](https://kishansavaliya.com) **Specializations:** - 🛒 **Magento 2 Module Development** — custom extensions following MEQP standards - 🎨 **Hyvä Theme Development** — Alpine.js + Tailwind CSS, lightning-fast storefronts - 🖌️ **Luma Theme Customization** — pixel-perfect designs, responsive layouts - ⚡ **Performance Optimization** — Core Web Vitals, page speed, caching strategies - 🔍 **Magento SEO** — structured data, hreflang, sitemaps, AI-generated meta - 🛍️ **Checkout Optimization** — one-page checkout, conversion rate optimization - 🚀 **M1 to M2 Migrations** — data migration, custom feature porting - ☁️ **Adobe Commerce Cloud** — deployment, CI/CD, performance tuning - 🤖 **AI-Powered eCommerce** — OpenAI/Claude integration for content, search, recommendations - 🔌 **Third-party Integrations** — payment gateways, ERP, CRM, marketing tools **Industries served:** Fashion & Apparel, Electronics, Health & Beauty, Food & Beverage, Home & Garden, B2B Wholesale, Multi-vendor Marketplaces. --- License ------- [](#license) Proprietary. See [LICENSE](LICENSE). Commercial licence granted per Magento installation. --- About Panth Infotech -------------------- [](#about-panth-infotech) Built and maintained by **Kishan Savaliya** — [kishansavaliya.com](https://kishansavaliya.com) — a **Top Rated Plus** Magento developer on Upwork with 10+ years of eCommerce experience. **Panth Infotech** is a Magento 2 development agency specializing in high-quality, security-focused extensions and themes for both Hyvä and Luma storefronts. The Panth extension suite covers SEO, performance, checkout, product presentation, customer engagement, and store management — 34+ modules built to MEQP standards and tested across Magento 2.4.4 to 2.4.8. Browse the full extension catalog on the [Adobe Commerce Marketplace](https://commercemarketplace.adobe.com) or [Packagist](https://packagist.org/packages/mage2kishan/). ### Quick Links [](#quick-links) - 🌐 **Website:** [kishansavaliya.com](https://kishansavaliya.com) - 💬 **Get a Quote:** [kishansavaliya.com/get-quote](https://kishansavaliya.com/get-quote) - 👨‍💻 **Upwork Profile (Top Rated Plus):** [upwork.com/freelancers/~016dd1767321100e21](https://www.upwork.com/freelancers/~016dd1767321100e21) - 🏢 **Upwork Agency:** [upwork.com/agencies/1881421506131960778](https://www.upwork.com/agencies/1881421506131960778/) - 📦 **Packagist:** [packagist.org/packages/mage2kishan](https://packagist.org/packages/mage2kishan/) - 🐙 **GitHub:** [github.com/mage2sk](https://github.com/mage2sk) - 🛒 **Adobe Marketplace:** [commercemarketplace.adobe.com](https://commercemarketplace.adobe.com) - 📧 **Email:** - 📱 **WhatsApp:** +91 84012 70422 --- **Ready to upgrade your Magento 2 store?** [ ![Get Started](https://camo.githubusercontent.com/66dee04430af977df988ac18454416f2f08a5169868a0d0689061b7e8db6f8ca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f254630253946253941253830253230476574253230537461727465642532302545322538362539322d4672656525323051756f7465253230696e2532303234682d4443323632363f7374796c653d666f722d7468652d6261646765) ](https://kishansavaliya.com/get-quote) --- **SEO Keywords:** magento 2 on sale filter, magento 2 sale filter, magento 2 layered navigation sale, magento 2 shop by sale, magento 2 discount filter, magento 2 catalog rule filter, magento 2 special price filter, magento 2 category filter extension, magento 2 on sale badge indexer, magento 2 sale status filter, hyva sale filter, luma sale filter, hyva layered navigation, magento 2 hyva module, magento 2 elasticsearch sale filter, magento 2 opensearch sale filter, magento 2 configurable on sale, magento 2 parent child sale aggregation, magento 2 dated discount indexer, magento 2 catalog rule indexer, magento 2 conversion rate optimization, panth infotech, mage2kishan, mage2sk, kishan savaliya magento, top rated plus upwork magento, hire magento developer, magento 2.4.8 module, magento 2.4.7 module, php 8.4 magento module, magento marketplace extension, meqp compliant magento module, custom magento development, magento 2 hyva development, magento 2 luma customization, magento 2 performance optimization, magento 2 SEO services, adobe commerce cloud magento, magento 2 checkout optimization, ai ecommerce magento, magento freelancer india, panth sale filter, panth extensions ### Health Score 43 — FairBetter than 89% of packages Maintenance97 Actively maintained with recent releases Popularity0 Limited adoption so far Community8 Small or concentrated contributor base Maturity60 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~1 days Total 18 Last Release 32d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/343e344aa298f189db888b32d62f9202d31ced1a5ea23411850a63dc4a30299c?d=identicon)[kishansavaliya](/maintainers/kishansavaliya) --- Top Contributors [![KishanSavaliya](https://avatars.githubusercontent.com/u/16853223?v=4)](https://github.com/KishanSavaliya "KishanSavaliya (20 commits)") --- Tags seomagento2layered-navigationmagento2 modulepanthsale-filter ### Embed Badge ![Health badge](/badges/mage2kishan-module-sale-filter/health.svg) ``` [![Health](https://phpackages.com/badges/mage2kishan-module-sale-filter/health.svg)](https://phpackages.com/packages/mage2kishan-module-sale-filter) ``` ### Alternatives [mollie/magento2 Mollie Payment Module for Magento 2 1131.8M12](/packages/mollie-magento2)[dotdigital/dotdigital-magento2-extension Dotdigital for Magento 2 50390.4k20](/packages/dotdigital-dotdigital-magento2-extension)[run-as-root/magento2-prometheus-exporter Magento2 Prometheus Exporter 68353.9k](/packages/run-as-root-magento2-prometheus-exporter)[opengento/module-category-import-export This module add the capability to import and export the categories from the back-office. 1310.2k1](/packages/opengento-module-category-import-export)[loki/magento2-admin-components Admin Panel grids and forms created via Loki Components 173.7k7](/packages/loki-magento2-admin-components)[buckaroo/magento2 Buckaroo Magento 2 extension 32414.8k7](/packages/buckaroo-magento2) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)