jreviews:listing_search_widget.has_input
Filters the boolean flag that determines whether the widget should run its live search query. Use this to require or ignore additional inputs for custom widget behavior.
You need to have a working knowledge of Hooks before you get started.
Fires during live search execution before the widget query is run
Parameters
| Name | Type | Description |
|---|---|---|
$hasInput |
bool |
Whether the widget currently has searchable input |
$filterParams |
array |
The normalized live search filter params |
$activeFilters |
array |
Active custom field filters parsed from the request |
$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.has_input', function($hasInput, $filterParams, $activeFilters, $component)
{
// Your code here
return $hasInput;
}, 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