How to add a custom column in customer table in Magento2?

How to add a custom column in customer table in Magento2?

July 6, 2026 · Illustrated author avatarBy Stefan Bogdanescu
How to add a custom column in customer table in Magento2?

Solving Custom Column Issues in Magento2 Customer Table

Adding a custom column to the customer table in Magento2 can be a bit tricky if you don’t approach it systematically. Let’s tackle this issue step-by-step.

Understanding the Customer Table Structure

The customer_entity table is where Magento stores customer data. You need to add your new column (let’s call it telephone) to this table manually or via a custom module. For now, let’s assume you’ve already added the column to the database.

Setting the Column Value During Registration

You want to set a value for this new telephone field when a customer registers. The registration process is handled by Magento through various controller and model files.

The Customer Registration Process

The customer registration starts in the Magento/Customer/Controller/Account/CreatePost.php file, specifically in the execute() function.

public function execute()
{
    // ... existing code ...

    if (!$this->getRequest()->isPost()) {
        $url = $this->urlModel->getUrl('*/*/create', ['_secure' => true]);
        $resultRedirect->setUrl($this->_redirect->error($url));
        return $resultRedirect;
    }

    // Here is I set the telephone and it is giving an error
    $customer->setTelephone('1234567890');

    // ... existing code ...
}

The Customer model you’re working with here is actually an instance of Magento\Customer\Model\Data\Customer. This model doesn’t have a setTelephone() method by default.

The Missing Method

The error message “Undefine function setTelephone in Magento/Customer/Model/Data/Customer.php” indicates that the method you’re trying to use is not defined in the Magento/Customer/Model/Data/Customer.php file.

To fix this, you need to define your custom method in the appropriate interface and model files. The correct flow should look like this:

  1. Add the property to the CustomerInterface Open Magento\Customer\Api\Data\CustomerInterface.php. Add the following constant and methods:
const TELEPHONE = 'telephone';

public function getTelephone();
public function setTelephone($telephone);
  1. Implement the methods in Customer.php

Open Magento/Customer/Model/Data/Customer.php.

Add the following two methods to the class:

public function setTelephone($telephone)
{
    return $this->setData(self::TELEPHONE, $telephone);
}

public function getTelephone()
{
    return $this->_get(self::TELEPHONE);
}
  1. Recompile your Magento code

After making these changes, you need to recompile the Magento application.

Run the following commands in your terminal:

php bin/magento setup:di:compile
php bin/magento cache:clean

Now, if you go back to Magento/Customer/Controller/Account/CreatePost.php, when you call $customer->setTelephone('1234567890');, the error should be resolved.

Creating a Custom Module

If you’re trying to create a custom module to handle this, here’s how you can do it:

Create the Basic Files

You need three main files: registration.php, etc/module.xml, and Setup/InstallData.php.

  • The registration.php file simply registers your module.
  • The etc/module.xml file specifies which Magento modules your custom module depends on.
  • The Setup/InstallData.php file contains the logic to add your new column.

Implementing InstallData

In your InstallData.php, you should have something like this:

public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
{
    $setup->startSetup();

    $customerEntity = $setup->getEavConfig()->getEntityType('customer');
    $attributeSetId = $customerEntity->getDefaultAttributeSetId();

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

    $setup->getConnection()->addColumn(
        $setup->getTable('customer_entity'),
        'telephone',
        [
            'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
            'length' => 255,
            'nullable' => true,
            'comment' => 'Telephone'
        ]
    );

    $setup->endSetup();
}

Installing the Module

To install your custom module, run these commands:

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

Conclusion

Adding a custom column to the customer table in Magento2 requires careful attention to the data flow during the customer registration process. You need to modify the appropriate model and interface files to define your new method, then recompile the application.

Remember that working with the database directly can have serious consequences if not done correctly. Always backup your data before making changes at this level.

Laravel Company offers expert development services for Magento projects of all sizes. If you need help with customizations like these, feel free to reach out to our team.

Magento 2 Database Extensions Configuration

Our network