PHPackages                             esign/laravel-query-filters - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. esign/laravel-query-filters

ActiveLibrary[Utility & Helpers](/categories/utility)

esign/laravel-query-filters
===========================

Apply filters to Laravel's query builder.

1.4.0(1mo ago)012.2k↓45%MITPHPPHP ^8.1CI passing

Since Jun 15Pushed 1mo ago3 watchersCompare

[ Source](https://github.com/esign/laravel-query-filters)[ Packagist](https://packagist.org/packages/esign/laravel-query-filters)[ Docs](https://github.com/esign/laravel-query-filters)[ RSS](/packages/esign-laravel-query-filters/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (14)Versions (9)Used By (0)

Apply filters to Laravel's query builder.
=========================================

[](#apply-filters-to-laravels-query-builder)

[![Latest Version on Packagist](https://camo.githubusercontent.com/18b96802c3e82948c3609a9e6f7019adfd1ce3a05f4e55e001353525e28012d9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f657369676e2f6c61726176656c2d71756572792d66696c746572732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/esign/laravel-query-filters)[![Total Downloads](https://camo.githubusercontent.com/c9ab2679016ab9428efda983aa482e3757bb4f1e9b3c405eccd7c7b761f9c82a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f657369676e2f6c61726176656c2d71756572792d66696c746572732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/esign/laravel-query-filters)[![GitHub Actions](https://github.com/esign/laravel-query-filters/actions/workflows/main.yml/badge.svg)](https://github.com/esign/laravel-query-filters/actions/workflows/main.yml/badge.svg)

This package allows you to easily apply filters to Laravel's query builder by abstracting filter logic into dedicated classes.

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require esign/laravel-query-filters
```

The package will automatically register a service provider.

Usage
-----

[](#usage)

### Preparing your model

[](#preparing-your-model)

To apply filters to your model you may use the `Esign\QueryFilters\Concerns\Filterable` trait:

```
use Esign\QueryFilters\Concerns\Filterable;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use Filterable;
}
```

### Applying filters

[](#applying-filters)

After applying the trait to your model, a query scope `filter` will be available, that accepts an array of possible filters:

```
use App\Models\Filters\TitleFilter;
use App\Models\Filters\BodyFilter;

Post::filter([
    TitleFilter::class,
    BodyFilter::class,
])->get();
```

The `filter` scope will send the query builder through an array of filters. To pass the query builder to the next filter, you should call the `$next` callback with the `$query`.

You're not limited to only using string based classes as filters, you can pass actual instances, callbacks, or pass parameters along with your class based string:

```
use App\Models\Filters\TitleFilter;
use Closure;
use Illuminate\Database\Eloquent\Builder;

Post::filter([
    // Class strings
    TitleFilter::class,
    // Class strings that pass a parameter to the handle method
    TitleFilter::class . ':dogs',
    // Class instance with a constructor parameter
    new TitleFilter('dogs'),
    // Use a callback
    function (Builder $query, Closure $next): Builder {
        $query->where('title', 'like', '%dogs%');

        return $next($query);
    },
])->get();
```

### Defining default filters

[](#defining-default-filters)

In case you do not provide an array of filter items, you may define a set of default filters on your model:

```
use App\Models\Filters\TitleFilter;
use Esign\QueryFilters\Concerns\Filterable;
use Illuminate\Database\Eloquent\Model;

class Post extends Model
{
    use Filterable;

    public function getFilters(): array
    {
        return [
            TitleFilter::class,
        ];
    }
}
```

You may now call the `filter` scope without passing an array:

```
Post::filter()->get();
```

### Creating filters

[](#creating-filters)

To create a filter class you may use the `make:filter` Artisan command:

```
php artisan make:filter TitleFilter
```

```
namespace App\Models\Filters;

use Closure;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Http\Request;

class TitleFilter
{
    public function __construct(protected Request $request)
    {}

    public function handle(Builder $query, Closure $next): Builder
    {
        $query->where('title', 'like', '%' . $this->request->query('search') . '%');

        return $next($query);
    }
}
```

### Method filters

[](#method-filters)

This package also ships with a handy `MethodFilter` class that allows you to define filters for query string parameters as methods. Imagine we have a request that filters a list of posts with the following query string: `?published_at=2022-01-01&title=dogs`. We could create a `PostFilter` that extends the `MethodFilter` class with the camelcased method names:

```
use Esign\QueryFilters\Filters\MethodFilter;
use Illuminate\Database\Eloquent\Builder;

class PostFilter extends MethodFilter
{
    public function title(mixed $value): Builder
    {
        return $this->query->where('title', 'like', "%$value%");
    }

    public function publishedAt(mixed $value): Builder
    {
        return $this->query->where('published_at', '=', $value);
    }
}
```

By default, query string parameters that contain an empty value won't be called.

### Testing

[](#testing)

```
composer test
```

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

50

—

FairBetter than 95% of packages

Maintenance89

Actively maintained with recent releases

Popularity25

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 82.1% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~274 days

Total

6

Last Release

56d ago

PHP version history (2 changes)1.0.0PHP ^8.0

1.3.0PHP ^8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/4599d7a8f6fdb63dd04305a49ae5ec9700b7a6eacdbe3a54f89584d75e34503f?d=identicon)[esign](/maintainers/esign)

---

Top Contributors

[![jordyvanderhaegen](https://avatars.githubusercontent.com/u/24370626?v=4)](https://github.com/jordyvanderhaegen "jordyvanderhaegen (23 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (3 commits)")[![Copilot](https://avatars.githubusercontent.com/in/1143301?v=4)](https://github.com/Copilot "Copilot (2 commits)")

---

Tags

esignquery-filter

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/esign-laravel-query-filters/health.svg)

```
[![Health](https://phpackages.com/badges/esign-laravel-query-filters/health.svg)](https://phpackages.com/packages/esign-laravel-query-filters)
```

###  Alternatives

[barryvdh/laravel-ide-helper

Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[orchestra/canvas

Code Generators for Laravel Applications and Packages

21017.2M158](/packages/orchestra-canvas)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

255.2k](/packages/aedart-athenaeum)[fumeapp/modeltyper

Generate TypeScript interfaces from Laravel Models

196277.9k](/packages/fumeapp-modeltyper)[laragear/preload

Effortlessly make a Preload script for your Laravel application.

119363.5k](/packages/laragear-preload)[zonneplan/laravel-module-loader

Module loader for Laravel

24118.4k](/packages/zonneplan-laravel-module-loader)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)