You are here

function hook_current_search_items in Facet API 6.3

Same name and namespace in other branches
  1. 7.2 contrib/current_search/current_search.api.php \hook_current_search_items()
  2. 7 contrib/current_search/current_search.api.php \hook_current_search_items()

Define all current search item provided by the module.

Current search items are elements that are added to the current search block such as a list of active facet items, custom text, etc.

Return value

array An associative array keyed by unique name of the current search item. Each item item 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

CurrentSearchItem

1 function implements hook_current_search_items()

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

current_search_current_search_items in contrib/current_search/current_search.module
Implements hook_current_search_items().

File

contrib/current_search/current_search.api.php, line 27
Hooks provided by the Current Search Blocks module.

Code

function hook_current_search_items() {
  return array(
    'text' => array(
      'handler' => array(
        'label' => t('Custom text'),
        'class' => 'CurrentSearchItemText',
      ),
    ),
  );
}