You are here

public function views_plugin_display_page::option_definition in Views (for Drupal 7) 7.3

Same name and namespace in other branches
  1. 6.3 plugins/views_plugin_display_page.inc \views_plugin_display_page::option_definition()
  2. 6.2 plugins/views_plugin_display_page.inc \views_plugin_display_page::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_plugin_display::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

1 call to views_plugin_display_page::option_definition()
views_plugin_display_feed::option_definition in plugins/views_plugin_display_feed.inc
Information about options for all kinds of purposes will be held here.
1 method overrides views_plugin_display_page::option_definition()
views_plugin_display_feed::option_definition in plugins/views_plugin_display_feed.inc
Information about options for all kinds of purposes will be held here.

File

plugins/views_plugin_display_page.inc, line 32
Definition of views_plugin_display_page.

Class

views_plugin_display_page
The plugin that handles a full page.

Code

public function option_definition() {
  $options = parent::option_definition();
  $options['path'] = array(
    'default' => '',
  );
  $options['menu'] = array(
    'contains' => array(
      'type' => array(
        'default' => 'none',
      ),
      // Do not translate menu and title as menu system will.
      'title' => array(
        'default' => '',
        'translatable' => FALSE,
      ),
      'description' => array(
        'default' => '',
        'translatable' => FALSE,
      ),
      'weight' => array(
        'default' => 0,
      ),
      'name' => array(
        'default' => variable_get('menu_default_node_menu', 'navigation'),
      ),
      'context' => array(
        'default' => '',
      ),
      'context_only_inline' => array(
        'default' => FALSE,
      ),
    ),
  );
  $options['tab_options'] = array(
    'contains' => array(
      'type' => array(
        'default' => 'none',
      ),
      // Do not translate menu and title as menu system will.
      'title' => array(
        'default' => '',
        'translatable' => FALSE,
      ),
      'description' => array(
        'default' => '',
        'translatable' => FALSE,
      ),
      'weight' => array(
        'default' => 0,
      ),
      'name' => array(
        'default' => 'navigation',
      ),
    ),
  );
  return $options;
}