Magento – How to display field “VAT Number” during registration

magento-2.1registration

How to display field "VAT Number" (required) during registration.

This field is visible when editing the user from the administration panel. Only how to display them during registration?

I found code in:

app/design/frontend/{YOUR_PACKAGE}/{YOUR_THEME}/Magento_Customer/templates/form/register.phtml

This file contains fields that are displayed during registration:

            <input type="hidden" name="create_address" value="1" />
        <div class="field company">
            <label for="company" class="label"><span><?php /* @escapeNotVerified */ echo __('Company') ?></span></label>
            <div class="control">
                <input type="text" name="company" id="company" value="<?php echo $block->escapeHtml($block->getFormData()->getCompany()) ?>" title="<?php /* @escapeNotVerified */ echo __('Company') ?>" class="input-text <?php /* @escapeNotVerified */ echo $this->helper('Magento\Customer\Helper\Address')->getAttributeValidationClass('company') ?>">
            </div>
        </div>
        <div class="field telephone">
            <label for="telephone" class="label"><span><?php /* @escapeNotVerified */ echo __('Phone Number') ?></span></label>
            <div class="control">
                <input type="text" name="telephone" id="telephone" value="<?php echo $block->escapeHtml($block->getFormData()->getTelephone()) ?>" title="<?php /* @escapeNotVerified */ echo __('Phone Number') ?>" class="input-text <?php /* @escapeNotVerified */ echo $this->helper('Magento\Customer\Helper\Address')->getAttributeValidationClass('telephone') ?>">
            </div>
        </div>

        <?php $_streetValidationClass = $this->helper('Magento\Customer\Helper\Address')->getAttributeValidationClass('street'); ?>

        <div class="field street required">
            <label for="street_1" class="label"><span><?php /* @escapeNotVerified */ echo __('Street Address') ?></span></label>
            <div class="control">
                <input type="text" name="street[]" value="<?php echo $block->escapeHtml($block->getFormData()->getStreet(0)) ?>" title="<?php /* @escapeNotVerified */ echo __('Street Address') ?>" id="street_1" class="input-text <?php /* @escapeNotVerified */ echo $_streetValidationClass ?>">
                <div class="nested">
                    <?php $_streetValidationClass = trim(str_replace('required-entry', '', $_streetValidationClass)); ?>
                    <?php for ($_i = 2, $_n = $this->helper('Magento\Customer\Helper\Address')->getStreetLines(); $_i <= $_n; $_i++): ?>
                        <div class="field additional">
                            <label class="label" for="street_<?php /* @escapeNotVerified */ echo $_i ?>">
                                <span><?php /* @escapeNotVerified */ echo __('Address') ?></span>
                            </label>
                            <div class="control">
                                <input type="text" name="street[]" value="<?php echo $block->escapeHtml($block->getFormData()->getStreetLine($_i - 1)) ?>" title="<?php /* @escapeNotVerified */ echo __('Street Address %1', $_i) ?>" id="street_<?php /* @escapeNotVerified */ echo $_i ?>" class="input-text <?php /* @escapeNotVerified */ echo $_streetValidationClass ?>">
                            </div>
                        </div>
                    <?php endfor; ?>
                </div>
            </div>
        </div>

        <div class="field required">
            <label for="city" class="label"><span><?php /* @escapeNotVerified */ echo __('City') ?></span></label>
            <div class="control">
                <input type="text" name="city" value="<?php echo $block->escapeHtml($block->getFormData()->getCity()) ?>" title="<?php /* @escapeNotVerified */ echo __('City') ?>" class="input-text <?php /* @escapeNotVerified */ echo $this->helper('Magento\Customer\Helper\Address')->getAttributeValidationClass('city') ?>" id="city">
            </div>
        </div>

        <div class="field region required">
            <label for="region_id" class="label"><span><?php /* @escapeNotVerified */ echo __('State/Province') ?></span></label>
            <div class="control">
                <select id="region_id" name="region_id" title="<?php /* @escapeNotVerified */ echo __('State/Province') ?>" class="validate-select" style="display:none;">
                    <option value=""><?php /* @escapeNotVerified */ echo __('Please select a region, state or province.') ?></option>
                </select>
                <input type="text" id="region" name="region" value="<?php echo $block->escapeHtml($block->getRegion()) ?>" title="<?php /* @escapeNotVerified */ echo __('State/Province') ?>" class="input-text <?php /* @escapeNotVerified */ echo $this->helper('Magento\Customer\Helper\Address')->getAttributeValidationClass('region') ?>" style="display:none;">
            </div>
        </div>

        <div class="field zip required">
            <label for="zip" class="label"><span><?php /* @escapeNotVerified */ echo __('Zip/Postal Code') ?></span></label>
            <div class="control">
                <input type="text" name="postcode" value="<?php echo $block->escapeHtml($block->getFormData()->getPostcode()) ?>" title="<?php /* @escapeNotVerified */ echo __('Zip/Postal Code') ?>" id="zip" class="input-text validate-zip-international <?php /* @escapeNotVerified */ echo $this->helper('Magento\Customer\Helper\Address')->getAttributeValidationClass('postcode') ?>">
            </div>
        </div>

        <div class="field country required">
            <label for="country" class="label"><span><?php /* @escapeNotVerified */ echo __('Country') ?></span></label>
            <div class="control">
                <?php echo $block->getCountryHtmlSelect() ?>
            </div>
        </div>
        <?php $addressAttributes = $block->getChildBlock('customer_form_address_user_attributes');?>
        <?php if ($addressAttributes): ?>
            <?php $addressAttributes->setEntityType('customer_address'); ?>
            <?php $addressAttributes->setFieldIdFormat('address:%1$s')->setFieldNameFormat('address[%1$s]');?>
            <?php $block->restoreSessionData($addressAttributes->getMetadataForm(), 'address');?>
            <?php echo $addressAttributes->setShowContainer(false)->toHtml()?>
        <?php endif;?>
        <input type="hidden" name="default_billing" value="1">
        <input type="hidden" name="default_shipping" value="1">
    </fieldset>

