You are here

Home » API reference » Drupal 9 » PluginSettingsBase.php » PluginSettingsBase

public function PluginSettingsBase::getSetting in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Field/PluginSettingsBase.php \Drupal\Core\Field\PluginSettingsBase::getSetting()

Returns the value of a setting, or its default value if absent.

Parameters

string $key: The setting name.

Return value

mixed The setting value.

Overrides PluginSettingsInterface::getSetting

159 calls to PluginSettingsBase::getSetting()
AggregatorTitleFormatter::settingsForm in core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorTitleFormatter.php
Returns a form to configure settings for the formatter.
AggregatorTitleFormatter::viewElements in core/modules/aggregator/src/Plugin/Field/FieldFormatter/AggregatorTitleFormatter.php
Builds a renderable array for a field value.
BaseFieldFileFormatterBase::settingsForm in core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php
Returns a form to configure settings for the formatter.
BaseFieldFileFormatterBase::viewElements in core/modules/file/src/Plugin/Field/FieldFormatter/BaseFieldFileFormatterBase.php
Builds a renderable array for a field value.
BooleanCheckboxWidget::formElement in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php
Returns the form for a single field widget.

... See full list

File

core/lib/Drupal/Core/Field/PluginSettingsBase.php, line 59

Class

PluginSettingsBase
Base class for the Field API plugins.

Namespace

Drupal\Core\Field

Code

public function getSetting($key) {

  // Merge defaults if we have no value for the key.
  if (!$this->defaultSettingsMerged && !array_key_exists($key, $this->settings)) {
    $this
      ->mergeDefaults();
  }
  return isset($this->settings[$key]) ? $this->settings[$key] : NULL;
}