Magento - add custom "Widget Options"

Magento - add custom "Widget Options"

August 25, 2026 · Illustrated author avatarBy Stefan Bogdanescu
Magento - add custom "Widget Options"

Adding Custom Widget Options in Magento

In Magento, it is indeed possible to add custom “Widget Options” as input text fields when creating a new widget instance. This can be achieved by following these steps:

Understanding the Widget System

Magento’s widget system allows you to create reusable content blocks for your site. Each widget has a set of configurable options that are stored in the database. By default, Magento provides various widgets like Calendar, Poll, and Newsletter Signup.

Creating Custom Widget Options

To add custom text fields as options for a new widget instance, you’ll need to create an extension that overrides the core widget system. Here’s a high-level overview:

  1. Create a new module. In your Magento directory, navigate to app/code/local and create a new folder structure like companyname/modulename.

  2. Override the Widget Options.

    You’ll need to override the Mage_Widget_Model_Widget class. Create a file named Widget.php in app/code/local/companyname/modulename/Model/ and add the following code:

<?php

class Companyname_Modulename_Model_Widget extends Mage_Widget_Model_Widget
{
    public function getOptions()
    {
        $options = parent::getOptions();

        // Add custom options here
        $options[] = array(
            'label' => 'Custom Option',
            'name'  => 'custom_option',
            'type'  => 'text'
        );

        return $options;
    }
}

In this example, we’re adding a new option called “Custom Option” with the type set to “text.” You can modify the label and name as per your requirements.

  1. Configure the Widget Instance.

    When you create or edit a widget instance in the Magento backend, you should now see an additional field labeled “Custom Option” where you can enter text data.

Storing Data in a Separate Database Table

To store the custom option data in a separate table, you’ll need to extend the Mage_Widget_Model_Widget_Option class. Here’s how:

  1. Create a new database table.

    Add a new table to your Magento database with columns to store the widget ID and the custom option value.

  2. Override the Option Save Method.

    Create a file named Option.php in app/code/local/companyname/modulename/Model/ and add the following code:

<?php

class Companyname_Modulename_Model_Option extends Mage_Widget_Model_Widget_Option
{
    protected function _afterSave()
    {
        $optionValue = $this->getData('value');

        // Save the custom option value to your new database table here...
    }
}

In the _afterSave() method, you can write the logic to save the custom_option data from step 2 into your newly created database table.

Conclusion

Adding custom widget options in Magento requires a good understanding of the core widget system and some basic extension development. By overriding the Mage_Widget_Model_Widget class and adding new options, you can extend the functionality of existing widgets or create entirely new ones with additional configuration fields.

Remember to test your extension thoroughly before deploying it to a production environment. For more advanced customizations, consider reaching out to professional Magento developers at Laravel Company for expert guidance and support.

Happy coding!

Database Extensions Configuration

Our network