Magento - Programmatically create custom product attribute via set up script

Magento - Programmatically create custom product attribute via set up script

September 14, 2026 · Illustrated author avatarBy Stefan Bogdanescu
Magento - Programmatically create custom product attribute via set up script

Creating custom product attributes programmatically via Magento setup script can indeed be a challenge for developers new to the platform. In your case, there are a few areas we need to address to ensure that your custom attribute appears in the admin backend.

Let’s first look at your existing code and identify potential issues:

  1. Use of Mage_Eav_Model_Entity_Setup: While this is the standard class for Magento installers, it seems you’re using Rts_Cattribute_Model_Resource_Eav_Mysql4_Setup which extends Mage_Eav_Model_Entity_Setup. This might not be optimal when working with product attributes since Mage_Eav_Model_Entity_Setup doesn’t directly handle catalog-related operations.

  2. Custom attribute setup: In your install script, you’re using Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL for the global scope of your custom attribute. However, if you want this attribute to be available across all attribute sets and websites, you should set it to Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL.

  3. Install script execution: Make sure that your install script is being executed correctly during the Magento installation process or via an upgrade script.

Here’s a corrected version of your setup file:

class Rts_Cattribute_Model_Resource_Eav_Mysql4_Setup extends Mage_Eav_Model_Entity_Setup
{
    protected function _prepareValues($attr)
    {
        $data = parent::_prepareValues($attr);
        $data = array_merge($data, array(
            // ... existing data ...
            'is_global' => $this->_getValue(
                $attr,
                'global',
                Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL
            ),
            // ... remaining data ...
        ));
        return $data;
    }
}

And your install script should look like this:

$installer = $this;

$installer->startSetup();

$installer->addAttribute('catalog_product', 'max_ftlbs', array(
    'type'              => 'int',
    // ... other attribute data ...
    'global'            => Mage_Catalog_Model_Resource_Eav_Attribute::SCOPE_GLOBAL,
    // ... remaining data ...
));

$installer->endSetup();

Remember that when working with Magento setup scripts, you should always use the specific resource model for the entity you’re dealing with. In this case, Mage_Catalog_Model_Resource_Eav_Attribute is more appropriate than its generic counterpart.

Additionally, ensure that your config file specifies the correct class and module name:

<global>
    <resources>
        <cattribute_setup>
            <setup>
                <module>Rts_Cattribute</module>
                <class>Rts_Cattribute_Model_Resource_Eav_Mysql4_Setup</class>
            </setup>
        </cattribute_setup>
    </resources>
</global>

After making these changes, clear your cache and refresh the product attributes page in the admin backend. The new attribute should now appear.

If you’re still encountering issues, double-check that your setup script is being executed correctly during the Magento installation or upgrade process. You can also try running the script manually using the command php magento setup:upgrade.

Remember to always test your changes in a development environment before applying them to a live site.

In conclusion, creating custom product attributes via Magento setup scripts requires careful configuration of the resource model and attribute data. By ensuring you use the appropriate classes and correctly specifying your attribute settings, you can successfully create new attributes that appear in the admin backend.

For more detailed information on Magento setup scripts and working with custom attributes, I recommend checking out our comprehensive guide at Laravel Company’s Magento Development Blog.

Happy coding!

Catalog Database Admin Deployment

Our network