function views_handler::option_definition
3.x handlers.inc | views_handler::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_object::option_definition
See also
views_object::export_option_always()
views_object::unpack_translatable()
6 calls to views_handler::option_definition()
- views_handler_area::option_definition in handlers/
views_handler_area.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_argument::option_definition in handlers/
views_handler_argument.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_field::option_definition in handlers/
views_handler_field.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_filter::option_definition in handlers/
views_handler_filter.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_relationship::option_definition in handlers/
views_handler_relationship.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
6 methods override views_handler::option_definition()
- views_handler_area::option_definition in handlers/
views_handler_area.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_argument::option_definition in handlers/
views_handler_argument.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_field::option_definition in handlers/
views_handler_field.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_filter::option_definition in handlers/
views_handler_filter.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
- views_handler_relationship::option_definition in handlers/
views_handler_relationship.inc - Information about options for all kinds of purposes will be held here. @code 'option_name' => array(
File
- includes/
handlers.inc, line 255 - Defines the various handler objects to help build and display views.
Class
- views_handler
- Base handler, from which all the other handlers are derived. It creates a common interface to create consistency amongst handlers and data.
Code
function option_definition() {
$options = parent::option_definition();
$options['id'] = array('default' => '');
$options['table'] = array('default' => '');
$options['field'] = array('default' => '');
$options['relationship'] = array('default' => 'none');
$options['group_type'] = array('default' => 'group');
$options['ui_name'] = array('default' => '');
return $options;
}