function PluginBase::defineOptions

Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/PluginBase.php \Drupal\views\Plugin\views\PluginBase::defineOptions()
  2. 8.9.x core/modules/views/src/Plugin/views/PluginBase.php \Drupal\views\Plugin\views\PluginBase::defineOptions()
  3. 11.x core/modules/views/src/Plugin/views/PluginBase.php \Drupal\views\Plugin\views\PluginBase::defineOptions()

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


'option_name' => [
 - '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 [].
 ],

Return value

array Returns the options of this handler/plugin.

3 calls to PluginBase::defineOptions()
PluginBase::filterByDefinedOptions in core/modules/views/src/Plugin/views/PluginBase.php
Filter out stored options depending on the defined options.
PluginBase::init in core/modules/views/src/Plugin/views/PluginBase.php
Initialize the plugin.
PluginBase::unpackOptions in core/modules/views/src/Plugin/views/PluginBase.php
Unpacks options over our existing defaults.
18 methods override PluginBase::defineOptions()
ArgumentDefaultPluginBase::defineOptions in core/modules/views/src/Plugin/views/argument_default/ArgumentDefaultPluginBase.php
Retrieve the options when this is a new access control plugin.
ArgumentValidatorPluginBase::defineOptions in core/modules/views/src/Plugin/views/argument_validator/ArgumentValidatorPluginBase.php
Retrieves the options when this is a new access control plugin.
DisplayExtenderTest::defineOptions in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest.php
Information about options for all kinds of purposes will be held here.
DisplayPluginBase::defineOptions in core/modules/views/src/Plugin/views/display/DisplayPluginBase.php
Information about options for all kinds of purposes will be held here.
ExposedFormPluginBase::defineOptions in core/modules/views/src/Plugin/views/exposed_form/ExposedFormPluginBase.php
Information about options for all kinds of purposes will be held here.

... See full list

File

core/modules/views/src/Plugin/views/PluginBase.php, line 163

Class

PluginBase
Base class for any views plugin types.

Namespace

Drupal\views\Plugin\views

Code

protected function defineOptions() {
    return [];
}

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