Admin Grid Filter For Custom Table Magento 2

May 1, 2025 by ADMIN 45 views

**Admin Grid Filter for Custom Table in Magento 2**

Introduction

Magento 2 provides a robust admin grid system that allows developers to create custom tables with various columns. However, one of the most common requirements is to add filtering capabilities to these custom tables. In this article, we will explore how to add a filter to a custom table in Magento 2 admin grid.

Prerequisites

Before we dive into the implementation, make sure you have the following:

Magento 2.4 or later installed
A custom table created with columns like patient_first_name, patient_last_name, etc.
The ability to edit the Vendor\Module\Setup\InstallData.php file

Step 1: Create a Filter Model

To add a filter to our custom table, we need to create a filter model. This model will handle the filtering logic and provide the filtered data to the admin grid.

Create a new file Vendor\Module\Model\Admin\Grid\Filter.php with the following code:

namespace Vendor\Module\Model\Admin\Grid;
use Magento\Framework\Model\AbstractModel;
class Filter extends AbstractModel
{
protected $_eventPrefix = 'grid_filter';
public function __construct(
    \Magento\Framework\Model\Context $context,
    \Magento\Framework\Model\InstanceFactory $instanceFactory,
    \Magento\Framework\DataObjectFactory $dataObjectFactory,
    \Magento\Framework\Event\ManagerInterface $eventManager,
    array $data = []
) {
    parent::__construct($context, $instanceFactory, $dataObjectFactory, $eventManager, $data);
}

public function getFilterData()
{
    $filterData = [];
    // Add filter logic here
    return $filterData;
}

}

Step 2: Create a Grid Model

Next, we need to create a grid model that will handle the data retrieval and filtering.

Create a new file Vendor\Module\Model\Admin\Grid.php with the following code:

namespace Vendor\Module\Model\Admin\Grid;
use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
use Magento\Framework\Model\ResourceModel\Db\AbstractDb;
class Grid extends AbstractCollection
{
protected $_idFieldName = 'id';
public function __construct(
    \Magento\Framework\Model\ResourceModel\Db\Context $context,
    \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection $collection,
    \Magento\Framework\DataObjectFactory $dataObjectFactory,
    \Magento\Framework\Event\ManagerInterface $eventManager,
    array $data = []
) {
    parent::__construct($context, $collection, $dataObjectFactory, $eventManager, $data);
}

public function getCollection()
{
    $collection = parent::getCollection();
    $collection-&gt;addFilterToMap(&#39;patient_first_name&#39;, &#39;patient_first_name&#39;);
    $collection-&gt;addFilterToMap(&#39;patient_last_name&#39;, &#39;patient_last_name&#39;);
    return $collection;
}

}

Step 3: Add Filter to Admin Grid

Now that we have our filter model and grid model, we need to add the filter to the admin grid.

Open the Vendor\Module\Setup\InstallData.php file and add the following code:

namespace Vendor\Module\Setup;
Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;
class InstallData implements InstallDataInterface

public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
{
$setup->startSetup();
$setup->getConnection()->createTable(
$setup->getTable('vendor_module_grid_filter'),
[
'id' => [
'type' => \Magento\Framework\DB\Ddl\Table:TYPE_INTEGER,
'unsigned' => true,
'nullable' => false,
'primary' => true,
'identity' => Table::IDENTITY_AUTO,
'comment' => 'ID'
],
'patient_first_name' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
'length' => '255',
'comment' => 'Patient First Name'
],
'patient_last_name' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
'length' => '255',
'comment' => 'Patient Last Name'
]
]
);
$setup->getConnection()->createTable(
$setup->getTable('vendor_module_grid'),
[
'id' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_INTEGER,
'unsigned' => true,
'nullable' => false,
'primary' => true,
'identity' => Table::IDENTITY_AUTO,
'comment' => 'ID'
],
'patient_first_name' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
'length' => '255',
'comment' => 'Patient First Name'
],
'patient_last_name' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
'length' => '255',
'comment' => 'Patient Last Name'
]
]
);
$setup->endSetup();

}

Step 4: Add Filter to Admin Grid Column

Finally, we need to add the filter to the admin grid column.

Open the Vendor\Module\Setup\InstallData.php file and add the following code:

namespace Vendor\Module\Setup;
use Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;
class InstallData implements InstallDataInterface

