1. 1.16.x includes/config.inc
  2. 1.17.x includes/config.inc
  3. 1.18.x includes/config.inc

This is the API for configuration storage.

File

includes/config.inc

Functions

Namesort descending Description
config Retrieves a configuration object.
config_clear A shortcut function to delete a single value from a config file.
config_get A shortcut function to load and retrieve a single value from a config file.
config_get_config_directory Returns the path of a configuration directory.
config_get_config_storage Get the storage object for the specified configuration type
config_get_config_storage_handlers Collect a list of classes for each "type" (e.g., db or file).
config_get_names_with_prefix Retrieves all configurations starting with a particular prefix.
config_get_translated A shortcut function to load and retrieve a single translated value from a config file.
config_install_default_config Moves the default config supplied by a module to the live config directory.
config_is_overridden A shortcut function to check if a value is overridden within a config file.
config_load_multiple Loads configuration objects by name.
config_set A shortcut function to set and save a single value in a config file.
config_set_multiple A shortcut function to set and save multiple values in a config file.
config_uninstall_config Uninstall all the configuration provided by a module.

Classes

Namesort descending Description
Config Defines the default configuration object.
ConfigException A base exception thrown in any configuration system operations.
ConfigNameException Exception thrown when a config object name is invalid.
ConfigStorageException Exception thrown by classes implementing ConfigStorageInterface.
ConfigStorageReadException Exception thrown when attempting to read a config file fails.
ConfigValidateException Exception thrown when a config object has a validation error before saving.

Interfaces

Namesort descending Description
ConfigStorageInterface Defines an interface for configuration storage controllers.