I also found this code in this file:

<?php $_taxvat = $block->getLayout()->createBlock('Magento\Customer\Block\Widget\Taxvat') ?>
    <?php if ($_taxvat->isEnabled()): ?>
        <?php echo $_taxvat->setTaxvat($block->getFormData()->getTaxvat())->toHtml() ?>
    <<?php endif ?>

Best Answer

To use that field at customer registration, you need to enable all the other address fields and then add a addtional field for "vat_id" to /vendor/magento/module-customer/view/frontend/templates/form/register.phtml.

Then you need to add validation if you want the field to be required.

In the phtml file there is <?php if ($block->getShowAddressFields()): ?> change this to <?php if (true): ?> to show the address fields.

Then add a new field:

<div class="field vat_id required">
            <label for="vat_id" class="label"><span><?= $block->escapeHtml(__('VAT Number')) ?></span></label>
            <div class="control">
                <input type="text" name="vat_id" value="<?= $block->escapeHtmlAttr($block->getFormData()->getVatId()) ?>" title="<?= $block->escapeHtmlAttr(__('VAT Number')) ?>" id="vat_id" class="input-text required <?= $block->escapeHtmlAttr($this->helper('Magento\Customer\Helper\Address')->getAttributeValidationClass('vat_id')) ?>">
            </div>
        </div>

Of course you should use an own template file (in your theme or module) for this, instead of the core file.

Another possibility is https://www.geissweb.de/eu-vat-enhanced-for-magento-2.html which has a config option to show the address fields and the VAT number field at customer registration. You can also add validation to the field with the module, its options are:

Optional
Optional, but require a valid VAT number when filled
Require a valid VAT number, validated through the validation service

Related Solutions

Magento – Magento 2: Error during VAT Number verification

Just to add to webninjas's answer (as it worked for me, I was also missing SOAP), specifically run:

apt install php 7.0-soap

service apache2 restart

Magento – How to i add a field mobile number at the time of customer registration form in magento 2

