{"id":972,"date":"2020-05-03T16:19:42","date_gmt":"2020-05-03T16:19:42","guid":{"rendered":"https:\/\/meetanshi.com\/blog\/2020\/05\/03\/add-category-column-to-product-grid-in-magento-2\/"},"modified":"2025-05-22T13:20:59","modified_gmt":"2025-05-22T07:50:59","slug":"add-category-column-to-product-grid-in-magento-2","status":"publish","type":"post","link":"https:\/\/meetanshi.com\/blog\/add-category-column-to-product-grid-in-magento-2\/","title":{"rendered":"How to Add Category Column to Product Grid in Magento 2"},"content":{"rendered":"\n

Grids in Magento 2 are an easy way to list, sort, filter, edit, or update data. Earlier I posted the solution to create admin grid in Magento 2<\/a>.<\/p>\n\n\n\n

And taking it a notch up here\u2019s the solution to add category column to product grid in Magento 2<\/strong><\/em>.<\/p>\n\n\n\n

The default Magento 2 product grid allows adding columns of the product attribute. However, adding custom columns of category in the product grid in Magento 2 is not easy. You can also add action column in Magento 2 admin grid<\/a> for enabling you to perform record specific actions such as deleting and editing.<\/p>\n\n\n\n

You can use this solution to add category column which can be useful for better product management and optimized backend performance.<\/p>\n\n\n\n

Method to Add Category Column to Product Grid in Magento 2:<\/h2>\n\n\n\n

Create app\\code\\Vendor\\Extension\\etc\\di.xml<\/strong><\/em><\/strong><\/em><\/p>\n\n\n\n

<?xml version=\"1.0\"?>\n\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:ObjectManager\/etc\/config.xsd\">\n    <preference for=\"Magento\\Catalog\\Ui\\DataProvider\\Product\\ProductDataProvider\" type=\"Vendor\\Extension\\Ui\\DataProvider\\Product\\ProductDataProvider\" \/>\n<\/config><\/pre>\n\n\n\n
Create app\\code\\Vendor\\Extension\\Model\\Category\\Categorylist.php<\/strong><\/em><\/strong><\/em><\/p>\n\n\n\n
<?php\n\nnamespace Vendor\\Extension\\Model\\Category;\n\nclass CategoryList implements \\Magento\\Framework\\Option\\ArrayInterface\n{\n    public function __construct(\n        \\Magento\\Catalog\\Model\\ResourceModel\\Category\\CollectionFactory $collectionFactory\n    ) {\n        $this->_categoryCollectionFactory = $collectionFactory;\n\n    }\n    public function toOptionArray($addEmpty = true)\n    {\n\n         $collection = $this->_categoryCollectionFactory->create();\n        $collection->addAttributeToSelect('name');\/\/->addRootLevelFilter()->load();\n        $options = [];\n        if ($addEmpty) {\n            $options[] = ['label' => __('-- Please Select a Category --'), 'value' => ''];\n        }\n        foreach ($collection as $category) {\n            $options[] = ['label' => $category->getName(), 'value' => $category->getId()];\n        }\n        return $options;\n    }\n}<\/pre>\n\n\n\n
Create app\\code\\Vendor\\Extension\\Ui\\Component\\Listing\\Column\\Category.php<\/strong><\/em><\/strong><\/em><\/p>\n\n\n\n
<?php\n\nnamespace Vendor\\Extension\\Ui\\Component\\Listing\\Column;\n\nuse Magento\\Framework\\View\\Element\\UiComponentFactory;\nuse Magento\\Framework\\View\\Element\\UiComponent\\ContextInterface;\n\nclass Category extends \\Magento\\Ui\\Component\\Listing\\Columns\\Column\n{\n\n    public function prepareDataSource(array $dataSource)\n    {\n        $fieldName = $this->getData('name');\n        if (isset($dataSource['data']['items'])) {\n            foreach ($dataSource['data']['items'] as & $item) {\n                $productId = $item['entity_id'];\n\n                $objectManager = \\Magento\\Framework\\App\\ObjectManager::getInstance();\n                $product = $objectManager->create('Magento\\Catalog\\Model\\Product')->load($productId);\n                $cats = $product->getCategoryIds();\n                $categories = array();\n                if (count($cats)) {\n                    foreach ($cats as $cat) {\n                        $category = $objectManager->create('Magento\\Catalog\\Model\\Category')->load($cat);\n                        $categories[] = $category->getName();\n                    }\n                }\n                $item[$fieldName] = implode(',', $categories);\n            }\n        }\n        return $dataSource;\n    }\n}<\/pre>\n\n\n\n
Create app\\code\\Vendor\\Extension\\Ui\\DataProvider\\Product\\ProductDataProvider.php<\/strong><\/em><\/strong><\/em><\/p>\n\n\n\n
<?php\n\nnamespace Vendor\\Extension\\Ui\\DataProvider\\Product;\n\nclass ProductDataProvider extends \\Magento\\Catalog\\Ui\\DataProvider\\Product\\ProductDataProvider\n{\n    public function addFilter(\\Magento\\Framework\\Api\\Filter $filter)\n    {\n        if ($filter->getField() == 'category_id') {\n            $this->getCollection()->addCategoriesFilter(array('in' => $filter->getValue()));\n        } elseif (isset($this->addFilterStrategies[$filter->getField()])) {\n            $this->addFilterStrategies[$filter->getField()]\n                ->addFilter(\n                    $this->getCollection(),\n                    $filter->getField(),\n                    [$filter->getConditionType() => $filter->getValue()]\n                );\n        } else {\n            parent::addFilter($filter);\n        }\n    }\n}<\/pre>\n\n\n\n
Create app\\code\\Vendor\\Extension\\view\\adminhtml\\ui_component\\product_listing.xml<\/strong><\/em><\/strong><\/em><\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<listing xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:module:Magento_Ui:etc\/ui_configuration.xsd\">\n    <columns name=\"product_columns\" class=\"Magento\\Catalog\\Ui\\Component\\Listing\\Columns\">\n        <column name=\"category_id\" class=\"Vendor\\Extension\\Ui\\Component\\Listing\\Column\\Category\">\n            <argument name=\"data\" xsi:type=\"array\">\n                <item name=\"options\" xsi:type=\"object\">Vendor\\Extension\\Model\\Category\\Categorylist<\/item>\n                <item name=\"config\" xsi:type=\"array\">\n                    <item name=\"filter\" xsi:type=\"string\">select<\/item>\n                    <item name=\"add_field\" xsi:type=\"boolean\">true<\/item>\n                    <item name=\"label\" xsi:type=\"string\" translate=\"true\">Categories<\/item>\n                    <item name=\"sortOrder\" xsi:type=\"number\">75<\/item>\n                    <item name=\"dataType\" xsi:type=\"string\">select<\/item>\n                <\/item>\n            <\/argument>\n        <\/column>\n        <column name=\"created_at\" class=\"Magento\\Ui\\Component\\Listing\\Columns\\Date\">\n            <argument name=\"data\" xsi:type=\"array\">\n                <item name=\"config\" xsi:type=\"array\">\n                    <item name=\"filter\" xsi:type=\"string\">dateRange<\/item>\n                    <item name=\"component\" xsi:type=\"string\">Magento_Ui\/js\/grid\/columns\/date<\/item>\n                    <item name=\"dataType\" xsi:type=\"string\">date<\/item>\n                    <item name=\"label\" xsi:type=\"string\" translate=\"true\">Created At<\/item>\n                <\/item>\n            <\/argument>\n        <\/column>\n        <column name=\"updated_at\" class=\"Magento\\Ui\\Component\\Listing\\Columns\\Date\">\n            <argument name=\"data\" xsi:type=\"array\">\n                <item name=\"config\" xsi:type=\"array\">\n                    <item name=\"filter\" xsi:type=\"string\">dateRange<\/item>\n                    <item name=\"component\" xsi:type=\"string\">Magento_Ui\/js\/grid\/columns\/date<\/item>\n                    <item name=\"dataType\" xsi:type=\"string\">date<\/item>\n                    <item name=\"label\" xsi:type=\"string\" translate=\"true\">Updated At<\/item>\n                <\/item>\n            <\/argument>\n        <\/column>\n    <\/columns>\n<\/listing><\/pre>\n\n\n\n
That\u2019s it.<\/p>\n\n\n\n
If you want to directly download this extension from Github, check here<\/a>.<\/p>\n\n\n\n
Please share the solution with fellow developers via social media.<\/p>\n\n\n\n
Thank you.<\/p>\n\n\n\n
Also Read:<\/strong><\/p>\n\n\n\n