public function PluginSettingsBase::unsetThirdPartySetting in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 core/lib/Drupal/Core/Field/PluginSettingsBase.php \Drupal\Core\Field\PluginSettingsBase::unsetThirdPartySetting()

Unsets a third-party setting.

Parameters

string $module: The module providing the third-party setting.

string $key: The setting name.

Return value

mixed The value.

Overrides ThirdPartySettingsInterface::unsetThirdPartySetting

File

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

Contains \Drupal\Core\Field\PluginSettingsBase.

Class

PluginSettingsBase

Base class for the Field API plugins.

Namespace

Drupal\Core\Field

Code

public function unsetThirdPartySetting($module, $key) {
  unset($this->thirdPartySettings[$module][$key]);

  // If the third party is no longer storing any information, completely
  // remove the array holding the settings for this module.
  if (empty($this->thirdPartySettings[$module])) {
    unset($this->thirdPartySettings[$module]);
  }
  return $this;
}