In case you want to make a whole new eav attribute. (you can then create any variable you'd desire).

First off create your own module and create Setup/InstallData.php

  <?php
namespace NameSpace\NameSpace\Setup;

use Magento\Framework\Module\Setup\Migration;
use Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;

class InstallData implements InstallDataInterface
{
    /**
     * Customer setup factory
     *
     * @var \Magento\Customer\Setup\CustomerSetupFactory
     */
    private $customerSetupFactory;

    /**
     * Init
     *
     * @param \Magento\Customer\Setup\CustomerSetupFactory $customerSetupFactory
     */
    public function __construct(\Magento\Customer\Setup\CustomerSetupFactory $customerSetupFactory)
    {
        $this->customerSetupFactory = $customerSetupFactory;
    }
    /**
     * Installs DB schema for a module
     *
     * @param ModuleDataSetupInterface $setup
     * @param ModuleContextInterface $context
     * @return void
     */
    public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
    {
        $installer = $setup;
        $installer->startSetup();

        $customerSetup = $this->customerSetupFactory->create(['setup' => $setup]);
        $entityTypeId = $customerSetup->getEntityTypeId(\Magento\Customer\Model\Customer::ENTITY);
        $customerSetup->removeAttribute(\Magento\Customer\Model\Customer::ENTITY, "reg_code");

        $customerSetup->addAttribute(\Magento\Customer\Model\Customer::ENTITY, "reg_code",  array(
            "type"      => "varchar",
            "backend"   => "",
            "label"     => "Company Reg. code",
            "input"     => "text",
            "source"    => "",
            "visible"   => true,
            "required"  => false,
            "default"   => "",
            "frontend"  => "",
            "unique"    => false,
            "note"      => ""
        ));

        $reg_code   = $customerSetup->getAttribute(\Magento\Customer\Model\Customer::ENTITY, "reg_code");
        $reg_code = $customerSetup->getEavConfig()->getAttribute(\Magento\Customer\Model\Customer::ENTITY, 'reg_code');

        $used_in_forms[]="adminhtml_customer";
        $used_in_forms[]="checkout_register";
        $used_in_forms[]="customer_account_create";
        $used_in_forms[]="customer_account_edit";
        $used_in_forms[]="adminhtml_checkout";
        $used_in_forms[]="customer_address";
        $used_in_forms[]="customer_address_edit";

        $reg_code->setData("used_in_forms", $used_in_forms)
            ->setData("is_used_for_customer_segment", true)
            ->setData("is_system", 0)
            ->setData("is_user_defined", 1)
            ->setData("is_visible", 1)
            ->setData("sort_order", 121);

        $reg_code->save();

        $installer->endSetup();
    }
}

You'll also need to register your module with etc/module.xml

<?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="<Vendor>_<Module>" setup_version="1.0.0" />
    </config>

After this your custom attribute (in your case mobile), should appear in admin. (Check under Customer edit). This goes without saying, that you also need to run setup:upgrade and compile.

Then you'll need to display your attribute in frontend. In your case registration.

For that you can see in InstallData.php that I've included

$used_in_forms[]="customer_account_create";

Which allowes it to extend Magento core and inject a fieldset to Magento core registration form.

You'll need to create view/frontend/layout/customer_account_create.xml

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" layout="1column" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <body>
        <referenceContainer name="form.additional.info">
            <block class="Magento\Framework\View\Element\Template" name="my_form_additional_info_customer" template="<Vendor>_<Module>::add_company_name_to_client.phtml"/>
        </referenceContainer>
    </body>
</page>

Also create view/frontend/templates/add_company_name_to_client.phtml (In your case you can name it whatever you want).

<fieldset class="fieldset create account" data-hasrequired="<?php /* @escapeNotVerified */ echo __('* Required Fields') ?>">
    <div class="field reg_code">
        <label for="reg_code" class="label"><span><?php /* @escapeNotVerified */ echo __('Company registration code') ?></span></label>
        <div class="control">
            <input type="text" name="reg_code" id="reg_code" title="<?php /* @escapeNotVerified */ echo __('Company Registration Code') ?>" class="input-text" data-validate="{required:false}" autocomplete="off">
        </div>
    </div>
</fieldset>

This is the gist of it. You will need to modify this code to suit your own needs.

Oh and to answer your original question, if you're going with the way of creating an entirely new attribute, then you can change the sorting order in InstallData.php with ->setData();

Best Answer

Related Solutions

Magento – Magento 2: Error during VAT Number verification

Magento – How to i add a field mobile number at the time of customer registration form in magento 2

Related Topic