jreviews:listing_search_widget.view_all_url_params
Filters the final URL param array used to generate the widget's "view all results" link. Use this to add custom context, rewrite params, or suppress values before the search URL is built.
You need to have a working knowledge of Hooks before you get started.
Fires after the widget view-all params are assembled and before the final URL is generated
Parameters
| Name | Type | Description |
|---|---|---|
$urlParams |
array |
The URL params that will be passed to the search URL builder |
$request |
\FWD\Illuminate\Http\Request |
The current request |
$widgetParams |
mixed |
The widget params object backing the search widget |
$component |
self |
The ListingSearchWidget 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:listing_search_widget.view_all_url_params', function($urlParams, $request, $widgetParams, $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/Widget/ListingSearchWidget.php