{"id":306051,"date":"2021-09-19T10:08:25","date_gmt":"2021-09-19T10:08:25","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=306051"},"modified":"2024-06-17T11:58:38","modified_gmt":"2024-06-17T11:58:38","slug":"add-custom-column-in-customer-grid","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/","title":{"rendered":"Add Custom Column in Customer Grid"},"content":{"rendered":"\n

In this blog, we are going to learn that how we can add a custom customer attribute column in the customer grid at the admin section.<\/p>\n\n\n\n

Here, I have created a custom customer attribute “aadhaar_number”, that I will display in the customer grid.<\/p>\n\n\n\n

To add the custom column in the customer grid, you have to follow the below steps:

1. Create customer_listing.xml file inside app\/code\/Vendor\/CustomModule\/view\/adminhtml\/ui_component\/ directory.<\/p>\n\n\n\n

<?xml version="1.0" encoding="UTF-8"?>\n<listing xmlns:xsi="http:\/\/www.w3.org\/2001\/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc\/ui_configuration.xsd">\n        <listingToolbar name="listing_top"\/>\n    <columns name="customer_columns" class="Magento\\Customer\\Ui\\Component\\Listing\\Columns">\n        <column name="aadhaar_number" class="Vendor\\CustomModule\\Ui\\Component\\Listing\\Column\\AadhaarNumber">\n            <argument name="data" xsi:type="array">\n                    <item name="config" xsi:type="array">\n                    <item name="filter" xsi:type="string">text<\/item>\n                    <item name="editor" xsi:type="string">text<\/item>\n                    <item name="label" xsi:type="string" translate="true">Aadhaar Number<\/item>\n                    <item name="sortOrder" xsi:type="number">40<\/item>\n                    <\/item>\n            <\/argument>\n        <\/column>\n    <\/columns>\n<\/listing><\/pre>\n\n\n\n
2. Create AadhaarNumber.php file inside app\/code\/Vendor\/CustomModule\/Ui\/Component\/Listing\/Column\/ directory.<\/p>\n\n\n\n
<?php\nnamespace Vendor\\CustomModule\\Ui\\Component\\Listing\\Column;\nuse Magento\\Framework\\View\\Element\\UiComponent\\ContextInterface;\nuse Magento\\Framework\\View\\Element\\UiComponentFactory;\nuse Magento\\Ui\\Component\\Listing\\Columns\\Column;\n\nclass AadhaarNumber extends Column\n{\n    \/**\n     *\n     * @param ContextInterface   $context\n     * @param UiComponentFactory $uiComponentFactory\n     * @param array              $components\n     * @param array              $data\n     *\/\n    public function __construct(\n        ContextInterface $context,\n        UiComponentFactory $uiComponentFactory,\n        array $components = [],\n        array $data = []\n    ) {\n        parent::__construct($context, $uiComponentFactory, $components, $data);\n    }\n    \/**\n     * Prepare Data Source\n     *\n     * @param array $dataSource\n     * @return array\n     *\/\n    public function prepareDataSource(array $dataSource)\n    {\n        if (isset($dataSource['data']['items'])) {\n            foreach ($dataSource['data']['items'] as & $item)\n            {\n                $objectManager = \\Magento\\Framework\\App\\ObjectManager::getInstance();\n                $customer = $objectManager->create('Magento\\Customer\\Model\\Customer')->load($item['entity_id']);\n                $item[$this->getData('name')] = $customer->getAadhaarNumber();\n            }\n        }\n        return $dataSource;\n    }\n}\n?><\/pre>\n\n\n\n
3. Now, in the admin section, the “Aadhaar Number” column will be added in the customer grid as following image:<\/p>\n\n\n\n
\"customerGrid\"
Custom Column ‘Aadhaar Number’ in Custom Grid<\/figcaption><\/figure>\n\n\n\n
Hope this will be helpful. Thanks \ud83d\ude42

Next Blog: <\/strong>Make Submenu position right adjacent of parent menu at frontend in Magento 2<\/a>

Previous Blog: <\/strong>Create a custom command to disable a module in Magento 2<\/a><\/p>\n\n\n\n
<\/p>\n","protected":false},"excerpt":{"rendered":"
In this blog, we are going to learn that how we can add a custom customer attribute column in the customer grid at the admin section. Here, I have created a custom customer attribute “aadhaar_number”, that I will display in the customer grid. To add the custom column in the customer grid, you have to […]<\/a><\/p>\n","protected":false},"author":249,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[302],"tags":[12066,1230,12065,12064],"class_list":["post-306051","post","type-post","status-publish","format-standard","hentry","category-magento2","tag-attribute-column-in-customer-grid","tag-custom-attribute","tag-custom-column","tag-customer-grid"],"yoast_head":"\nAdd Custom Column in Customer Grid - Webkul Blog<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Add Custom Column in Customer Grid - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"In this blog, we are going to learn that how we can add a custom customer attribute column in the customer grid at the admin section. Here, I have created a custom customer attribute “aadhaar_number”, that I will display in the customer grid. To add the custom column in the customer grid, you have to [...]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2021-09-19T10:08:25+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-06-17T11:58:38+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid-1200x548.png\" \/>\n<meta name=\"author\" content=\"Khushboo Sahu\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Khushboo Sahu\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/\"},\"author\":{\"name\":\"Khushboo Sahu\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca\"},\"headline\":\"Add Custom Column in Customer Grid\",\"datePublished\":\"2021-09-19T10:08:25+00:00\",\"dateModified\":\"2024-06-17T11:58:38+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/\"},\"wordCount\":153,\"commentCount\":2,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid-1200x548.png\",\"keywords\":[\"attribute column in customer grid\",\"custom attribute\",\"custom column\",\"customer grid\"],\"articleSection\":[\"Magento2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/\",\"url\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/\",\"name\":\"Add Custom Column in Customer Grid - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid-1200x548.png\",\"datePublished\":\"2021-09-19T10:08:25+00:00\",\"dateModified\":\"2024-06-17T11:58:38+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#primaryimage\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid.png\",\"width\":1808,\"height\":825,\"caption\":\"customerGrid\"},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add Custom Column in Customer Grid\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca\",\"name\":\"Khushboo Sahu\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g\",\"caption\":\"Khushboo Sahu\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/khushboo-sahu062\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Add Custom Column in Customer Grid - Webkul Blog","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/","og_locale":"en_US","og_type":"article","og_title":"Add Custom Column in Customer Grid - Webkul Blog","og_description":"In this blog, we are going to learn that how we can add a custom customer attribute column in the customer grid at the admin section. Here, I have created a custom customer attribute “aadhaar_number”, that I will display in the customer grid. To add the custom column in the customer grid, you have to [...]","og_url":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2021-09-19T10:08:25+00:00","article_modified_time":"2024-06-17T11:58:38+00:00","og_image":[{"url":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid-1200x548.png","type":"","width":"","height":""}],"author":"Khushboo Sahu","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Khushboo Sahu","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/"},"author":{"name":"Khushboo Sahu","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca"},"headline":"Add Custom Column in Customer Grid","datePublished":"2021-09-19T10:08:25+00:00","dateModified":"2024-06-17T11:58:38+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/"},"wordCount":153,"commentCount":2,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"image":{"@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid-1200x548.png","keywords":["attribute column in customer grid","custom attribute","custom column","customer grid"],"articleSection":["Magento2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/","url":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/","name":"Add Custom Column in Customer Grid - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"primaryImageOfPage":{"@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#primaryimage"},"image":{"@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#primaryimage"},"thumbnailUrl":"https:\/\/webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid-1200x548.png","datePublished":"2021-09-19T10:08:25+00:00","dateModified":"2024-06-17T11:58:38+00:00","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#primaryimage","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/09\/customerGrid.png","width":1808,"height":825,"caption":"customerGrid"},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/add-custom-column-in-customer-grid\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Add Custom Column in Customer Grid"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/f94b8f53397bf85810761d76c98fadca","name":"Khushboo Sahu","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/cabac965df656d114e6bf340df07518c990eda03bb09265dbd5c17f1097adaae?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Feva.png&r=g","caption":"Khushboo Sahu"},"url":"https:\/\/webkul.com\/blog\/author\/khushboo-sahu062\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/306051","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/249"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=306051"}],"version-history":[{"count":5,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/306051\/revisions"}],"predecessor-version":[{"id":448286,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/306051\/revisions\/448286"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=306051"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=306051"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=306051"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}