function FormBase::config

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Form/FormBase.php \Drupal\Core\Form\FormBase::config()
  2. 10 core/lib/Drupal/Core/Form/FormBase.php \Drupal\Core\Form\FormBase::config()
  3. 9 core/lib/Drupal/Core/Form/FormBase.php \Drupal\Core\Form\FormBase::config()
  4. 8.9.x core/lib/Drupal/Core/Form/FormBase.php \Drupal\Core\Form\FormBase::config()

Retrieves a configuration object.

This is the main entry point to the configuration API. Calling "$this->config('my_module.admin')" will return a configuration object in which the my_module module can store its administrative settings.

Parameters

string $name: The name of the configuration object to retrieve. The name corresponds to a configuration file. For "\Drupal::config('my_module.admin')", the config object returned will contain the contents of my_module.admin configuration file.

Return value

\Drupal\Core\Config\ImmutableConfig A configuration object.

1 call to FormBase::config()
ConfigSingleImportForm::validateForm in core/modules/config/src/Form/ConfigSingleImportForm.php
Form validation handler.

File

core/lib/Drupal/Core/Form/FormBase.php, line 110

Class

FormBase
Provides a base class for forms.

Namespace

Drupal\Core\Form

Code

protected function config($name) {
  return $this->configFactory()
    ->get($name);
}

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