function views_object::option_definition

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


'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

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

10 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::altered_option_definition in includes/base.inc
Collect this handler's option definition and alter them, ready for use.
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.
views_plugin_exposed_form::option_definition in plugins/views_plugin_exposed_form.inc
Information about options for all kinds of purposes will be held here.
views_plugin_pager_full::option_definition in plugins/views_plugin_pager_full.inc
Information about options for all kinds of purposes will be held here.

... 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 59

Class

views_object
Provides the basic object definitions used by plugins and handlers.

Code

public function option_definition() {
    return array();
}