function views_object::option_definition

cis7 views_object::option_definition()
cle7 views_object::option_definition()
elmsmedia7 views_object::option_definition()
icor7 views_object::option_definition()
meedjum_blog7 views_object::option_definition()
mooc7 views_object::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.

See also




4 calls to views_object::option_definition()
views_object::export_options in sites/all/modules/ulmus/views/includes/
views_object::set_default_options in sites/all/modules/ulmus/views/includes/
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 sites/all/modules/ulmus/views/includes/
Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatables in sites/all/modules/ulmus/views/includes/
Unpacks each handler to store translatable texts.
2 methods override views_object::option_definition()
date_views_plugin_pager::option_definition in sites/all/modules/ulmus/date/date_views/includes/
Tell Views what options this plugin can store.
views_handler::option_definition in sites/all/modules/ulmus/views/includes/
Information about options for all kinds of purposes will be held here. @code 'option_name' => array(


sites/all/modules/ulmus/views/includes/, line 55
Provides the basic object definitions used by plugins and handlers.


Basic definition for many views objects.


function option_definition() {
  return array();