{"id":892,"date":"2023-12-05T18:44:29","date_gmt":"2023-12-05T13:14:29","guid":{"rendered":"https:\/\/magecurious.com\/blog\/?p=892"},"modified":"2024-11-18T00:37:13","modified_gmt":"2024-11-17T19:07:13","slug":"how-to-create-customer-attribute-using-data-patch-in-magento-2","status":"publish","type":"post","link":"https:\/\/magecurious.com\/blog\/how-to-create-customer-attribute-using-data-patch-in-magento-2\/","title":{"rendered":"How To Create Customer Attribute using Data Patch in Magento 2"},"content":{"rendered":"\n

Hello Everyone,<\/p>\n\n\n\n

In this blog, we will learn about how to Create Custom Customer Attributes using Data Patch in Magento 2.<\/p>\n\n\n\n

Data Patch feature is introduced from Magento 2.3.x.<\/p>\n\n\n\n

Without wasting your time, let us guide you straight away. Follow the easy step given below to Create Customer Attribute in Magento 2.<\/p>\n\n\n\n

STEPS FOR CREATE CUSTOM CUSTOMER ATTRIBUTE IN MAGENTO 2<\/strong><\/h2>\n\n\n\n

Step 1: Create CustomerAttribute.php file<\/strong><\/p>\n\n\n\n

app\/code\/Vendor\/Extension\/Setup\/Patch\/Data\/CustomerAttribute.php<\/strong><\/p>\n\n\n

\n&lt;?php\nnamespace Vendor\\Extension\\Setup\\Patch\\Data;\n\nuse Magento\\Customer\\Model\\Customer;\nuse Magento\\Customer\\Setup\\CustomerSetup;\nuse Magento\\Customer\\Setup\\CustomerSetupFactory;\nuse Magento\\Eav\\Model\\Entity\\Attribute\\Set;\nuse Magento\\Eav\\Model\\Entity\\Attribute\\SetFactory;\nuse Magento\\Framework\\Setup\\ModuleDataSetupInterface;\nuse Magento\\Framework\\Setup\\Patch\\DataPatchInterface;\nuse Magento\\Framework\\Setup\\Patch\\PatchRevertableInterface;\n\nclass CustomerAttribute implements DataPatchInterface, PatchRevertableInterface\n{\n\n    \/**\n     * @var ModuleDataSetupInterface\n     *\/\n    private $moduleDataSetup;\n    \/**\n     * @var CustomerSetup\n     *\/\n    private $customerSetupFactory;\n    \/**\n     * @var SetFactory\n     *\/\n    private $attributeSetFactory;\n\n    \/**\n     * Constructor\n     *\n     * @param ModuleDataSetupInterface $moduleDataSetup\n     * @param CustomerSetupFactory $customerSetupFactory\n     * @param SetFactory $attributeSetFactory\n     *\/\n    public function __construct(\n        ModuleDataSetupInterface $moduleDataSetup,\n        CustomerSetupFactory     $customerSetupFactory,\n        SetFactory               $attributeSetFactory\n    )\n    {\n        $this->moduleDataSetup = $moduleDataSetup;\n        $this->customerSetupFactory = $customerSetupFactory;\n        $this->attributeSetFactory = $attributeSetFactory;\n    }\n\n    \/**\n     * {@inheritdoc}\n     *\/\n    public function apply()\n    {\n        $this->moduleDataSetup->getConnection()->startSetup();\n        \/** @var CustomerSetup $customerSetup *\/\n        $customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);\n        $customerEntity = $customerSetup->getEavConfig()->getEntityType(Customer::ENTITY);\n        $attributeSetId = $customerEntity->getDefaultAttributeSetId();\n\n        \/** @var $attributeSet Set *\/\n        $attributeSet = $this->attributeSetFactory->create();\n        $attributeGroupId = $attributeSet->getDefaultGroupId($attributeSetId);\n\n        $customerSetup->addAttribute(\n            Customer::ENTITY,\n            'mobile_number',\n            [\n\t     'input' => 'text',\n                'type' => 'varchar',\n                'label' => 'Mobile Number', \n                'source' => '',\n                'required' => false,\n                'position' => 40,\n                'visible' => true,\n                'system' => false,\n                'is_used_in_grid' => true,\n                'is_visible_in_grid' => true,\n                'is_filterable_in_grid' => true,\n                'is_searchable_in_grid' => false,\n                'backend' => ''\n            ]\n        );\n\n        $attribute = $customerSetup->getEavConfig()->getAttribute(Customer::ENTITY, 'mobile_number');\n        $attribute->addData([\n            'used_in_forms' => [\n                'adminhtml_customer',\n                'customer_account_create',\n                'customer_account_edit'\n            ]\n        ]);\n        $attribute->addData([\n            'attribute_set_id' => $attributeSetId,\n            'attribute_group_id' => $attributeGroupId\n\n        ]);\n        $attribute->save();\n\n        $this->moduleDataSetup->getConnection()->endSetup();\n    }\n\n    public function revert()\n    {\n        $this->moduleDataSetup->getConnection()->startSetup();\n        \/** @var CustomerSetup $customerSetup *\/\n        $customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);\n        $customerSetup->removeAttribute(\\Magento\\Customer\\Model\\Customer::ENTITY, 'mobile_number');\n\n        $this->moduleDataSetup->getConnection()->endSetup();\n    }\n\n    \/**\n     * {@inheritdoc}\n     *\/\n    public function getAliases()\n    {\n        return [];\n    }\n\n    \/**\n     * {@inheritdoc}\n     *\/\n    public static function getDependencies()\n    {\n        return [];\n    }\n}\n<\/pre><\/div>\n\n\n
In above code we created text type attribute you can change as per your requirements.<\/p>\n\n\n\n
Step 2: Finally run the below commands<\/strong><\/p>\n\n\n
\n$ php bin\/magento setup:upgrade\n$ php bin\/magento cache:clean\n$ php bin\/magento cache:flush\n<\/pre><\/div>\n\n\n
Step 3: Output:<\/strong><\/p>\n\n\n\n
\"\"\/<\/figure>\n\n\n\n
Above created custom customer attribute is stored in  eav_attribute table.<\/p>\n\n\n\n
Now go to Admin -> Customers -> All Customers -> Edit -> Account Information. <\/p>\n\n\n\n
Final Thoughts:<\/strong><\/h2>\n\n\n\n
So this was the easiest way which we have told you in this blog. This is how you can Create Custom Customer Attribute in Magento 2. Hope you liked the blog.<\/p>\n\n\n\n
So quickly go to the comment box and tell me how you like this blog?<\/p>\n\n\n\n
Stay tuned with us on our site to get new updates of Magento.<\/strong><\/p>\n\n\n\n
Thanks for reading and visiting our site.<\/p>\n\n\n
      
          
        How useful was this post?      <\/p>              
        Click on a star to rate it!      <\/p>        
      
                      
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>                  
  •               <\/i>          <\/li>              <\/ul>    <\/div>    
    <\/p>