function HandlerBase::defineOptions

Same name and namespace in other branches

8.9.x core/modules/views/src/Plugin/views/HandlerBase.php \Drupal\views\Plugin\views\HandlerBase::defineOptions()
10 core/modules/views/src/Plugin/views/HandlerBase.php \Drupal\views\Plugin\views\HandlerBase::defineOptions()
11.x core/modules/views/src/Plugin/views/HandlerBase.php \Drupal\views\Plugin\views\HandlerBase::defineOptions()

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


'option_name' => array(
 - 'default' => default value,
 - '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().
 ),

Return value

array Returns the options of this handler/plugin.

Overrides PluginBase::defineOptions

6 calls to HandlerBase::defineOptions()

AreaPluginBase::defineOptions in core/modules/views/src/Plugin/views/area/AreaPluginBase.php: Information about options for all kinds of purposes will be held here.
ArgumentPluginBase::defineOptions in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php: Information about options for all kinds of purposes will be held here.
FieldPluginBase::defineOptions in core/modules/views/src/Plugin/views/field/FieldPluginBase.php: Information about options for all kinds of purposes will be held here.
FilterPluginBase::defineOptions in core/modules/views/src/Plugin/views/filter/FilterPluginBase.php: Information about options for all kinds of purposes will be held here.
RelationshipPluginBase::defineOptions in core/modules/views/src/Plugin/views/relationship/RelationshipPluginBase.php: Information about options for all kinds of purposes will be held here.

... See full list

6 methods override HandlerBase::defineOptions()

AreaPluginBase::defineOptions in core/modules/views/src/Plugin/views/area/AreaPluginBase.php: Information about options for all kinds of purposes will be held here.
ArgumentPluginBase::defineOptions in core/modules/views/src/Plugin/views/argument/ArgumentPluginBase.php: Information about options for all kinds of purposes will be held here.
FieldPluginBase::defineOptions in core/modules/views/src/Plugin/views/field/FieldPluginBase.php: Information about options for all kinds of purposes will be held here.
FilterPluginBase::defineOptions in core/modules/views/src/Plugin/views/filter/FilterPluginBase.php: Information about options for all kinds of purposes will be held here.
RelationshipPluginBase::defineOptions in core/modules/views/src/Plugin/views/relationship/RelationshipPluginBase.php: Information about options for all kinds of purposes will be held here.

... See full list

File

core/modules/views/src/Plugin/views/HandlerBase.php, line 140

Class

HandlerBase: Base class for Views handler plugins.

Namespace

Drupal\views\Plugin\views

Code

protected function defineOptions() {
  $options = parent::defineOptions();
  $options['id'] = [
    'default' => '',
  ];
  $options['table'] = [
    'default' => '',
  ];
  $options['field'] = [
    'default' => '',
  ];
  $options['relationship'] = [
    'default' => 'none',
  ];
  $options['group_type'] = [
    'default' => 'group',
  ];
  $options['admin_label'] = [
    'default' => '',
  ];
  return $options;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.

Breadcrumb