Add a checkbox to product image gallery (like "Disable/Exclude")

Add a checkbox to product image gallery (like "Disable/Exclude")

August 25, 2026 · Illustrated author avatarBy Stefan Bogdanescu
Add a checkbox to product image gallery (like "Disable/Exclude")

Enabling/Disabling Product Images for “Use as Page” Functionality

As an experienced developer working on Magento-based e-commerce platforms, I often encounter requests to add new features like enabling or disabling product images for specific purposes. In this post, we’ll address a common question: how to add a “Use as page” checkbox to the image gallery and update the database accordingly.

The Current Scenario

The user has already made some progress:

  • They have added a new field called page (tinyint(4)) to the table catalog_product_entity_media_gallery_value.
  • They have updated the class Mage_Catalog_Model_Product_Attribute_Backend_Media to include this new field in the data array.
  • They have made necessary changes to the template file for displaying the gallery.

However, they are facing two main challenges:

  1. Updating data in the database: The “page” field isn’t being updated correctly when a checkbox is toggled.
  2. Retrieving and checking/unchecking the checkbox: The current state of the page field isn’t reflected on the frontend.

Resolving the Database Update Issue

To update the page field in the database, we need to modify the save() method in the Mage_Catalog_Model_Product_Attribute_Backend_Media class. Here’s how it can be done:

public function save($object)
{
    // ... existing code ...

    $mediaGallery = $this->getMediaGallery();
    $mediaGalleryData = $this->_beforeSave($object, $mediaGallery);

    if ($mediaGalleryData) {
        foreach ($mediaGallery as $imageKey => $image) {
            $image['page'] = (int)$this->getRequest()->getParam('page', 0);
        }

        // Save the data
        Mage::getModel('catalog/product_gallery')->saveImages($object->getId(), $mediaGalleryData);

        // ... existing code ...
    }
}

In this updated save() method, we retrieve the page parameter from the request. If it’s not provided (which means the checkbox is unchecked), we default to 0. Otherwise, we use its value.

Retrieving and Checking/Unchecking the Checkbox

To reflect the database state on the frontend, we need to modify the template file for displaying the gallery:

<td class="cell-page a-center"&gt;
    &lt;input type="checkbox"
        <?php if($_block->getElement()->getReadonly()):?>&lt; disabled="disabled"&gt;&lt;?php endif;?&gt;
        onclick="<?php echo $_block->getJsObjectName(); ?>.updateImage('__file__')"
        <?php if($image['page'] == 1):?>checked="checked"<?php endif;?> /&gt;
&lt;/td&gt;

Here, we check if the page field is 1 (true) or not. If it’s true, we add the checked attribute to the checkbox.

Conclusion

Adding a “Use as page” functionality requires careful updating of both the database schema and the application logic responsible for saving and retrieving product image data.

Remember that Magento is a complex system with many interconnected components. Changes in one area can have ripple effects elsewhere. Always ensure you understand the impact before making modifications to core files.

For more advanced customizations like this, consider using Magento extensions or a platform built on top of Magento, such as Laravel Company’s Magento 2 extension for enhanced performance and features.

Happy coding! Let me know if you need any further assistance with your Magento development projects.

Catalog Database Themes Admin

Our network