function ConfigBase::clear

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Config/ConfigBase.php \Drupal\Core\Config\ConfigBase::clear()
  2. 10 core/lib/Drupal/Core/Config/ConfigBase.php \Drupal\Core\Config\ConfigBase::clear()
  3. 11.x core/lib/Drupal/Core/Config/ConfigBase.php \Drupal\Core\Config\ConfigBase::clear()

Unsets a value in this configuration object.

Parameters

string $key: Name of the key whose value should be unset.

Return value

$this The configuration object.

1 call to ConfigBase::clear()
Config::clear in core/lib/Drupal/Core/Config/Config.php
Unsets a value in this configuration object.
1 method overrides ConfigBase::clear()
Config::clear in core/lib/Drupal/Core/Config/Config.php
Unsets a value in this configuration object.

File

core/lib/Drupal/Core/Config/ConfigBase.php, line 228

Class

ConfigBase
Provides a base class for configuration objects with get/set support.

Namespace

Drupal\Core\Config

Code

public function clear($key) {
    $parts = explode('.', $key);
    if (count($parts) == 1) {
        unset($this->data[$key]);
    }
    else {
        NestedArray::unsetValue($this->data, $parts);
    }
    return $this;
}

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