How to Add Custom dropdown type Attribute in Category Form in Magento 2

Spread the love

In this blog post, we will learn how to create a custom dropdown attribute using data Patch in Magento 2. By following the steps outlined below, we can easily add any type of attribute, such as text or dropdown, in the category form.

Step 1: Module Creation

First, create a module by following these steps:

Create a file named module.xml under the directory app/code/Bluethinkinc/CustomCategory/etc with the following content.

<?xml version="1.0"?>
 <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Bluethinkinc_CustomCategory">
        <sequence>
            <module name="Magento_Catalog"/>
            <module name="Magento_Backend"/>
        </sequence>
    </module>
</config>

<?xml version="1.0"?>

</sequence>

</module>

</config>

Step 2: Register the Module

Create a registration.php file to register your module with the following content.

<?php
\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Bluethinkinc_CustomCategory',
    __DIR__
);

<?php

\Magento\Framework\Component\ComponentRegistrar::register(

\Magento\Framework\Component\ComponentRegistrar::MODULE,

'Bluethinkinc_CustomCategory',

__DIR__

);

Step:3 Create a Data Patch

Create a Data Patch to create your custom attribute with the below content under following file path

Bluethinkinc\CustomCategory\Setup\Patch\Data\ AddCustomCategoryAttribute.php

<?php

namespace Bluethinkinc\CustomCategory\Setup\Patch\Data;

use Magento\Framework\Setup\Patch\DataPatchInterface;
use Magento\Framework\Setup\Patch\PatchRevertableInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Eav\Setup\EavSetup;
use Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface;
use Magento\Eav\Model\Entity\Attribute\Backend\ArrayBackend;

/**
 * Class AddCustomCategoryAttribute
 *
 */
class AddCustomCategoryAttribute implements DataPatchInterface, PatchRevertableInterface
{

    /**
     * @var ModuleDataSetupInterface
     */
    private $moduleDataSetup;

    /**
     * @var EavSetupFactory
     */
    private $eavSetupFactory;

    /**
     * Constructor
     *
     * @param ModuleDataSetupInterface $moduleDataSetup
     * @param EavSetupFactory $eavSetupFactory
     */
    public function __construct(
        ModuleDataSetupInterface $moduleDataSetup,
        EavSetupFactory $eavSetupFactory
    ) {
        $this->moduleDataSetup = $moduleDataSetup;
        $this->eavSetupFactory = $eavSetupFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function apply()
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        /** @var EavSetup $eavSetup */
        $eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);
        $eavSetup->addAttribute(
            \Magento\Catalog\Model\Product::ENTITY,
            'custom_category',
            [
                'type' => 'varchar',
                'label' => 'Custom Category',
                'input' => 'select',
                'frontend' => '',
                'required' => true,
                'backend' => ArrayBackend::class,
                'sort_order' => '30',
                'global' => ScopedAttributeInterface::SCOPE_GLOBAL,
                'default' => null,
                'visible' => true,
                'group' => 'General Information'
            ]
        );

        $this->moduleDataSetup->getConnection()->endSetup();
    }

    public function revert()
    {
        $this->moduleDataSetup->getConnection()->startSetup();
        /** @var EavSetup $eavSetup */
        $eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);
        $eavSetup->removeAttribute(\Magento\Catalog\Model\Product::ENTITY, 'custom_category');

        $this->moduleDataSetup->getConnection()->endSetup();
    }

    /**
     * {@inheritdoc}
     */
    public function getAliases()
    {
        return [];
    }

    /**
     * {@inheritdoc}
     */
    public static function getDependencies()
    {
        return [];
    }
}

<?php

namespace Bluethinkinc\CustomCategory\Setup\Patch\Data;

use Magento\Framework\Setup\Patch\DataPatchInterface;

use Magento\Framework\Setup\Patch\PatchRevertableInterface;

use Magento\Framework\Setup\ModuleDataSetupInterface;

use Magento\Eav\Setup\EavSetupFactory;

use Magento\Eav\Setup\EavSetup;

use Magento\Eav\Model\Entity\Attribute\ScopedAttributeInterface;

use Magento\Eav\Model\Entity\Attribute\Backend\ArrayBackend;

