jreviews:search_live_results.filter_params
Filters the normalized filter param bag used by the live search query and view-all URL builder. Use this to add, remove, or transform request-derived search params before execution.
You need to have a working knowledge of Hooks before you get started.
Fires while building the live search filter param bag, before checking for input or running the query
Parameters
| Name | Type | Description |
|---|---|---|
$filterParams |
array |
The normalized live search filter params |
$request |
\FWD\Illuminate\Http\Request |
The current request |
$activeFilters |
array |
Active custom field filters parsed from the request |
$matchParams |
array |
Per-field AND/OR match flags parsed from the request |
$controller |
self |
The SearchLiveResultsController instance |
Boilerplate Code
Use the boilerplate code to start using the filter, and add your own logic to modify the first argument and return it.
fwd_add_filter('jreviews:search_live_results.filter_params', function($filterParams, $request, $activeFilters, $matchParams, $controller)
{
// Your code here
return $filterParams;
}, 20, 5);
The , 20, N after your callback are the hook priority and the number of arguments your callback accepts. By default, a hook passes your callback only its first argument; for a filter, that is the value being filtered, so a simple function($value) { ... } needs nothing extra. If your callback declares more parameters, such as function($value, $listing) { ... }, you must add N (the parameter count, 2 here). Because N is the fourth argument to fwd_add_filter() or fwd_add_action(), you must also pass the priority (20 is the default). Leaving these off when your callback expects extra parameters causes a Too few arguments to function ... fatal error.
Source Files
app/Http/Site/Controllers/SearchLiveResultsController.php