NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
Packagist
Packagist, #3397 most downloaded on Packagist
CakePHP Search plugin using PRG pattern
Latest stable
7.9.0
Last release 6 months ago
11 May 2026
Release timing varies
gaps range from 2 weeks to 1.1 years
Nearly every release is documented
notes for 55 of 60 stable releases
Nothing withdrawn
no release was ever pulled
11 years old
63 releases · first in 2015
Drag across the ruler to compare, or tap a release to open it.
Callback::process(): deprecate null returns from user callbacks. The documented contract is that callbacks return bool to drive isSearch(); missing re…
Processor::process(): prevent extraParams from leaking between filters. A filter that does not declare extraParams no longer sees values requested by another filter earlier in the chain (#374).Like::_setEscaper(): replace brittle substr_compare driver detection with instanceof checks, and stop caching the resolved escaper into the filter config so each query resolves afresh. Custom or sub-classed Sqlserver/Postgres drivers now select the correct escaper (#374).Mapped filter for applying a default condition without triggering isSearch() — useful when you want a filter to be active by default (e.g. "show only enabled records") but the Reset link should only appear once the user changes the value. Configured via a map (form value → filter condition, with null meaning "no filter") and a default key marking which value is the non-search default. Unmapped non-empty values pass through as the condition (#373).Like filter: new escapers config option lets apps register custom driver-to-escaper mappings without subclassing the filter. Shipped defaults (Sqlserver, Postgres) are merged in via _defaultConfig; entries are evaluated in iteration order with instanceof matching, falling back to Search.Default when nothing matches (#375).Like filter: added a Postgres branch with a new PostgresEscaper class (currently inherits from DefaultEscaper) so driver-specific wildcard rules can diverge in the future without breaking the public API (#374).Callback::process(): deprecate null returns from user callbacks. The documented contract is that callbacks return bool to drive isSearch(); missing return values are still coerced to true but now emit a deprecation pointing at the offending callback by name. Update your callbacks to return an explicit boolean (#374).Full Changelog: https://github.com/FriendsOfCake/search/compare/7.8.0...7.9.0
Your coding agent can read these notes before it upgrades. Set up the MCP server →
Update deprecation warning version in SearchTrait by @LordSimal in https://github.com/FriendsOfCake/search/pull/369
strictMode config for misconfigured SearchComponent by @dereuromark in https://github.com/FriendsOfCake/search/pull/371
RuntimeException with clear messages identifying the controller, action, and what went wrongfalse preserves existing behavior for AppController use casesFull Changelog: https://github.com/FriendsOfCake/search/compare/7.7.2...7.8.0
Add option to autoload the search helper. by @ADmad in https://github.com/FriendsOfCake/search/pull/367
Full Changelog: https://github.com/FriendsOfCake/search/compare/7.7.1...7.7.2
Update searchManager() access by @ADmad in https://github.com/FriendsOfCake/search/pull/366
Full Changelog: https://github.com/FriendsOfCake/search/compare/7.7.0...7.7.1
Fix deprecation error on CakePHP 5.3 by @ADmad in https://github.com/FriendsOfCake/search/pull/359
Full Changelog: https://github.com/FriendsOfCake/search/compare/7.6.1...7.7.0
Use Form::execute() instead of Form::validate(). by @ADmad in https://github.com/FriendsOfCake/search/pull/355
Full Changelog: https://github.com/FriendsOfCake/search/compare/7.6.0...7.6.1
Add formClass option to the SearchComponent. by @ADmad in https://github.com/FriendsOfCake/search/pull/354
formClass option to the SearchComponent. by @ADmad in https://github.com/FriendsOfCake/search/pull/354Full Changelog: https://github.com/FriendsOfCake/search/compare/7.5.0...7.6.0
Allow global Search component configuration using Configure key 'Search.component' by @dereuromark in https://github.com/FriendsOfCake/search/pull/353
'Search.component' by @dereuromark in https://github.com/FriendsOfCake/search/pull/353Full Changelog: https://github.com/FriendsOfCake/search/compare/7.4.0...7.5.0
Fixed deprecation warning in CakePHP 5.2 by @bakewizard in https://github.com/FriendsOfCake/search/pull/350
If you extended Search component, make sure to adjust the signature of startup() to:
public function startup(EventInterface $event): void
Full Changelog: https://github.com/FriendsOfCake/search/compare/7.3.0...7.4.0
Add empty checking via callable for more dynamic use cases. by @dereuromark in https://github.com/FriendsOfCake/search/pull/348
Full Changelog: https://github.com/FriendsOfCake/search/compare/7.2.0...7.3.0
Cleanup by @ADmad in https://github.com/FriendsOfCake/search/pull/343
Full Changelog: https://github.com/FriendsOfCake/search/compare/7.1.0...7.2.0
Just helping bump where I see things need to be updated. by @fr3nch13 in https://github.com/FriendsOfCake/search/pull/336
Full Changelog: https://github.com/FriendsOfCake/search/compare/7.0.0...7.1.0
## What's Changed CakePHP 5 compatible release. Full Changelog: https://github.com/FriendsOfCake/search/compare/6.2.5...7.0.0
CakePHP 5 compatible release.
Full Changelog: https://github.com/FriendsOfCake/search/compare/6.2.5...7.0.0
Fix deprecations in tests. by @ADmad in https://github.com/FriendsOfCake/search/pull/319
Full Changelog: https://github.com/FriendsOfCake/search/compare/6.2.4...6.2.5
Add example for combining by @dereuromark in https://github.com/FriendsOfCake/search/pull/293
Full Changelog: https://github.com/FriendsOfCake/search/compare/6.2.3...6.2.4
Fix return value for Boolean::process(). #309
Fix deprecation error on Cake 4.2. #307
Fix error when bake plugin is not loaded. #306
Bake task for filter collections #303
Value filter #304Fixed Search helper to not drop passed params when generating reset URL.
Fixed Search helper to not drop passed params when generating reset URL.
PrgComponent has been renamed to SearchComponent.
PrgComponent has been renamed to SearchComponent.Nothing published for this version
Nothing published for this version
Nothing published for this version
Fix use of collection FQCN with lowercased namespace #262
Allow persisting nested query params (e.g. scoped pagination) #254
Add beforeProcess option which allow specifying a callback which can be used to modify the query / filter arguments or skip the filer before filter pr
beforeProcess option which allow specifying a callback which can be used to modify the query / filter arguments or skip the filer before filter process is run. #251, #252Fix incorrect return value for Boolean::process(). #248
Exists filter. #248Boolean::process(). #248Fix deprecation errors on Cake 3.7.
Add helper for search reset link. #242
New filters collection feature. Check README.
Fix finder to allow setting options. #241
- Add multi value separator #240
Documentation update and code maintenance.
Nothing published for this version
Add support for searching other datasources #203
Add "map" option of Finder filter to map query params to finder options. #204
Finder filter to map query params to finder options. #204$_isSearch view variable being passed down by Prg component automatically.
$_isSearch view variable being passed down by Prg component automatically.Added new emptyValues config to SearchBehavior to allow specifying which values should be treated as empty. #193
emptyValues config to SearchBehavior to allow specifying which values should be treated as empty. #193Allow callback filter to specify process() return value
Fix adding searchManager() method to table class not working as documented #179
searchManager() method to table class not working as documented #179CakePHP dependency bumped to 3.4.0.
3.4.0.Table::searchConfiguration() method removed. Check readme for how to achieve the same separation of code by adding Table::searchManager() instead.queryStringToData option of PrgComponent removed. Setting $this->request->data was pretty hackish. Check readme for how the search inputs can still be easily populated from query string.Add ability to specify values to avoid flattening
All filters now return a boolean result on whether they modified the query. This allows for a more correct "isSearch" value (#164).
Use query interface to allow for other data sources (#156).
Allow "emptyFields" for PRG component in order for isSearch to stay correct (#160).
AND to multiple values would never match.SQL Server LIKE filter escaping
Like filter, integer columns need to be string adjusted in order to avoid wrong SQL queries.Improve values validation and harden the filters that do not support multi-values, as well as those that do.
Shout out to @ndm2 for recent updates and fixes.
Fixed bug where multiselect parameters were ignored
A method to check if the last query has been modified by the Search behavior has been added.
sort, direction and limit. (#121)Include new Search.Boolean filter - please see the README for usage
New features
Search.Boolean filter - please see the README for usage (#112)Fixes
- Fix issue with field aliasing.
Fields are now auto aliased in filters. You can disable this behavior by setting aliasField to false in filter config.
aliasField to false in filter config.SearchBehavior::filterParams() is deprecated. Instead you should just use the custom search finder as $this->Posts->find('search', ['search' => $this-…
$this->Posts->find('search', $this->request->query) has been removed. You will get an exception trying to do so.SearchBehavior::filterParams() is deprecated. Instead you should just use the custom search finder as $this->Posts->find('search', ['search' => $this->request->query])Like filter now allows configuring the wildcard characters.PrgComponent is now by default enabled only for "index" and "lookup" actions. You can modify the actions as needed using the actions key in component config.Fix redirect URL without querystring
Fix typo in config key implementedMethods.
implementedMethods.Fixes errors when used with CakePHP 3.2.3
Nothing published for this version
- #52 Made it easy to use PRG with just specific actions - #57 Fix issue where 0 was incorrectly detected as empty
0 was incorrectly detected as emptyNothing published for this version
One column per quarter.