# run-as-root/magento2-product-grid-category-filter

> Provides the possibility to filter products by categories in Magento Admin Product Grid

`composer require run-as-root/magento2-product-grid-category-filter`

Canonical URL: https://packagento.com/run-as-root/magento2-product-grid-category-filter

## At a glance

- **Vendor**: run-as-root (https://packagento.com/run-as-root.md)
- **Latest version**: 1.0.0 — released 2024-03-08
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/run-as-root/magento2-product-grid-category-filter and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require run-as-root/magento2-product-grid-category-filter:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Provides the possibility to filter products by categories in Magento Admin Product Grid

## README

![Magento 2](https://img.shields.io/badge/Magento-2.4.*-orange)
![PHP](https://img.shields.io/badge/php-8.1-blue)
![PHP](https://img.shields.io/badge/php-8.2-blue)
![packagist](https://img.shields.io/badge/packagist-f28d1a)
![build](https://github.com/run-as-root/magento2-product-grid-category-filter/actions/workflows/test_extension.yml/badge.svg)

### Overview 

This open-source Magento 2 module enhances the functionality of the Magento Admin Product Grid by introducing the ability to filter products by categories directly from the product grid interface.  
By enabling category-based filtering, users can quickly and easily find products within specific categories.

After installing the module you will see a new column in the product grid called "Categories". This column will display the categories that the product is assigned to.

An example of the category filter in action is shown below:

![category-filter-opened.png](docs%2Fcategory-filter-opened.png)


![category-filter.png](docs%2Fcategory-filter.png)

An example of the category column on the product grid is shown below:
![product-grid.png](docs%2Fproduct-grid.png)

### Installation

#### Via Composer

1. Run the following command in your Magento 2 root directory to install the module via Composer:

```bash
composer require run-as-root/magento2-product-grid-category-filter
```

2. Enabling the module by running:

```bash
php bin/magento module:enable RunAsRoot_ProductGridCategoryFilter
```

### Configuration

No additional configuration is required after installation. The category filter will automatically appear in the Admin Product Grid, allowing you to filter products by categories immediately.

### Support

This module is provided as-is, but we welcome contributions and feedback on GitHub. Please feel free to submit issues or pull requests to improve the module.

### License

This module is open-source and released under the [MIT Licence](https://opensource.org/licenses/MIT).

## Recent Versions

| Version | Released |
|---|---|
| 1.0.0 | 2024-03-08 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | 103.0.* |
| magento/module-catalog | 104.0.* |
| magento/module-store | 101.1.* |
| magento/module-ui | 101.2.* |
| php | ^8.1 |

### Require (dev)

| Package | Constraint |
|---|---|
| bitexpert/phpstan-magento | ^0.30 |
| magento/magento-coding-standard | 32 |
| pdepend/pdepend | ^2.13 |
| phpmd/phpmd | ^2.13 |
| phpstan/phpstan | ^1.10 |
| phpunit/phpunit | ~9.5.20 |
| roave/security-advisories | dev-master |
| sebastian/phpcpd | ^6.0 |
| slevomat/coding-standard | ^8.8 |
| squizlabs/php_codesniffer | ~3.9.0 |

## Quality

Latest release (1.0.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 11 | 2 errors, 9 warnings (ruleset: Magento2) |
| PHPMD | Warning | 1 | 1 rule violation (MissingImport:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Pass | 0 |  |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | Error | not tested |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Fail | 14 | 14 advisories (high:8, low:2, medium:4); 8 high+, 4 medium/unknown, 2 low |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["run-as-root/magento2-product-grid-category-filter"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

run-as-root is a Magento 2 vendor on Packagento. See https://packagento.com/run-as-root.md for their full catalogue.