Dtjytyk

How to add an Attribute for a Customer Entity in a custom module using declarative schema in Magento 2.3?

I have added one customer attribute using Declarative Schema in a custom module.

<?php

namespace vendor_namemodule_nameSetupPatchData;

use MagentoFrameworkSetupPatchDataPatchInterface;
use MagentoFrameworkSetupPatchPatchVersionInterface;
use MagentoFrameworkSetupModuleDataSetupInterface;
use MagentoCustomerModelCustomer;
use MagentoCustomerSetupCustomerSetupFactory;
use MagentoEavModelEntityAttributeSetFactory as AttributeSetFactory;
use MagentoFrameworkDBDdlTable;

class AddTestAttribute implements DataPatchInterface

 protected $_moduleDataSetup;
 protected $_customerSetupFactory;
 protected $_attributeSetFactory;

 public function __construct(
 ModuleDataSetupInterface $moduleDataSetup,
 CustomerSetupFactory $customerSetupFactory,
 AttributeSetFactory $attributeSetFactory
 )
 
 $this->_moduleDataSetup = $moduleDataSetup;
 $this->_customerSetupFactory = $customerSetupFactory;
 $this->_attributeSetFactory = $attributeSetFactory;
 

 public function apply()
 
 $customerSetup = $this->_customerSetupFactory->create(['setup' => $this->_moduleDataSetup]);

 $customerEntity = $customerSetup->getEavConfig()->getEntityType(Customer::ENTITY);
 $attributeSetId = $customerEntity->getDefaultAttributeSetId();

 $attributeSet = $this->_attributeSetFactory->create();
 $attributeSet->getDefaultGroupId($attributeSetId);

 $customerSetup->removeAttribute(Customer::ENTITY, 'test');
 $customerSetup->addAttribute(Customer::ENTITY, 'test', array(
 'type' => Table::TYPE_DECIMAL,
 'label' => 'Test',
 'input' => 'text',
 'required' => 0,
 'default' => 0,
 'visible' => 0,
 'system' => 0
 ));
 

 public function getAliases()
 
 return [];
 

 public static function getDependencies()
 
 return [

 ];
 

After reviewing the schema.xsd; I don't see any support for it; but - you can add support for it by updating the schema in your own module and then pointing your file to it while adding support for the additional functionality. (which is alot of work unless you are building several modules and you are doing this within your "core")

Currently this is easily done the previous way via the InstallData.php; I'm not sure if anyone wants this added to declarative at this time; if so; I can put something together as a PR?

Please use the following code to create Customer's Phone number attribute that will be used in the Registration form too:

<?php
namespace VendorModuleSetupPatchData;

use MagentoCustomerModelCustomer;
use MagentoCustomerSetupCustomerSetupFactory;
use MagentoFrameworkSetupModuleDataSetupInterface;
use MagentoFrameworkSetupPatchDataPatchInterface;
use MagentoEavModelEntityAttributeSetFactory as AttributeSetFactory;

/**
 * Class AddCustomerPhoneNumberAttribute
 * @package VendorModuleSetupPatchData
 */
class AddCustomerPhoneNumberAttribute implements DataPatchInterface

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

 /**
 * @var CustomerSetupFactory
 */
 protected $customerSetupFactory;

 /**
 * @var AttributeSetFactory
 */
 protected $attributeSetFactory;

 /**
 * AddCustomerPhoneNumberAttribute constructor.
 * @param ModuleDataSetupInterface $moduleDataSetup
 * @param CustomerSetupFactory $customerSetupFactory
 * @param AttributeSetFactory $attributeSetFactory
 */
 public function __construct(
 ModuleDataSetupInterface $moduleDataSetup,
 CustomerSetupFactory $customerSetupFactory,
 AttributeSetFactory $attributeSetFactory
 )
 $this->moduleDataSetup = $moduleDataSetup;
 $this->customerSetupFactory = $customerSetupFactory;
 $this->attributeSetFactory = $attributeSetFactory;
 

 /**
 * @inheritdoc
 */
 public function apply()
 
 $customerSetup = $this->customerSetupFactory->create(['setup' => $this->moduleDataSetup]);

 $customerEntity = $customerSetup->getEavConfig()->getEntityType(Customer::ENTITY);
 $attributeSetId = $customerEntity->getDefaultAttributeSetId();

 $attributeSet = $this->attributeSetFactory->create();
 $attributeGroupId = $attributeSet->getDefaultGroupId($attributeSetId);

 $customerSetup->addAttribute(
 Customer::ENTITY,
 'phone_number',
 [
 'type' => 'varchar',
 'label' => 'Phone Number',
 'input' => 'text',
 'validate_rules' => '"max_text_length":255,"min_text_length":1',
 'required' => false,
 'sort_order' => 120,
 'position' => 120,
 'visible' => true,
 'user_defined' => true,
 'unique' => false,
 'system' => false,
 ]
 );

 $attribute = $customerSetup->getEavConfig()->getAttribute(
 Customer::ENTITY,
 'phone_number'
 );

 $attribute->addData(
 [
 'attribute_set_id' => $attributeSetId,
 'attribute_group_id' => $attributeGroupId,
 'used_in_forms' => ['adminhtml_customer', 'customer_account_create', 'customer_account_edit'],
 ]
 );

 $attribute->save();
 

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

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