jreviews:listings_list.filter_params
Filters the normalized listings list param array before it is passed into search/filter query logic. Use this to inject derived params, remove unsupported filters, or transform request values for custom list behavior.
You need to have a working knowledge of Hooks before you get started.
Fires after the component assembles built-in list/search params and before they are consumed by query logic
Parameters
| Name | Type | Description |
|---|---|---|
$params |
array |
The normalized listings list filter params |
$request |
array |
The normalized request params for the component |
$component |
self |
The ListingsList component 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:listings_list.filter_params', function($params, $request, $component)
{
// Your code here
return $params;
}, 20, 3);
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/Yoyo/Listing/ListingsList.php