{"id":2702,"date":"2024-12-31T20:26:01","date_gmt":"2024-12-31T20:26:01","guid":{"rendered":"https:\/\/meetanshi.com\/blog\/how-to-add-newsletter-subscription-column-to-customer-grid-in-magento-2\/"},"modified":"2025-03-17T06:19:54","modified_gmt":"2025-03-17T06:19:54","slug":"add-newsletter-subscription-column-to-customer-grid-in-magento-2","status":"publish","type":"post","link":"https:\/\/meetanshi.com\/blog\/add-newsletter-subscription-column-to-customer-grid-in-magento-2\/","title":{"rendered":"How to Add Newsletter Subscription Column to Customer Grid in Magento 2"},"content":{"rendered":"\n

Looking for a method to add newsletter subscription column to customer grid in Magento 2<\/strong><\/em>? Find the complete solution here.<\/p>\n\n\n\n

An email newsletter is an important channel of communication. From promoting new products and sending exclusive coupon codes to greeting customers on their anniversaries, newsletters are an excellent method to nourish brand-customer relations.<\/p>\n\n\n\n

Customers subscribed to the newsletter are generally a step closer to being your brand advocates \u2014 or say they\u2019re more loyal customers. Keeping track of your newsletter subscribers can help you evaluate your branding effort and performance. Magento 2<\/a> offers a different backend grid to manage newsletter subscriptions<\/a> by default. If you want a bigger picture, this separate backend grid may not be enough for you.<\/p>\n\n\n\n

I recently worked on one such requirement for a client who wanted to display the newsletter subscription status in the customer grid. In this blog post, I will share the step-wise method I used to add a newsletter subscription column to the customer grid in Magento 2.<\/p>\n\n\n\n

Method to Add Newsletter Subscription Column to Customer Grid in Magento 2<\/h2>\n\n\n\n

In order to add the Newsletter Subscription <\/strong>column to the customer grid in Magento 2, we need to override the default customer grid. Here are the steps I followed to do that:<\/p>\n\n\n\n

Steps to do that:<\/strong><\/em><\/p>\n\n\n\n

Step 1: <\/strong>Register a new module by creating a registration.php<\/strong> file in app\/code\/Meetanshi\/ <\/strong><\/em>directory with the following code:<\/p>\n\n\n\n

<?php\n    \\Magento\\Framework\\Component\\ComponentRegistrar::register(\n        \\Magento\\Framework\\Component\\ComponentRegistrar::MODULE,\n        'Meetanshi_CustomerSubscriptionStatus',\n        __DIR__\n    );<\/pre>\n\n\n\n
Step 2: <\/strong>Now, create a module.xml<\/strong><\/em> file in the app\/code\/Meetanshi\/CustomerSubscriptionStatus\/etc\/ <\/strong><\/em>directory with the following code:<\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:Module\/etc\/module.xsd\">\n    <module name=\"Meetanshi_CustomerSubscriptionStatus\" setup_version=\"1.0.0\"\/>\n<\/config><\/pre>\n\n\n\n
Step 3: <\/strong>In the same directory, create a di.xml <\/strong><\/em>file to define the plugin with the following code:<\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n        xsi:noNamespaceSchemaLocation=\"urn:magento:framework:ObjectManager\/etc\/config.xsd\">\n    <type name=\"Magento\\Framework\\View\\Element\\UiComponent\\DataProvider\\CollectionFactory\">\n        <plugin name=\"mt_subscriber_status\"\n                type=\"Meetanshi\\CustomerSubscriptionStatus\\Model\\Customer\\Grid\\CollectionPlugin\" sortOrder=\"5\"\/>\n    <\/type>\n<\/config><\/pre>\n\n\n\n
Step 4: <\/strong>Now, create a plugin file named CollectionPlugin.php,<\/strong><\/em> as we defined in the earlier file, at the app\/code\/Meetanshi\/CustomerSubscriptionStatus\/Model\/Customer\/Grid\/ <\/strong>directory with the following code:<\/p>\n\n\n\n
<?php\nnamespace Meetanshi\\CustomerSubscriptionStatus\\Model\\Customer\\Grid;\nuse Magento\\Framework\\View\\Element\\UiComponent\\DataProvider\\CollectionFactory;\nclass CollectionPlugin\n{\n    public function afterGetReport(\n        CollectionFactory $subject,\n        $collection,\n        $requestName\n    ){\n\n        if ($requestName == 'customer_listing_data_source') {\n            $select = $collection->getSelect();\n            $select->joinLeft(\n                [\"secondTable\" => $collection->getTable(\"newsletter_subscriber\")],\n                'main_table.entity_id = secondTable.customer_id',\n                ['subscriber_status']\n            );\n            $collection->addFilterToMap('main_table.subscriber_status', 'secondTable.subscriber_status');\n        }\n        return $collection;\n    }\n}<\/pre>\n\n\n\n
Step 5: <\/strong>Create a customer_listing.xml <\/strong><\/em>file at the app\/code\/Meetanshi\/CustomerSubscriptionStatus\/view\/adminhtml\/ui_component\/<\/strong> directory with the following code:<\/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=\"subscriber_status\" sortOrder=\"30\"\n            class=\"Meetanshi\\CustomerSubscriptionStatus\\Ui\\Component\\Listing\\Columns\\Statuses\">\n            <settings>\n                <dataType>select<\/dataType>\n                <options class=\"Meetanshi\\CustomerSubscriptionStatus\\Model\\Subscription\\Statuses\"\/>\n                <filter>select<\/filter>\n                <label translate=\"true\">Subscriber Status<\/label>\n            <\/settings>\n        <\/column>\n    <\/columns>\n<\/listing><\/pre>\n\n\n\n
Step 6: <\/strong>Create Statuses.php <\/strong><\/em>file at the app\/code\/Meetanshi\/CustomerSubscriptionStatus\/Model\/Subscription\/ <\/strong>directory with the following code:<\/p>\n\n\n\n
<?php\n\nnamespace Meetanshi\\CustomerSubscriptionStatus\\Model\\Subscription;\n\nuse Magento\\Framework\\Option\\ArrayInterface;\n\nclass Statuses implements ArrayInterface\n{\n    \/**\n     * Retrieve options array.\n     *\n     * @return array\n     *\/\n    public function toOptionArray()\n    {\n        $result = [\n            ['value' => 1, 'label' => __(\"Subscribed\")],\n            ['value' => 2, 'label' => __(\"Not Activate\")],\n            ['value' => 3, 'label' => __(\"Not Subscribed\")],\n            ['value' => 4, 'label' => __(\"Not Confirmed\")],\n        ];\n\n        return $result;\n    }\n}<\/pre>\n\n\n\n
This will convert the newsletter subscription statuses into labels, which will be displayed in the customer grid.<\/p>\n\n\n\n
Step 7: <\/strong>Lastly, create Statuses.php <\/strong><\/em>file in the CustomerSubscriptionStatus\\CustomerSubscriptionStatus\\Ui\\Component\\Listing\\Columns<\/strong> directory with the following code:<\/p>\n\n\n\n
<?php\n\nnamespace Meetanshi\\CustomerSubscriptionStatus\\Ui\\Component\\Listing\\Columns;\nuse Magento\\Framework\\View\\Element\\UiComponent\\ContextInterface;\nuse Magento\\Framework\\View\\Element\\UiComponentFactory;\nuse Magento\\Ui\\Component\\Listing\\Columns\\Column;\n\nclass Statuses extends Column\n{\n    public function construct(\n        ContextInterface $context, UiComponentFactory $uiComponentFactory, array $components = [], array $data = []\n    ) {\n        parent::construct($context, $uiComponentFactory, $components, $data);\n    }\n\n    public function prepareDataSource(array $dataSource)\n    {\n        if (isset($dataSource['data']['items'])) {\n            foreach ($dataSource['data']['items'] as & $item) {\n                $status = $item['subscriber_status'];\n                if ($status == 1)\n                    $name = __('Subscribed');\n                elseif ($status == 3)\n                    $name = __('Not Subscribed');\n                else\n                    $name = __('');\n                $item[$this->getData('name')] = $name;\n            }\n        }\n\n        return $dataSource;\n    }\n}<\/pre>\n\n\n\n
& that\u2019s it!
Related Read:<\/strong> How to Enable Ajax Newsletter in Magento 2<\/a><\/p>\n\n\n\n
It will add newsletter subscription column to customer grid in Magento 2. If you get an error of unsubscribe link for newsletter in Magento 2 not working<\/a> solve it as soon as possible to stop your customers from getting frustrated.<\/p>\n\n\n\n
Did you find this Magento solution helpful? Let me know in the comments below.<\/p>\n\n\n\n
Share this post with your friends and spread the Magento knowledge.  <\/p>\n\n\n\n
Thanks for reading\u2026!  <\/p>\n","protected":false},"excerpt":{"rendered":"
Looking for a method to add newsletter subscription column to customer grid in Magento 2? Find the complete solution here. An email newsletter is an important…<\/p>\n","protected":false},"author":38,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[34],"tags":[],"class_list":["post-2702","post","type-post","status-publish","format-standard","hentry","category-magento"],"acf":[],"_links":{"self":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/2702","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/users\/38"}],"replies":[{"embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/comments?post=2702"}],"version-history":[{"count":3,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/2702\/revisions"}],"predecessor-version":[{"id":9370,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/posts\/2702\/revisions\/9370"}],"wp:attachment":[{"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/media?parent=2702"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/categories?post=2702"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/meetanshi.com\/blog\/wp-json\/wp\/v2\/tags?post=2702"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}