public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
{
$setup->startSetup();
$setup->getConnection()->createTable(
$setup->getTable('vendor_module_grid_filter'),
[
'id' => [
'type' => \Magento\Framework\DB\Ddl\Table:TYPE_INTEGER,
'unsigned' => true,
'nullable' => false,
'primary' => true,
'identity' => Table::IDENTITY_AUTO,
'comment' => 'ID'
],
'patient_first_name' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
'length' => '255',
'' => 'Patient First Name'
],
'patient_last_name' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
'length' => '255',
'comment' => 'Patient Last Name'
]
]
);
$setup->getConnection()->createTable(
$setup->getTable('vendor_module_grid'),
[
'id' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_INTEGER,
'unsigned' => true,
'nullable' => false,
'primary' => true,
'identity' => Table::IDENTITY_AUTO,
'comment' => 'ID'
],
'patient_first_name' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
'length' => '255',
'comment' => 'Patient First Name'
],
'patient_last_name' => [
'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
'length' => '255',
'comment' => 'Patient Last Name'
]
]
);
$setup->endSetup();

}

Conclusion

In this article, we have learned how to add a filter to a custom table in Magento 2 admin grid. We created a filter model, a grid model, and added the filter to the admin grid column. With this implementation, you can now filter your custom table by patient first name and last name.

Example Use Case

To use this implementation, follow these steps:

Create a new table in your database with the columns patient_first_name and patient_last_name.
Create a new file Vendor\Module\Model\Admin\Grid\Filter.php with the filter model implementation.
Create a new file Vendor\Module\Model\Admin\Grid.php with the grid model implementation.
Add the filter to the admin grid column by modifying the Vendor\Module\Setup\InstallData.php file.
Run the installation script to create the tables and add the filter to the admin grid.

Troubleshooting

If you encounter any issues during the implementation, make sure to check the following:

The filter model and grid model are correctly implemented.
The filter is added to the admin grid column correctly.
The tables are created correctly in the database.

Introduction

In our previous article, we explored how to add a filter to a custom table in Magento 2 admin grid. However, we understand that implementing this feature can be complex and may raise several questions. In this article, we will address some of the most frequently asked questions related to adding a filter to a custom table in Magento 2 admin grid.

Q: What is the purpose of the filter model?

A: The filter model is responsible for handling the filtering logic and providing the filtered data to the admin grid. It is an essential component of the admin grid filter implementation.

Q: How do I create a filter model?

A: To create a filter model, you need to create a new file in the Vendor\Module\Model\Admin\Grid namespace. The file should contain the filter model implementation, which includes the getFilterData() method.

Q: What is the purpose of the grid model?

A: The grid model is responsible for handling the data retrieval and filtering. It is an essential component of the admin grid filter implementation.

Q: How do I create a grid model?

A: To create a grid model, you need to create a new file in the Vendor\Module\Model\Admin\Grid namespace. The file should contain the grid model implementation, which includes the getCollection() method.

Q: How do I add a filter to the admin grid column?

A: To add a filter to the admin grid column, you need to modify the Vendor\Module\Setup\InstallData.php file. You should add the filter to the admin grid column by modifying the addFilterToMap() method.

Q: What are the benefits of using the admin grid filter?

A: The admin grid filter provides several benefits, including:

Improved user experience: The filter allows users to quickly and easily find the data they need.
Increased productivity: The filter reduces the time it takes to find the data, making it easier to work with the admin grid.
Enhanced data management: The filter provides a more efficient way to manage data, reducing the risk of errors and inconsistencies.

Q: What are some common issues that may arise during implementation?

A: Some common issues that may arise during implementation include:

Incorrect filter model or grid model implementation
Incorrect filter addition to the admin grid column
Database table creation issues
Installation script errors

Q: How do I troubleshoot common issues?

A: To troubleshoot common issues, you should:

Check the filter model and grid model implementation for errors
Verify that the filter is added to the admin grid column correctly
Check the database table creation for errors
Run the installation script again to ensure that it completes successfully

Conclusion

In this article, we have addressed some of the most frequently asked questions related to adding a filter to a custom table in Magento 2 admin grid. We hope that this Q&A article has provided valuable insights and helped you to better understand the implementation process.

Example Use Case

To use this implementation, follow these steps:

Create a new table in your database with the columns patient_first_name and patient_last_name.
Create a new file Vendor\Module\Model\Admin\Grid\Filter.php with the filter model implementation.
Create a new file Vendor\Module\Model\Admin\Grid.php with the grid model implementation.
Add the filter to the admin grid column by modifying the Vendor\Module\Setup\InstallData.php file.
Run the installation script to create the tables and add the filter to the admin grid.

Troubleshooting

If you encounter any issues during the implementation, make sure to check the following:

The filter model and grid model are correctly implemented.
The filter is added to the admin grid column correctly.
The tables are created correctly in the database.

By following these steps and troubleshooting tips, you should be able to successfully add a filter to your custom table in Magento 2 admin grid.