How to create customer attribute programmatically in magento2?

For example, when we create a mobile number customer attribute in Magento 2, we need to create a module to add new customer attribute in Magento2.

Create a registration.php file to the following path
app/code/Magemonkeys/CustomerAttribute/registration.php

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

<?php

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

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

'Magemonkeys_CustomerAttribute',

__DIR__

);

Create module.xml file to the following path app/code/Magemonkeys/CustomerAttribute/etc/module.xml which define our module setup version to setup_module table.

<?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="Magemonkeys_CustomerAttribute" setup_version="1.0.0">
    <sequence>
      <module name="Magento_Customer"/>
    </sequence>
  </module>
</config>

<?xml version="1.0" ?>

</sequence>

</module>

</config>

Then, we need to create an extension_attributes.xml file to the following path app/code/Magemonkeys/CustomerAttribute/etc/extension_attributes.xml

which defines our mobile number customer attribute.

Pass Classname in extension_attributes.xml as Magento\Customer\Api\Data\CustomerInterface because its a base Customer interface to create customer attributes in Magento2.

Set attribute code as your customer attribute code and define type as a string.

<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Api/etc/extension_attributes.xsd">
    <extension_attributes for="Magento\Customer\Api\Data\CustomerInterface">
        <attribute code="mobile" type="string"/>
    </extension_attributes>
</config>

<?xml version="1.0" ?>

<extension_attributes for="Magento\Customer\Api\Data\CustomerInterface">

</extension_attributes>

</config>

For Create Customer attribute we need to define InstallData.php file to the following path app/code/Magemonkeys/CustomerAttribute/Setup/InstallData.php which adds an entry to our database for custom mobile number attribute.

<?php

namespace Magemonkeys\CustomerAttribute\Setup;

use Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Customer\Model\Customer;
use Magento\Customer\Setup\CustomerSetupFactory;

class InstallData implements InstallDataInterface
{

    private $customerSetupFactory;

    /**
     * Constructor
     *
     * @param \Magento\Customer\Setup\CustomerSetupFactory $customerSetupFactory
     */
    public function __construct(
        CustomerSetupFactory $customerSetupFactory
    ) {
        $this->customerSetupFactory = $customerSetupFactory;
    }

    /**
     * {@inheritdoc}
     */
    public function install(
        ModuleDataSetupInterface $setup,
        ModuleContextInterface $context
    ) {
        $customerSetup = $this->customerSetupFactory->create(['setup' => $setup]);

        $customerSetup->addAttribute(\Magento\Customer\Model\Customer::ENTITY, 'mobile', [
            'type' => 'varchar', // type of attribute
            'label' => 'Mobile Number',
            'input' => 'text', // input type
            'source' => '',
            'required' => false, // if you want to required need to set true
            'visible' => true,
            'position' => 500, // position of attribute
            'system' => false,
            'backend' => ''
        ]);
        
        /* Specify which place you want to display customer attribute */
        $attribute = $customerSetup->getEavConfig()->getAttribute('customer', 'mobile')
        ->addData(['used_in_forms' => [
                'adminhtml_customer',
                'adminhtml_checkout',
                'customer_account_create',
                'customer_account_edit'
            ]
        ]);
        $attribute->save();
    }
}

<?php

namespace Magemonkeys\CustomerAttribute\Setup;

use Magento\Framework\Setup\InstallDataInterface;

use Magento\Framework\Setup\ModuleContextInterface;

use Magento\Framework\Setup\ModuleDataSetupInterface;

use Magento\Customer\Model\Customer;

use Magento\Customer\Setup\CustomerSetupFactory;

class InstallData implements InstallDataInterface

{

private $customerSetupFactory;

/**

* Constructor

* @param \Magento\Customer\Setup\CustomerSetupFactory $customerSetupFactory

public function __construct(

CustomerSetupFactory $customerSetupFactory

) {

$this->customerSetupFactory = $customerSetupFactory;

}

/**

* {@inheritdoc}

public function install(

ModuleDataSetupInterface $setup,

ModuleContextInterface $context

) {

$customerSetup = $this->customerSetupFactory->create(['setup' => $setup]);

$customerSetup->addAttribute(\Magento\Customer\Model\Customer::ENTITY, 'mobile', [

'type' => 'varchar', // type of attribute

'label' => 'Mobile Number',

'input' => 'text', // input type

'source' => '',

'required' => false, // if you want to required need to set true

'visible' => true,

'position' => 500, // position of attribute

'system' => false,

'backend' => ''

]);

/* Specify which place you want to display customer attribute */

$attribute = $customerSetup->getEavConfig()->getAttribute('customer', 'mobile')

->addData(['used_in_forms' => [

'adminhtml_customer',

'adminhtml_checkout',

'customer_account_create',

'customer_account_edit'

]

]);

$attribute->save();

}

Now Run the upgrade command to install our module using SSh from the root of your Magento instance.

php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy -f
php bin/magento indexer:reindex
php bin/magento cache:flush

php bin/magento setup:upgrade

php bin/magento setup:static-content:deploy -f

php bin/magento indexer:reindex

php bin/magento cache:flush

Now you can check your new mobile number attribute at the admin panel.

Go To, Customers -> All Customers -> Edit any Customer.

Fill the below form if you have any Magento programming need.

Add an image programmatically from any url in Magento 2
[crayon-63d3e571bf932717703776/] Using above fucntion Images can be imported directly from...
Magento 2 : Override the Category view block file
Override view block using di.xml and add the below code...
How to check list of Layout XML called for a specific page in Magento 2?
You can check a list of called layout XML for...
Magento 2 : Setup PWA from Scratch
Follow the below steps to install and set up PWA...
How to remove leading zero’s from the order, invoice and shipment number in Magento 2?
If you want to remove all leading zero's from order,...

Author Info

Magento Certified Developer

Hire J. Lakum

Let’s have a call

Fill the form & Get Installation Support