better_exposed_filters.api.php in Better Exposed Filters 8.4

Hooks provided by the Better Exposed Filters module.

File

better_exposed_filters.api.php

<?php

/**
 * @file
 * Hooks provided by the Better Exposed Filters module.
 */

/**
 * Alters BEF options before the exposed form widgets are built.
 *
 * @param array $options
 *   The BEF options array.
 * @param \Drupal\views\ViewExecutable $view
 *   The view to which the settings apply.
 * @param \Drupal\views\Plugin\views\display\DisplayPluginBase $displayHandler
 *   The display handler to which the settings apply.
 */
function hook_better_exposed_filters_options_alter(array &$options, ViewExecutable $view, DisplayPluginBase $displayHandler) {

  // Set the min/max value of a slider.
  $settings['field_price_value']['slider_options']['bef_slider_min'] = 500;
  $settings['field_price_value']['slider_options']['bef_slider_max'] = 5000;
}

/**
 * Modify the array of BEF display options for an exposed filter.
 *
 * @param array $widgets
 *   The set of BEF widgets available to this filter.
 * @param \Drupal\views\Plugin\views\HandlerBase $filter
 *   The exposed views filter plugin.
 */
function hook_better_exposed_filters_filter_widgets_alter(array &$widgets, HandlerBase $filter) {
  if ($filter instanceof CustomViewsFilterFoo) {
    $widgets['bef_links'] = t('Links');
  }
}

Functions

Name	Description
hook_better_exposed_filters_filter_widgets_alter	Modify the array of BEF display options for an exposed filter.
hook_better_exposed_filters_options_alter	Alters BEF options before the exposed form widgets are built.