function views_object::option_definition

Same name in other branches
  1. 7.x-3.x includes/base.inc \views_object::option_definition()

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


'option_name' => array(
 - 'default' => default value,
 - 'translatable' => TRUE/FALSE (wrap in t() on export if true),
 - 'contains' => array of items this contains, with its own defaults, etc.
     If contains is set, the default will be ignored and assumed to
     be array()

 ),

Each option may have any of the following functions:

  • export_option_OPTIONNAME -- Special export handling if necessary.
  • translate_option_OPTIONNAME -- Special handling for translating data within the option, if necessary.
13 calls to views_object::option_definition()
views_handler::option_definition in includes/handlers.inc
Information about options for all kinds of purposes will be held here.
views_object::export_options in includes/base.inc
views_object::set_default_options in includes/base.inc
Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::unpack_options in includes/base.inc
Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatables in includes/base.inc
Unpacks each handler to store translatable texts.

... See full list

13 methods override views_object::option_definition()
views_handler::option_definition in includes/handlers.inc
Information about options for all kinds of purposes will be held here.
views_plugin_access::option_definition in plugins/views_plugin_access.inc
Retrieve the options when this is a new access control plugin
views_plugin_argument_default::option_definition in plugins/views_plugin_argument_default.inc
Retrieve the options when this is a new access control plugin
views_plugin_argument_validate::option_definition in plugins/views_plugin_argument_validate.inc
Retrieve the options when this is a new access control plugin
views_plugin_cache_time::option_definition in plugins/views_plugin_cache_time.inc
Information about options for all kinds of purposes will be held here.

... See full list

File

includes/base.inc, line 48

Class

views_object
Basic definition for many views objects

Code

function option_definition() {
    return array();
}