You are here

Home » API reference » Entity API 7 » entity_views_handler_field_entity.inc » entity_views_handler_field_entity

public function entity_views_handler_field_entity::option_definition in Entity 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_handler_field::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/handlers/entity_views_handler_field_entity.inc, line 77
Contains the entity_views_handler_field_entity class.

Class

entity_views_handler_field_entity
A handler to provide proper displays for entities retrieved via data selection.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options += EntityFieldHandlerHelper::option_definition($this);
  $options['display'] = array(
    'default' => 'label',
  );
  $options['link_to_entity']['default'] = TRUE;
  $options['view_mode'] = array(
    'default' => 'default',
  );
  $options['bypass_access'] = array(
    'default' => FALSE,
  );
  return $options;
}