Issue #3080106 by kiamlaluno: Drupal::config() incorrectly implies you can edit the config it returns

(cherry picked from commit ba62e4a9ca1a8b76416bb4afc72f0bd73a76de4b)
merge-requests/64/head
Alex Pott 2019-11-28 13:23:25 +00:00
parent c429e783d8
commit d71d598f69
No known key found for this signature in database
GPG Key ID: 31905460D4A69276
1 changed files with 6 additions and 4 deletions

View File

@ -366,12 +366,14 @@ class Drupal {
*
* This is the main entry point to the configuration API. Calling
* @code \Drupal::config('book.admin') @endcode will return a configuration
* object in which the book module can store its administrative settings.
* object the Book module can use to read its administrative settings.
*
* @param string $name
* The name of the configuration object to retrieve. The name corresponds to
* a configuration file. For @code \Drupal::config('book.admin') @endcode, the config
* object returned will contain the contents of book.admin configuration file.
* The name of the configuration object to retrieve, which typically
* corresponds to a configuration file. For
* @code \Drupal::config('book.admin') @endcode, the configuration
* object returned will contain the content of the book.admin
* configuration file.
*
* @return \Drupal\Core\Config\ImmutableConfig
* An immutable configuration object.