Custom Customer Address field not passing validation

Question

I've added a custom field to the Customer Addresses with the following UpgradeData:

public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
{
    /** @var CustomerSetup $customerSetup */
    $customerSetup = $this->customerSetupFactory->create(['setup' => $setup]);
$params = [
    'label' => 'House Number',
    'type' => 'varchar',
    'input' => 'text',
    'required' => true,
    'visible' => true,
    'user_defined' => true,
    'position' =>999,
    'system' => 0,
];

$customerSetup->addAttribute('customer_address', 'house_number', $params);
$customAttribute = $customerSetup->getEavConfig()->getAttribute('customer_address', 'house_number');
$customAttribute->setData(
    'used_in_forms',
    ['adminhtml_checkout', 'adminhtml_customer', 'adminhtml_customer_address', 'customer_address_edit', 'customer_register_address'],
);
$customAttribute->save();

}

The field properly displays when logging into the Adminhtml area and adding a new Addresses to a customer. However, the New Address form cannot be submitted, the following error appears:

"House Number" is a required value.

Here is a screenshot:

I do believe that it is clear that a value for House Number was submitted.

What else must I do to enable this field on this form, and on other forms such as the Checkout and user's own Account Information?

Answer 1

When adding a custom customer attribute or custom customer address attribute, to allow Magento to save it you need to assign it to the customer attribute set.

So, in your code, after $customerSetup->addAttribute('customer_address', 'house_number', $params); you should add the following code:

$customerSetup->addAttributeToSet(
    AddressMetadataInterface::ENTITY_TYPE_ADDRESS,
    AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
    null,
    'house_number'
);

where AddressMetadataInterface is imported by
use Magento\Customer\Api\AddressMetadataInterface;

But... since Magento 2.3, Magento marked upgrade script as old script, you should use Data patch for data modification.

The below is the data patch to add house_number custom customer address attribute:
File path: app/code/Vendor/Module/Setup/Patch/Data/AddHouseNumberAttribute.php

<?php
namespace Vendor\Module\Setup\Patch\Data;
use Magento\Customer\Api\AddressMetadataInterface;
use Magento\Customer\Setup\CustomerSetupFactory;
use Magento\Framework\Setup\ModuleDataSetupInterface;
use Magento\Framework\Setup\Patch\DataPatchInterface;
class AddHouseNumberAttribute implements DataPatchInterface
{
    /**
     * @var ModuleDataSetupInterface
     */
    private $moduleDataSetup;
/**
 * @var CustomerSetupFactory
 */
private $customerSetupFactory;

public function __construct(
    ModuleDataSetupInterface $moduleDataSetup,
    CustomerSetupFactory $customerSetupFactory
) {
    $this-&gt;moduleDataSetup = $moduleDataSetup;
    $this-&gt;customerSetupFactory = $customerSetupFactory;
}

/**
 * @inheritdoc
 */
public function apply(): void
{
    $customerSetup = $this-&gt;customerSetupFactory-&gt;create(['setup' =&gt; $this-&gt;moduleDataSetup]);
    $houseNumberAttributeCode = 'house_number';

    $customerSetup-&gt;addAttribute(
        AddressMetadataInterface::ENTITY_TYPE_ADDRESS,
        $houseNumberAttributeCode, [
        'label' =&gt; 'House Number',
        'type' =&gt; 'varchar',
        'input' =&gt; 'text',
        'required' =&gt; true,
        'visible' =&gt; true,
        'user_defined' =&gt; true,
        'position' =&gt; 999,
        'system' =&gt; false,
    ]);

    $customerSetup-&gt;addAttributeToSet(
        AddressMetadataInterface::ENTITY_TYPE_ADDRESS,
        AddressMetadataInterface::ATTRIBUTE_SET_ID_ADDRESS,
        null,
        $houseNumberAttributeCode
    );

    $houseNumberAttribute = $customerSetup-&gt;getEavConfig()-&gt;getAttribute(
        AddressMetadataInterface::ENTITY_TYPE_ADDRESS,
        $houseNumberAttributeCode
    );
    $houseNumberAttribute-&gt;addData([
        'used_in_forms' =&gt; ['adminhtml_customer_address', 'customer_address_edit', 'customer_register_address']
    ]);
    $houseNumberAttribute-&gt;save();
}

public static function getDependencies()
{
    return [];
}

public function getAliases()
{
    return [];
}

}