function ConfigBase::get

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

Gets data from this configuration object.

Parameters

string $key: A string that maps to a key within the configuration data. For instance in the following configuration array:

[
    'foo' => [
        'bar' => 'baz',
    ],
];

A key of 'foo.bar' would return the string 'baz'. However, a key of 'foo' would return ['bar' => 'baz']. If no key is specified, then the entire data array is returned.

Return value

mixed The data that was requested.

1 method overrides ConfigBase::get()
Config::get in core/lib/Drupal/Core/Config/Config.php
Gets data from this configuration object.

File

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

Class

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

Namespace

Drupal\Core\Config

Code

public function get($key = '') {
    if (empty($key)) {
        return $this->data;
    }
    else {
        $parts = explode('.', $key);
        if (count($parts) == 1) {
            return $this->data[$key] ?? NULL;
        }
        else {
            $value = NestedArray::getValue($this->data, $parts, $key_exists);
            return $key_exists ? $value : NULL;
        }
    }
}

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