/**

* Class AddCustomCategoryAttribute

class AddCustomCategoryAttribute implements DataPatchInterface, PatchRevertableInterface

{

/**

* @var ModuleDataSetupInterface

private $moduleDataSetup;

/**

* @var EavSetupFactory

private $eavSetupFactory;

/**

* Constructor

* @param ModuleDataSetupInterface $moduleDataSetup

* @param EavSetupFactory $eavSetupFactory

public function __construct(

ModuleDataSetupInterface $moduleDataSetup,

EavSetupFactory $eavSetupFactory

) {

$this->moduleDataSetup = $moduleDataSetup;

$this->eavSetupFactory = $eavSetupFactory;

}

/**

* {@inheritdoc}

public function apply()

{

$this->moduleDataSetup->getConnection()->startSetup();

/** @var EavSetup $eavSetup */

$eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);

$eavSetup->addAttribute(

\Magento\Catalog\Model\Product::ENTITY,

'custom_category',

[

'type' => 'varchar',

'label' => 'Custom Category',

'input' => 'select',

'frontend' => '',

'required' => true,

'backend' => ArrayBackend::class,

'sort_order' => '30',

'global' => ScopedAttributeInterface::SCOPE_GLOBAL,

'default' => null,

'visible' => true,

'group' => 'General Information'

]

);

$this->moduleDataSetup->getConnection()->endSetup();

}

public function revert()

{

$this->moduleDataSetup->getConnection()->startSetup();

/** @var EavSetup $eavSetup */

$eavSetup = $this->eavSetupFactory->create(['setup' => $this->moduleDataSetup]);

$eavSetup->removeAttribute(\Magento\Catalog\Model\Product::ENTITY, 'custom_category');

$this->moduleDataSetup->getConnection()->endSetup();

}

/**

* {@inheritdoc}

public function getAliases()

{

return [];

}

/**

* {@inheritdoc}

public static function getDependencies()

{

return [];

}

Step 4: Create Custom Options

Create a file named CustomOptions.php under the directory Bluethinkinc\CustomCategory\Model\Config\Source with the following content, This file is responsible for the options which you want to show in your category form dropdown attribute.

<?php

namespace Bluethinkinc\CustomCategory\Model\Config\Source;

use Magento\Eav\Model\Entity\Attribute\Source\AbstractSource;

class CustomOptions extends AbstractSource
{
    public function getAllOptions()
    {
        $options = [
            0 => ['label' => 'Bluethinkinc One','value' => 10],
            1 => ['label' => 'Bluethinkinc Two','value' => 20],
            2 => ['label' => 'Bluethinkinc Three','value' => 30],
        ];
        return $options;
    }
}

<?php

namespace Bluethinkinc\CustomCategory\Model\Config\Source;

use Magento\Eav\Model\Entity\Attribute\Source\AbstractSource;

class CustomOptions extends AbstractSource

{

public function getAllOptions()

{

$options = [

0 => ['label' => 'Bluethinkinc One','value' => 10],

1 => ['label' => 'Bluethinkinc Two','value' => 20],

2 => ['label' => 'Bluethinkinc Three','value' => 30],

];

return $options;

}

Step:5 Finally, Create category_form.xml under

Bluethinkinc\CustomCategory\view\adminhtml\ui_component directory.

<?xml version="1.0" encoding="UTF-8"?>
<form xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <fieldset name="general">
        <field name="custom_select_dropdown">
            <argument name="data" xsi:type="array">
                <item name="options" xsi:type="object">Bluethinkinc\CustomCategory\Model\Config\Source\CustomOptions</item>
                <item name="config" xsi:type="array">
                    <item name="label" xsi:type="string" translate="true">Custom Select Attribute</item>
                    <item name="visible" xsi:type="boolean">true</item>
                    <item name="dataType" xsi:type="string">text</item>
                    <item name="formElement" xsi:type="string">select</item>
                    <item name="source" xsi:type="string">custom_select_dropdown</item>
                    <item name="dataScope" xsi:type="string">custom_select_dropdown</item>
                    <item name="sortOrder" xsi:type="number">40</item>
                </item>
            </argument>
        </field>
    </fieldset>
</form>