Magento 2: Add Customer Attribute Programmatically Using Setup Script

Create setup file InstallData.php

File: app/code/Magemonkeys/Customer/Setup/InstallData.php

<?php

namespace Magemonkeys\Customer\Setup;

use Magento\Eav\Setup\EavSetup;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Eav\Model\Config;
use Magento\Customer\Model\Customer;

class InstallData implements InstallDataInterface
{
	private $eavSetupFactory;

	public function __construct(EavSetupFactory $eavSetupFactory, Config $eavConfig)
	{
		$this->eavSetupFactory = $eavSetupFactory;
		$this->eavConfig       = $eavConfig;
	}

	public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
	{
		$eavSetup = $this->eavSetupFactory->create(['setup' => $setup]);
		$eavSetup->addAttribute(
			\Magento\Customer\Model\Customer::ENTITY,
			'sample_attribute',
			[
				'type'         => 'varchar',
				'label'        => 'Sample Attribute',
				'input'        => 'text',
				'required'     => false,
				'visible'      => true,
				'user_defined' => true,
				'position'     => 999,
				'system'       => 0,
			]
		);
		$sampleAttribute = $this->eavConfig->getAttribute(Customer::ENTITY, 'sample_attribute');

		// more used_in_forms ['adminhtml_checkout','adminhtml_customer','adminhtml_customer_address','customer_account_edit','customer_address_edit','customer_register_address']
		$sampleAttribute->setData(
			'used_in_forms',
			['adminhtml_customer']

		);
		$sampleAttribute->save();
	}
}

<?php

namespace Magemonkeys\Customer\Setup;

use Magento\Eav\Setup\EavSetup;

use Magento\Eav\Setup\EavSetupFactory;

use Magento\Framework\Setup\InstallDataInterface;

use Magento\Framework\Setup\ModuleContextInterface;

use Magento\Framework\Setup\ModuleDataSetupInterface;

use Magento\Eav\Model\Config;

use Magento\Customer\Model\Customer;

class InstallData implements InstallDataInterface

{

private $eavSetupFactory;

public function __construct(EavSetupFactory $eavSetupFactory, Config $eavConfig)

{

$this->eavSetupFactory = $eavSetupFactory;

$this->eavConfig = $eavConfig;

}

public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)

{

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

$eavSetup->addAttribute(

\Magento\Customer\Model\Customer::ENTITY,

'sample_attribute',

[

'type' => 'varchar',

'label' => 'Sample Attribute',

'input' => 'text',

'required' => false,

'visible' => true,

'user_defined' => true,

'position' => 999,

'system' => 0,

]

);

$sampleAttribute = $this->eavConfig->getAttribute(Customer::ENTITY, 'sample_attribute');

// more used_in_forms ['adminhtml_checkout','adminhtml_customer','adminhtml_customer_address','customer_account_edit','customer_address_edit','customer_register_address']

$sampleAttribute->setData(

'used_in_forms',

['adminhtml_customer']

);

$sampleAttribute->save();

}

Run command line to install the module: php bin/magento setup:upgrade and php bin/magento setup:static-content:deploy

Then check the result. It will show like this:

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

Make your site sales-friendly by optimizing the search box
The search box is the most underrated functionality that is...
Why should you have a Magento support agency?
Managing and customizing Magento site can be a daunting task,...
Hire Magento Developers as Per Your Flexibility and Requirements
Having an in-house eCommerce developer is very costly, and it...
5 Mistakes in Magneto are killing your conversion rates!!
Have you wonder why your conversions are less compare to...
Is your eCommerce well maintained?
According to a research, around 68% of eCommerce stores are...

Author Info

Magento Certified Developer

Hire J. Lakum

Fill the form & Get Installation Support