function colorbox_handler_field_colorbox::option_definition in Colorbox 7

Same name and namespace in other branches

1. 6 views/colorbox_handler_field_colorbox.inc \colorbox_handler_field_colorbox::option_definition()
2. 7.2 views/colorbox_handler_field_colorbox.inc \colorbox_handler_field_colorbox::option_definition()

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/colorbox_handler_field_colorbox.inc, line 18

Views handlers for Colorbox module.

Class

colorbox_handler_field_colorbox

A handler to provide a field that is completely custom by the administrator.

Code

function option_definition() {
  $options = parent::option_definition();
  $options['trigger_field'] = array(
    'default' => '',
  );
  $options['popup'] = array(
    'default' => '',
  );
  $options['caption'] = array(
    'default' => '',
  );
  $options['gid'] = array(
    'default' => TRUE,
  );
  $options['custom_gid'] = array(
    'default' => '',
  );
  $options['width'] = array(
    'default' => '600px',
  );
  $options['height'] = array(
    'default' => '400px',
  );
  return $options;
}