Table of Contents
View Magento 2 Customer Attributes Extension Detail Page for Features and Demo
Documentation for Customer Attributes
Preference
The Customer Attributes extension for Magento 2 lets you add extra custom fields to any of your checkout steps. Display all created customer attributes on a backend grid.
- Customer attributes extension flexible settings and intuitive interface, the Customer Attributes for Magento 2 extension will help you easily fine tune the checkout page according to your requirements. You can create as many customer attributes as you need to add on checkout page , create account page and account edit page.
- You can create customer attributes of different types.
- Set flexible conditions for attribute fields display.
- Show customer attributes information on the order grid.
- Show customer attributes information on the customer grid\\.
- Allow admin to export Customer data from backend.
- Display customer attributes at front-end side on Create Account Page, Account Edit Page, Shipping & Review Page. And in Back-end side on the Sales Order Grid and All Customers Grid too.
- The Customer Attributes extension for Magento 2 is seamlessly compatible with popular One Step Checkout solutions.
Installation
There are two ways of installing extension in magento2.
- Using COMMAND LINE.
- Manually Install extension.
Option 1: Magento 2 install extension using COMMAND LINE (Recommended)
Follow below steps to install extension from the command line.
Step 1: Download the extension and unzip it.
Step 2: Upload it to code directory in your magento installation’s app directory. If code directory does not exists then create.
Step 3: Disable the cache under System → Cache Management.
Step 4: Enter the following at the command line:
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
Step 5: Once you complete above steps log out and log in back to the admin panel and switch to Stores → Configuration → Mageants → CustomerAttribute, The module will be displayed in the admin panel.
Option 2: Magento 2 install extension manually
Step 1: Download the extension and unzip it.
Step 2: Upload it to code directory in your magento installation’s app directory. If code directory does not exists then create.
Step 3: Disable the cache under System → Cache Management Edit app/etc/config.php file and add one line code: ‘Mageants_CustomerAttribute’ → 1
Step 4: Disable the cache under System → Cache Management
Step 5: Once you complete above steps log out and log in back to the admin panel and switch to
Stores → Configuration → Mageants → CustomerAttribute, the module will be displayed in the admin panel.
Backend Example
- After Installation of Extension login to magento admin panel to set configuration of the extension.
- As per below screen shot you can set all the settings here.
Extension configuration:
General Setting :-
- Customer can select enable and disable Extension.
Checkout Setting:-
- Display Attribute values in order summary: If select to yes then display attribute in order summary on front-end.
Menu:
- To manage Customer Attributes for Please go to Mageants Customer Attributes there you can add Attributes on particular item. Here you can manage on all attributes.
Create Customer Attributes :-
- List of All created attributes will be displayed in the grid.
- Click the Add New Customer Attribute button to create an attribute or select the existing one to edit it.
New Customer Attributes creation:-
Default Label :- Specify the attribute label that will be displayed on the front-end.
Customer Input Type For Store Owner :– Select attribute type like Text Field , Text Area , Yes/No , Date and Time , Drop-down.
Values Required :– If set to yes, then value is required for attribute option.
Advanced Attribute Properties:-
- Attribute Code :- Specify the attribute code that will be used for internal needs.
- Default Value :- If Enter Attribute Default value then add value.
- Visible on Front-end :- Select option for attribute value to display on front-end.
Attribute Configuration:-
- Show on Customer Grid :- Set Yes to show the Customer Attribute as new column on Customer Grid.
- Visible in Customer Grid :- Set Yes to make the Customer Attribute value visible on Customer Grid.
- Filterable on Customer Grid :- Set Yes to make the Attribute filterable on Customer Grid.
- Searchable on Customer Grid :- Set Yes to make the Attribute searchable on Customer Grid.
Storefront Properties:-
- Sort Order :- Enter sort order for attribute.
- Registration Page :- Select Yes/No option for display attribute on registration page.
- Account Edit Page:- Select Yes/No option for display attribute on account edit page.
- Manage Customers :- Select Yes/No option for display attribute on manage customers.
Manage Labels:-
- Default Store View :- Customer can select drop-down option the they want to add option in store view.
Create Address Attribute:
- List of All created attributes will be displayed in the grid.
- Click the Add New Address Attribute button to create an attribute or select the existing one to edit it.
New Address Attributes creation:
- Default Label :- Specify the attribute label that will be displayed on the front-end.
- Attribute Code :- Specify the attribute code that will be used for internal needs.
- Store View :- Select the store view for which the attribute will be available.
- Customer Groups :- Select customer groups for which the attribute will be shown
Attribute Configuration:-
- Select checkout page:- Select shipping page or review & payment page.
- Save value for checkout page:- If you select to “Yes”, Then previously entered value will be used during checkout. It is Works for login customers only.
- Sales Order Grid:- If you select yes then display attribute on sales order grid.
Manage Conditions:-
- Shipping Methods:- Select shipping methods on which attributes to be displayed.
Attribute display in Sales Order Grid:
Attribute display in Customer Grid:
Attribute display in Customer Data Export :
- Admin can export customer data from System → DataTransfer→ Export.
- Under Export Settings → Entity Type select Customers Main File. and press continue button.
- The new created attributes are visible below, and can be exported along with the customer data after clicking the continue button .
- Download the exported file to view customer data in csv format.
Frontend Example
- See the example of customer attributes with different input types (text fields, drop-downs, radio buttons, multiple check-boxes , yes-no ,date , text area).
Create Account Page :
- On Account Information Page Attribute display in Additional Info block.
Account Edit Page :-
Account Information :- In Account Information block Attribute also display in Additional Information.
Shipping Page :-
- display attribute on shpping page when customer is login.
- Display Attribute on Shipping page when customer is guest.
Review & Payment Page:
Example of one step checkout:-
- The new created address attributes can be seen along with the address block as shown below.