jreviews:listings_list.active_filters
Filters the grouped active filter chip data rendered above the listings list. Use this to add custom chip groups, rename values, or remove groups that should not be exposed in the active filter UI.
You need to have a working knowledge of Hooks before you get started.
Fires after active listing filter chips are assembled and before they are rendered
Parameters
| Name | Type | Description |
|---|---|---|
$groups |
array |
The grouped active filter chip data |
$activeFilterRequest |
array |
The request payload used to detect active filters |
$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.active_filters', function($groups, $activeFilterRequest, $component)
{
// Your code here
return $groups;
}, 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