JReviews logo Docs
Menu
Version

jreviews:listings_list.has_active_filter_params

Filters the fallback boolean used to decide whether the listings list should be treated as actively filtered. Use this to mark custom params as active filters or suppress built-in detection for specialized list states.

Filter
Listings
Since 6.0.1

You need to have a working knowledge of Hooks before you get started.

Fires when resolving whether filter state should affect URL sync and page behavior

Parameters

Name Type Description
$hasActiveFilters bool The current fallback result, false when no built-in filters were detected
$params array The computed URL/filter params under evaluation
$activeJrFields array The active custom field names detected from the request
$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.has_active_filter_params', function($hasActiveFilters, $params, $activeJrFields, $component)
{
    // Your code here
    
    return $hasActiveFilters;
}, 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.

Development & Support
Customizations are not included with support. We provide this information to make it easier for developers to extend the functionality. From time to time we may have some availability for custom work. Get in touch to see if there's an opportunity to work together.

Source Files

  • app/Http/Site/Yoyo/Listing/ListingsList.php