function views_handler_field_custom::option_definition
3.x views_handler_field_custom.inc | views_handler_field_custom::option_definition() |
2.x views_handler_field_custom.inc | views_handler_field_custom::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_always()
views_object::unpack_translatable()
File
- handlers/
views_handler_field_custom.inc, line 18 - Definition of views_handler_field_custom.
Class
- views_handler_field_custom
- A handler to provide a field that is completely custom by the administrator.
Code
function option_definition() {
$options = parent::option_definition();
// Override the alter text option to always alter the text.
$options['alter']['contains']['alter_text'] = array('default' => TRUE, 'bool' => TRUE);
$options['hide_alter_empty'] = array('default' => FALSE, 'bool' => TRUE);
return $options;
}