You are here

Home » API reference » Search API 7 » display_facet_block.inc » SearchApiViewsFacetsBlockDisplay

public function SearchApiViewsFacetsBlockDisplay::option_definition in Search API 7

Information about options for all kinds of purposes will be held here.

@code 'option_name' => array(

  • 'default' => default value,
  • 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
  • 'contains' => (optional) array of items this contains, with its own defaults, etc. If contains is set, the default will be ignored and assumed to be array().
  • 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will change the export format to TRUE/FALSE instead of 1/0.
  • 'export' => (optional) FALSE or a callback for special export handling if necessary.
  • 'unpack_translatable' => (optional) callback for special handling for translating data within the option, if necessary.

),

Return value

array Returns the options of this handler/plugin.

Overrides views_plugin_display_block::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

contrib/search_api_views/includes/display_facet_block.inc, line 19
Display plugin for displaying the search facets in a block.

Class

SearchApiViewsFacetsBlockDisplay
Plugin class for displaying search facets in a block.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['linked_path'] = array(
    'default' => '',
  );
  $options['facet_field'] = '';
  $options['hide_block'] = FALSE;
  return $options;
}