jreviews:search_live_results.has_input
Filters the boolean flag that determines whether live search should execute. Use this to require additional inputs, ignore certain params, or force results to load for custom scenarios.
You need to have a working knowledge of Hooks before you get started.
Fires before the live search query is executed
Parameters
| Name | Type | Description |
|---|---|---|
$hasInput |
bool |
Whether the request currently has searchable input |
$filterParams |
array |
The normalized live search filter params |
$activeFilters |
array |
Active custom field filters parsed from the request |
$controller |
self |
The SearchLiveResultsController 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:search_live_results.has_input', function($hasInput, $filterParams, $activeFilters, $controller)
{
// 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/Controllers/SearchLiveResultsController.php