1 config.api.php hook_config_data_validate(Config $config, array $config_info)

Validate a configuration before saving it.

If any problems are encountered with the configuration, implementations of this hook should throw a ConfigValidateException to prevent the configuration from saving.

Parameters

Config $config: The configuration object for the settings about to be saved.

array $config_info: The information about the configuration being imported, as provided by hook_config_info().

Throws

ConfigValidateException

Related topics

Hooks Allow modules to interact with the Backdrop core. Hooks Allow modules to interact with the Backdrop core.

File

core/modules/config/config.api.php, line 64
Documentation for hooks provided by Config module.

Code

function hook_config_data_validate(Config $config, array $config_info) {
  if ($config->getName() === 'my_module.settings') {
    if (!module_exists($config->get('module'))) {
      throw new ConfigValidateException(t('The configuration "@file" could not be imported because the module "@module" is not enabled.', array('@file' => $config->getName(), '@module' => $config->get('module'))));
    }
  }
}