function locale_config_batch_update_components

Same name and namespace in other branches
  1. 10 core/modules/locale/locale.bulk.inc \locale_config_batch_update_components()
  2. 11.x core/modules/locale/locale.bulk.inc \locale_config_batch_update_components()
  3. 9 core/modules/locale/locale.bulk.inc \locale_config_batch_update_components()
  4. 8.9.x core/modules/locale/locale.bulk.inc \locale_config_batch_update_components()

Builds a locale batch to refresh configuration.

Parameters

array $options: An array with options that can have the following elements:

  • 'finish_feedback': (optional) Whether or not to give feedback to the user when the batch is finished. Defaults to TRUE.

array $langcodes: (optional) Array of language codes. Defaults to all translatable languages.

array $components: (optional) Array of component lists indexed by type. If not present or it is an empty array, it will update all components.

bool $update_default_config_langcodes: Determines whether default configuration langcodes should be updated. This Should only happen during site and extension install.

Return value

array The batch definition.

Deprecated

in drupal:11.4.0 and is removed from drupal:13.0.0. Use \Drupal::service(LocaleConfigBatch::class)->buildBatch() instead.

See also

https://www.drupal.org/node/3589759

File

core/modules/locale/locale.bulk.inc, line 277

Code

function locale_config_batch_update_components(array $options, array $langcodes = [], array $components = [], bool $update_default_config_langcodes = FALSE) {
  @trigger_error(__FUNCTION__ . '() is deprecated in drupal:11.4.0 and is removed from drupal:13.0.0. Use \\Drupal::service(LocaleConfigBatch::class)->buildBatch(). See https://www.drupal.org/node/3589759', E_USER_DEPRECATED);
  return \Drupal::service(LocaleConfigBatch::class)->buildBatch($options, $langcodes, $components, $update_default_config_langcodes);
}

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