jreviews:listings_list.sync_url_params
Filters the final URL param array pushed into browser history for listings lists. Use this to add custom state, remove transient params, or rewrite how list state is reflected in the URL.
You need to have a working knowledge of Hooks before you get started.
Fires after list state is normalized and before the synced URL is generated/pushed
Parameters
| Name | Type | Description |
|---|---|---|
$urlParams |
array |
The computed URL params about to be synchronized |
$currentQuery |
array |
The current browser query params before synchronization |
$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.sync_url_params', function($urlParams, $currentQuery, $request, $component)
{
// Your code here
return $urlParams;
}, 20, 4);
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