You are here

function hook_facetapi_filters in Facet API 6.3

Same name and namespace in other branches
  1. 7.2 facetapi.api.php \hook_facetapi_filters()
  2. 7 facetapi.api.php \hook_facetapi_filters()

Define all filter plugins provided by the module.

Filter plugins provide last minute modifications to the facet's render array prior to being acted on by the widget plugin. Filters are also an alter mechanism for the facet that developers can use to make any customizations prior to the widget being rendered.

Return value

array An associative array keyed by unique name of the filter. Each filter is an associative array keyed by "handler" containing:

  • label: The human readable name of the plugin displayed in the admin UI.
  • class: The name of the plugin class.

See also

FacetapiFilter

1 function implements hook_facetapi_filters()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

facetapi_facetapi_filters in ./facetapi.facetapi.inc
Implements hook_facetapi_filters().

File

./facetapi.api.php, line 369
Hooks provided by the Facet API module.

Code

function hook_facetapi_filters() {
  return array(
    'active_items' => array(
      'handler' => array(
        'label' => t('Do not display active items'),
        'class' => 'FacetapiFilterActiveItems',
      ),
    ),
  );
}