If you are a Magento 2 store admin, you must be quite acquainted with the backend grids. You also might frequently export the data of the grid for analysis, order management, stock management, etc.<\/p>\n\n\n\n
Now, you might be unaware of the developer\u2019s tricks!<\/p>\n\n\n\n
I mean to say that there are certain columns in the admin grid that are there because of some operations under the column values from the database table.<\/p>\n\n\n\n
For example, \u201cmark 1\u201d and \u201cmark 2\u201d columns are present in the database and the admin panel. Now \u201cmark 3\u201d is obtained by adding the values from the column mark 1 and mark 2 and displayed in the admin grid.<\/p>\n\n\n\n
When you export to CSV from the admin panel, the mark 3 column won\u2019t be exported along with the other columns sometimes as it is not present in the database table.<\/p>\n\n\n\n
The below code can be used as the solution in such cases.<\/p>\n\n\n\n
Also, if you want to export CSV with custom changes made, this method to include custom column in export to CSV in Magento 2 can be useful:<\/p>\n\n\n\n
Create app\/code\/Vendor\/Module\/view\/adminhtml\/ui_component\/component.xml<\/strong><\/p>\n\n\n\n Create app\/code\/Vendor\/Module\/etc\/di.xml<\/strong><\/p>\n\n\n\n Create app\/code\/Meetanshi\/CustomReportOrder\/Model\/Export\/ConvertToCsv.php<\/strong><\/p>\n\n\n\n Modify this file as per your requirement<\/p>\n\n\n\n Execute the below command: That\u2019s it.<\/p>\n\n\n\n You can learn the method to add a custom column in order grid in Magento 2 <\/a>in the first place. Or you can just install Magento 2 Custom Order Grid<\/a> extension that allows adding 50+ custom columns in Magento 2. Not only that, but it also offers the facility to track the order information and improve the order processing and management system in Magento 2 store.<\/p>\n\n\n\n Likewise you can also\u00a0Display image thumbnail column in Magento 2 admin UI grid<\/a>.<\/p>\n\n\n\n Please share the solution with the Magento community via social media.<\/p>\n\n\n\n Thank you.<\/p>\n\n\n\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 <exportButton name=\"export_button\"\/>\n <\/listingToolbar>\n<\/listing><\/pre>\n\n\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\\Ui\\Model\\Export\\ConvertToCsv\" type=\"Vendor\\Module\\Model\\Export\\ConvertToCsv\" \/>\n<\/config><\/pre>\n\n\n\n
<?php\n\/**\n * Copyright \u00a9 Magento, Inc. All rights reserved.\n * See COPYING.txt for license details.\n *\/\nnamespace Module\\Vendor\\Model\\Export;\nuse Magento\\Framework\\App\\Filesystem\\DirectoryList;\nuse Magento\\Framework\\Exception\\FileSystemException;\nuse Magento\\Framework\\Exception\\LocalizedException;\nuse Magento\\Framework\\Filesystem;\nuse Magento\\Framework\\Stdlib\\DateTime\\TimezoneInterface;\nuse Magento\\Ui\\Component\\MassAction\\Filter;\nuse Magento\\Ui\\Model\\Export\\MetadataProvider;\nuse Magento\\Ui\\Model\\Export\\ConvertToCsv as ConvertToCsvParent;\n\/**\n * Class ConvertToCsv\n *\/\nclass ConvertToCsv extends ConvertToCsvParent\n{\n \/**\n * @var DirectoryList\n *\/\n protected $directory;\n \/**\n * @var MetadataProvider\n *\/\n protected $metadataProvider;\n \/**\n * @var int|null\n *\/\n protected $pageSize = null;\n \/**\n * @var Filter\n *\/\n protected $filter;\n \/**\n * @var Product\n *\/\n private $productHelper;\n \/**\n * @var TimezoneInterface\n *\/\n private $timezone;\n \/**\n * @param Filesystem $filesystem\n * @param Filter $filter\n * @param MetadataProvider $metadataProvider\n * @param int $pageSize\n * @throws FileSystemException\n *\/\n public function __construct(\n Filesystem $filesystem,\n Filter $filter,\n MetadataProvider $metadataProvider,\n Product $productHelper,\n TimezoneInterface $timezone,\n $pageSize = 200\n ) {\n $this->filter = $filter;\n $this->directory = $filesystem->getDirectoryWrite(DirectoryList::VAR_DIR);\n $this->metadataProvider = $metadataProvider;\n $this->pageSize = $pageSize;\n $this->productHelper = $productHelper;\n parent::__construct($filesystem, $filter, $metadataProvider, $pageSize);\n $this->timezone = $timezone;\n }\n \/**\n * Returns CSV file\n *\n * @return array\n * @throws LocalizedException\n * @throws \\Exception\n *\/\n public function getCsvFile()\n {\n $component = $this->filter->getComponent();\n $name = md5(microtime());\n $file = 'export\/' . $component->getName() . $name . '.csv';\n $this->filter->prepareComponent($component);\n $this->filter->applySelectionOnTargetProvider();\n $dataProvider = $component->getContext()->getDataProvider();\n $fields = $this->metadataProvider->getFields($component);\n $options = $this->metadataProvider->getOptions();\n $this->directory->create('export');\n $stream = $this->directory->openFile($file, 'w+');\n $stream->lock();\n $stream->writeCsv($this->metadataProvider->getHeaders($component));\n $i = 1;\n $searchCriteria = $dataProvider->getSearchCriteria()\n ->setCurrentPage($i)\n ->setPageSize($this->pageSize);\n $totalCount = (int)$dataProvider->getSearchResult()->getTotalCount();\n while ($totalCount > 0)\n {\n $items = $dataProvider->getSearchResult()->getItems();\n if ($component->getName() == 'customReportOrder_post_listing')\n {\n foreach ($items as $item)\n {\n $this->metadataProvider->convertDate($item, $component->getName());\n $stream->writeCsv($this->metadataProvider->getRowData($item, $fields, $options));\n }\n }\n else\n {\n foreach ($items as $item) {\n $this->metadataProvider->convertDate($item, $component->getName());\n $stream->writeCsv($this->metadataProvider->getRowData($item, $fields, $options));\n }\n }\n $searchCriteria->setCurrentPage(++$i);\n $totalCount = $totalCount - $this->pageSize;\n }\n $stream->unlock();\n $stream->close();\n return [\n 'type' => 'filename',\n 'value' => $file,\n 'rm' => true \/\/ can delete file after use\n ];\n }\n}<\/pre>\n\n\n\n
php bin\/magento cache:flush<\/strong><\/p>\n\n\n\n