PHPackages                             kba-team/cakephp-filter-plugin - 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 &amp; Filtering](/categories/search)
4. /
5. kba-team/cakephp-filter-plugin

ActiveCakephp-plugin[Search &amp; Filtering](/categories/search)

kba-team/cakephp-filter-plugin
==============================

Filter is a CakePHP plugin which enables you to create filtering forms for your data in a very fast and simple way, without getting in the way of paging, sorting and other "standard" things when displaying data. It also remembers the filter conditions in a session, but this can be turned off if undesirable.

v2.1.0(1y ago)02.1kGPL-3.0-or-laterPHPPHP &gt;=8.1, &lt;8.4

Since Jun 23Pushed 1y agoCompare

[ Source](https://github.com/the-kbA-team/cakephp-filter-plugin)[ Packagist](https://packagist.org/packages/kba-team/cakephp-filter-plugin)[ RSS](/packages/kba-team-cakephp-filter-plugin/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (5)Used By (0)

CakePHP Filter Plugin
=====================

[](#cakephp-filter-plugin)

About
-----

[](#about)

Filter is a [CakePHP](http://cakephp.org/) plugin which enables you to create filtering forms for your data in a very fast and simple way, without getting in the way of paging, sorting and other "standard" things when displaying data. It also remembers the filter conditions in a session, but this can be turned off if undesirable.

It also features callback methods for further search refinement where necessary.

**IMPORTANT**: These instructions are for CakePHP 2.0. If you're using CakePHP 1.3.x the correct path to unload the plugin is `app/plugins/filter/`. More importantly, **if you're using CakePHP 1.3.x you should use the 1.3.x version of this plugin**, not the latest version from GitHub.

Usage
-----

[](#usage)

First, obtain the plugin. If you're using Git, run this while in your app folder:

```
composer require kba-team/cakephp-filter-plugin
```

To use the plugin, you need to tell it which model to filter and which fields to use. For a quick tutorial, visit

If you need more than this plugin provides by default, there are ways to customize it, see this article:

In order to generate GET forms add `'type' => 'GET'` to the `filterForm()` or `beginForm()` options array.

Testing
-------

[](#testing)

To run PHPUnit tests:

```
Test/phpunit.sh
```

Execute shell for manual testing

```
docker pull devkba/cake2-app-template:staging
docker run \
    --rm \
    --init \
    -it \
    -v "$(pwd)":/cakephp-filter-plugin \
    -e DEBUG=0 \
    -e BEFORE_SCRIPT="/cakephp-filter-plugin/Test/before_script.sh" \
    -e AFTER_SCRIPT="/cakephp-filter-plugin/Test/after_script.sh" \
    devkba/cake2-app-template:staging
```

Contributing
------------

[](#contributing)

If you'd like to contribute, clone the source on GitHub, make your changes and send me a pull request. If you don't know how to fix the issue, or you're too lazy to do it, create a ticket, and we'll see what happens next.

**Important**: If you're sending a patch, follow the coding style! If you don't, there is a great chance I won't accept it. For example:

```
// bad
public function drink() {
    return false;
}
```

```
// good
public function drink()
{
    return true;
}
```

Licence
-------

[](#licence)

Multi-licensed under:

- MPL
- LGPL
- GPL

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance33

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~553 days

Total

3

Last Release

685d ago

PHP version history (2 changes)v2.0.0PHP ^7.2

v2.1.0PHP &gt;=8.1, &lt;8.4

### Community

Maintainers

![](https://www.gravatar.com/avatar/d94e4890bfd0a94f6f14f3930fcf8e4de63eb681a0e7b6a24b876ee31d4a8527?d=identicon)[grej](/maintainers/grej)

---

Top Contributors

[![bancer](https://avatars.githubusercontent.com/u/3830106?v=4)](https://github.com/bancer "bancer (45 commits)")[![lecterror](https://avatars.githubusercontent.com/u/80512?v=4)](https://github.com/lecterror "lecterror (41 commits)")[![gregor-j](https://avatars.githubusercontent.com/u/17705875?v=4)](https://github.com/gregor-j "gregor-j (15 commits)")[![mlingureanu](https://avatars.githubusercontent.com/u/18526392?v=4)](https://github.com/mlingureanu "mlingureanu (4 commits)")[![netors](https://avatars.githubusercontent.com/u/893833?v=4)](https://github.com/netors "netors (3 commits)")[![tigerduck42](https://avatars.githubusercontent.com/u/3737924?v=4)](https://github.com/tigerduck42 "tigerduck42 (1 commits)")[![CodeLingoBot](https://avatars.githubusercontent.com/u/45469328?v=4)](https://github.com/CodeLingoBot "CodeLingoBot (1 commits)")[![curtisgibby](https://avatars.githubusercontent.com/u/1086964?v=4)](https://github.com/curtisgibby "curtisgibby (1 commits)")[![gemal](https://avatars.githubusercontent.com/u/69105?v=4)](https://github.com/gemal "gemal (1 commits)")[![baberuth22](https://avatars.githubusercontent.com/u/2997424?v=4)](https://github.com/baberuth22 "baberuth22 (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/kba-team-cakephp-filter-plugin/health.svg)

```
[![Health](https://phpackages.com/badges/kba-team-cakephp-filter-plugin/health.svg)](https://phpackages.com/packages/kba-team-cakephp-filter-plugin)
```

###  Alternatives

[10up/elasticpress

Supercharge WordPress with Elasticsearch.

1.3k374.3k6](/packages/10up-elasticpress)[offline/oc-site-search-plugin

This plugin adds global search capabiliies to OctoberCMS.

4528.2k](/packages/offline-oc-site-search-plugin)[kvz/elasticsearch

CakePHP Plugin for ElasticSearch

4410.5k](/packages/kvz-elasticsearch)

PHPackages © 2026

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