PHPackages                             mehradsadeghi/laravel-filter-querystring - 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. [Search & Filtering](/categories/search)
4. /
5. mehradsadeghi/laravel-filter-querystring

ActiveLibrary[Search & Filtering](/categories/search)

mehradsadeghi/laravel-filter-querystring
========================================

Filter your queries based on url query string parameters like a breeze.

v1.1.14(1y ago)169118.2k—0%26[1 PRs](https://github.com/mehradsadeghi/laravel-filter-querystring/pulls)MITPHPPHP ^7.1|^8.0CI failing

Since Jul 30Pushed 1y ago1 watchersCompare

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

READMEChangelog (2)Dependencies (2)Versions (20)Used By (0)

Laravel Filter Query String
===========================

[](#laravel-filter-query-string)

#### Filter your queries based on url query string parameters like a breeze.

[](#filter-your-queries-based-on-url-query-string-parameters-like-a-breeze)

*Compatible with Laravel **5.x** **6.x** **7.x** **8.x** **9.x** **10.x** **11.x** **12.x***.

Table of Content
----------------

[](#table-of-content)

- [Describing the Problem](#Describing-the-Problem)
- [Usage](#Usage)
    - [Installation](#Usage)
    - [Available Filters](#Available-Methods)
        - [Sort](#Sort)
        - [Comparisons](#Comparisons)
        - [In](#In)
        - [Like](#Like)
        - [Where clause](#Where-Clause-Default-Filter)
    - [Custom Filters](#Custom-Filters)
    - [Conditional Filters](#Conditional-Filters)

Describing the Problem
----------------------

[](#describing-the-problem)

You have probably faced the situation where you needed to filter your query based on given parameters in url query-string and after developing the logics, You've had such a code:

```
$users = User::latest();

if(request('username')) {
    $users->where('username', request('username'));
}

if(request('age')) {
    $users->where('age', '>', request('age'));
}

if(request('email')) {
    $users->where('email', request('email'));
}

return $users->get();
```

This works, But it's not a good practice.

When the number of parameters starts to grow, The number of these kind of `if` statements also grows and your code gets huge and hard to maintain.

Also it's against the Open/Closed principal of SOLID principles, Because when you have a new parameter, You need to get into your existing code and add a new logic (which may breaks the existing implementations).

So we have to design a way to make our filters logics separated from each other and apply them into the final query, which is the whole idea behind this package.

Usage
-----

[](#usage)

1. First you need to install the package:

`$ composer require mehradsadeghi/laravel-filter-querystring`

2. Then you should `use` the `FilterQueryString` trait in your model, And define `$filters` property which can be consist of [available filters](#Available-Methods) or your [custom filters](#custom-filters).

```
use Mehradsadeghi\FilterQueryString\FilterQueryString;

class User extends Model
{
    use FilterQueryString;

    protected $filters = [];

    ...
}
```

3. You need to use `filter()` method in your eloquent query. For example:

```
User::select('name')->filter()->get();
```

### Available Methods

[](#available-methods)

- [Sort](#Sort)
- [Comparisons](#Comparisons)
- [In](#In)
- [Like](#Like)
- [Where clause](#Where-Clause-Default-Filter)

For the purpose of explaining each method, Imagine we have such data in our `users` table:

idnameemailusernameagecreated\_at1mehradmehrad@example.commehrad123202020-09-012rezareza@example.comreza123202020-10-013hosseinhossein@example.comhossein123222020-11-014dariushdariush@example.comdariush123222020-12-01And assume our query is something like this:

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

### Sort

[](#sort)

Sort is the equivalent to `order by` sql statement which can be used flexible in `FilterQueryString`:

Conventions:

```
?sort=field
?sort=field,sort_type
?sort[0]=field1&sort[1]=field2
?sort[0]=field1&sort[1]=field2,sort_type
?sort[0]=field1,sort_type&sort[1]=field2,sort_type

```

In User.php

```
protected $filters = ['sort'];
```

**Single `sort`**:

`https://example.com?sort=created_at`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01rezareza@example.comreza123202020-10-01hosseinhossein@example.comhossein123222020-11-01dariushdariush@example.comdariush123222020-12-01- **Note** that when you're not defining `sort_type`, It'll be `asc` by default.

**Multiple `sort`s**:

`https://example.com?sort[0]=age,desc&sort[1]=created_at,desc`

Output:

nameemailusernameagecreated\_atdariushdariush@example.comdariush123222020-12-01hosseinhossein@example.comhossein123222020-11-01rezareza@example.comreza123202020-10-01mehradmehrad@example.commehrad123202020-09-01**Bare in mind** that `sort` parameter with invalid values will be ignored from query and has no effect to the result.

### Comparisons

[](#comparisons)

Comparisons are consist of 6 filters:

- greater
- greater\_or\_equal
- less
- less\_or\_equal
- between
- not\_between

Conventions:

```
?greater=field,value
?greater_or_equal=field,value
?less=field,value
?less_or_equal=field,value
?between=field,value1,value2
?not_between=field,value1,value2

```

In User.php

```
protected $filters = [
    'greater',
    'greater_or_equal',
    'less',
    'less_or_equal',
    'between',
    'not_between'
];
```

**Example of `greater`**:

`https://example.com?greater=age,20`

Output:

nameemailusernameagecreated\_athosseinhossein@example.comhossein123222020-11-01dariushdariush@example.comdariush123222020-12-01**Example of `not_between`**:

`https://example.com?not_between=age,21,30`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01rezareza@example.comreza123202020-10-01**Bare in mind** that comparison parameters with invalid values will be ignored from query and has no effect to the result.

### In

[](#in)

In clause is the equivalent to `where in` sql statement.

Convention:

```
?in=field,value1,value2

```

In User.php

```
protected $filters = ['in'];
```

**Example**:

`https://example.com?in=name,mehrad,reza`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01rezareza@example.comreza123202020-10-01**Bare in mind** that `in` parameter with invalid values will be ignored from query and has no effect to the result.

### Like

[](#like)

Like clause is the equivalent to `like '%value%'` sql statement.

Conventions:

```
?like=field,value
?like[0]=field1,value1&like[1]=field2,value2

```

In User.php

```
protected $filters = ['like'];
```

**Single `like`**:

`https://example.com?like=name,meh`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01**Multiple `like`s**:

`https://example.com?like[0]=name,meh&like[1]=username,dar`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01dariushdariush@example.comdariush123222020-12-01**Bare in mind** that `like` parameter with invalid values will be ignored from query and has no effect to the result.

### Where Clause (default filter)

[](#where-clause-default-filter)

Generally when your query string parameters are not one of previous available methods, It'll get filtered by the default filter which is the `where` sql statement. It's the proper filter when you need to directly filter one of your table's columns.

Conventions:

```
?field=value
?field1=value&field2=value
?field1[0]=value1&field1[1]=value2
?field1[0]=value1&field1[1]=value2&field2[0]=value1&field2[1]=value2

```

Assuming we want to filter `name`, `username` and `age` database columns, In User.php

```
protected $filters = ['name', 'username', 'age'];
```

**Example**:

`https://example.com?name=mehrad`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01**Example**:

`https://example.com?age=22&username=dariush123`

Output:

nameemailusernameagecreated\_atdariushdariush@example.comdariush123222020-12-01**Example**:

`https://example.com?name[0]=mehrad&name[1]=dariush`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01dariushdariush@example.comdariush123222020-12-01**Example**:

`https://example.com?name[0]=mehrad&name[1]=dariush&username[0]=mehrad123&username[1]=reza1234`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01**Bare in mind** that `default` filter parameter with invalid values will be ignored from query and has no effect to the result.

### Custom Filters

[](#custom-filters)

By custom filters you can define your own methods as filters. This helps with the Open/Closed of SOLID principles, Hence each time a new filter is needed, you don't have to edit previous filters and you can just write a separate method for it.

Let's create a custom filter. Assuming you want to create a filter named `all_except` which retrieves all users except the one that is specified:

In User.php

```
protected $filters = ['all_except'];

public function all_except($query, $value) {
    return $query->where('name', '!=', $value);
}
```

To test our newly added filter:

`https://example.com?all_except=mehrad`

Output:

nameemailusernameagecreated\_atrezareza@example.comreza123202020-10-01hosseinhossein@example.comhossein123222020-11-01dariushdariush@example.comdariush123222020-12-01**Note** that your custom defined filters have the most priority which means you can even override available filters.

For example lets change `in` filter in a way that only accepts 3 values:

In User.php

```
protected $filters = ['in'];

public function in($query, $value) {

    $exploded = explode(',', $value);

    if(count($exploded) != 4) {
        // throwing an exception or whatever you like to do
    }

    $field = array_shift($exploded);

    return $query->whereIn($field, $exploded);
}
```

**Another** good example for custom filters are when you don't want to expose your database table's column name. For example assume we don't want to expose that we have a column named `username` in `users` table:

In User.php

```
protected $filters = ['by'];

public function by($query, $value) {
    return $query->where('username', $value);
}
```

`https://example.com?by=dariush123`

Output:

nameemailusernameagecreated\_atdariushdariush@example.comdariush123222020-12-01#### Minor Tip

[](#minor-tip)

In order to prevent your model to get messy or populated with filter methods, You can create a trait for it and put everything about filters inside the trait.

### Conditional Filters

[](#conditional-filters)

The `$filters` property in your model is acting kind of global for that model. It means when you use `filter()` method on your eloquent query, it'll always performs all the `$filters` filters.

There might be situations that based on a condition you need to specify which filters exactly you wish to be filtered.

To achieve this you can specify your desired filters as arguments in `filter()` method.

Example:

In your query:

```
User::filter('in')->get();
```

`in=name,mehrad,reza&like=name,mehrad`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01rezareza@example.comreza123202020-10-01If the `in` argument was not specified, The result of query would be only one record (`mehrad`).

Another example:

In your query:

```
User::filter('like', 'name')->get();
```

`like=name,mehrad,reza,dariush,hossein&name[0]=mehrad&name[1]=hossein&username=mehrad`

Output:

nameemailusernameagecreated\_atmehradmehrad@example.commehrad123202020-09-01hosseinhossein@example.comhossein123222020-11-01---

### Your Stars Matter

[](#your-stars-matter)

If you find this package useful and you want to encourage me to maintain and work on it, Just press the star button to declare your willing.

---

### Reward me with a cup of tea 🍵

[](#reward-me-with-a-cup-of-tea-tea)

Send me as much as a cup of tea worth in your country, so I'll have the energy to maintain this package.

- Ethereum: 0x2D5BFdEc132F9F0E9498Fb0B58C800db4007D154

###  Health Score

49

—

FairBetter than 95% of packages

Maintenance49

Moderate activity, may be stable

Popularity49

Moderate usage in the ecosystem

Community12

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 100% 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 ~97 days

Recently: every ~351 days

Total

19

Last Release

369d ago

PHP version history (3 changes)v1.0.0PHP ^7.1

v1.1.6PHP >=7.1

v1.1.11PHP ^7.1|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/0061a96703c9d6f044d10d15451dd7118b1c83631a902aee9d1dacbd5a4d0902?d=identicon)[mehradsadeghi](/maintainers/mehradsadeghi)

---

Top Contributors

[![mehradsadeghi](https://avatars.githubusercontent.com/u/31504728?v=4)](https://github.com/mehradsadeghi "mehradsadeghi (64 commits)")

---

Tags

querystringquery-stringqueryfilterfilter-querystringfilter-query-string

### Embed Badge

![Health badge](/badges/mehradsadeghi-laravel-filter-querystring/health.svg)

```
[![Health](https://phpackages.com/badges/mehradsadeghi-laravel-filter-querystring/health.svg)](https://phpackages.com/packages/mehradsadeghi-laravel-filter-querystring)
```

###  Alternatives

[suenerds/nova-searchable-belongs-to-filter

Searchable Nova filter for belongsTo relationships.

29516.9k](/packages/suenerds-nova-searchable-belongs-to-filter)[ambengers/query-filter

Laravel package for filtering resources with request query string

3513.5k](/packages/ambengers-query-filter)[clue/json-query

JSON query language filter in PHP

3015.7k](/packages/clue-json-query)[pos-lifestyle/laravel-nova-date-range-filter

A Laravel Nova date range filter.

16179.1k](/packages/pos-lifestyle-laravel-nova-date-range-filter)[hashemi/queryfilter

A simple & dynamic package for your eloquent query in laravel. It will help you to write query logic individual for each parameter.

391.1k](/packages/hashemi-queryfilter)[mongerinc/search-request

Represent complex search queries and convert them to and from JSON

252.1k](/packages/mongerinc-search-request)

PHPackages © 2026

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