Skip to content

Fix: Decouple product detail swatches from listing attribute requirement #5137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Fix: Decouple product detail swatches from listing attribute requirement #5137

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
abb3ee4
Initial plan
Copilot Dec 7, 2025
be38022
Separate product detail and listing swatch configuration checks
Copilot Dec 7, 2025
236f4b9
Add caching to isEnabledForProductDetail() for performance improvement
Copilot Dec 22, 2025
81c6f57
Add docblock comments to cached properties for clarity
Copilot Dec 22, 2025
7398309
Fix PHPDoc type order to null|bool for PHP CS Fixer compliance
Copilot Dec 22, 2025
9304aaf
Merge branch 'main' into copilot/fix-swatches-display-bug
addison74 Dec 22, 2025
8bd629c
Improve property docblock descriptions to be more descriptive
Copilot Dec 22, 2025
29161cf
Fix fatal error when listing attribute is not configured
Copilot Dec 22, 2025
fd595b0
Fix formatting of multi-line condition
Copilot Dec 22, 2025
0b9dc20
Use instanceof for more robust type checking in null checks
Copilot Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion app/code/core/Mage/ConfigurableSwatches/Block/Catalog/Media/Js/Abstract.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,10 @@ public function getImageType()
*/
protected function _toHtml()
{
if (!Mage::helper('configurableswatches')->isEnabled()) { // functionality disabled
// Check if swatches are enabled for either listing or product detail
if (!Mage::helper('configurableswatches')->isEnabled()
&& !Mage::helper('configurableswatches')->isEnabledForProductDetail()
) {
return ''; // do not render block
}

Expand Down
2 changes: 1 addition & 1 deletion .../core/Mage/ConfigurableSwatches/Block/Catalog/Product/View/Type/Configurable/Swatches.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class Mage_ConfigurableSwatches_Block_Catalog_Product_View_Type_Configurable_Swa
*/
public function shouldRender($attribute, $jsonConfig)
{
if (Mage::helper('configurableswatches')->isEnabled()) {
if (Mage::helper('configurableswatches')->isEnabledForProductDetail()) {
if (Mage::helper('configurableswatches')->attrIsSwatchType($attribute->getProductAttribute())) {
$this->_init($jsonConfig);
return true;
Expand Down
16 changes: 14 additions & 2 deletions app/code/core/Mage/ConfigurableSwatches/Helper/Data.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ class Mage_ConfigurableSwatches_Helper_Data extends Mage_Core_Helper_Abstract
protected $_configAttributeIds = null;

/**
* Is the extension enabled?
* Is the extension enabled for product listing?
* Requires both general enabled flag and listing attribute to be set.
*
* @return bool
*/
Expand All @@ -43,6 +44,17 @@ public function isEnabled()
return $this->_enabled;
}

/**
* Is the extension enabled for product detail page?
* Only requires general enabled flag, independent of listing configuration.
*
* @return bool
*/
public function isEnabledForProductDetail()
{
return Mage::getStoreConfigFlag(self::CONFIG_PATH_ENABLED);
}

/**
* Return the formatted hyphenated string
*
Expand Down Expand Up @@ -126,7 +138,7 @@ public function getSwatchesProductJs()
{
/** @var Mage_Catalog_Model_Product $product */
$product = Mage::registry('current_product');
if ($this->isEnabled() && $product) {
if ($this->isEnabledForProductDetail() && $product) {
$configAttrs = $this->getSwatchAttributeIds();
/** @var Mage_Catalog_Model_Product_Type_Configurable $productType */
$productType = $product->getTypeInstance(true);
Expand Down
5 changes: 4 additions & 1 deletion app/code/core/Mage/ConfigurableSwatches/Helper/Productimg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,10 @@ public function clearSwatchesCache()
*/
public function filterImageInGallery($product, $image)
{
if (!Mage::helper('configurableswatches')->isEnabled()) {
// Check if swatches are enabled for either listing or product detail
if (!Mage::helper('configurableswatches')->isEnabled()
&& !Mage::helper('configurableswatches')->isEnabledForProductDetail()
) {
return true;
}

Expand Down
10 changes: 8 additions & 2 deletions app/code/core/Mage/ConfigurableSwatches/Model/Observer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,10 @@ public function productListCollectionLoadAfter(Varien_Event_Observer $observer)
*/
public function productLoadAfter(Varien_Event_Observer $observer)
{
if (!Mage::helper('configurableswatches')->isEnabled()) { // functionality disabled
// Check if swatches are enabled for either listing or product detail
if (!Mage::helper('configurableswatches')->isEnabled()
&& !Mage::helper('configurableswatches')->isEnabledForProductDetail()
) {
return; // exit without loading swatch functionality
}

Expand All @@ -91,7 +94,10 @@ public function productLoadAfter(Varien_Event_Observer $observer)
*/
public function loadChildProductImagesOnMediaLoad(Varien_Event_Observer $observer)
{
if (!Mage::helper('configurableswatches')->isEnabled()) { // functionality disabled
// Check if swatches are enabled for either listing or product detail
if (!Mage::helper('configurableswatches')->isEnabled()
&& !Mage::helper('configurableswatches')->isEnabledForProductDetail()
) {
return; // exit without loading swatch functionality
}

Expand Down
Loading