function hook_js_settings_build

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/theme.api.php \hook_js_settings_build()
  2. 10 core/lib/Drupal/Core/Render/theme.api.php \hook_js_settings_build()
  3. 11.x core/lib/Drupal/Core/Render/theme.api.php \hook_js_settings_build()

Modify the JavaScript settings (drupalSettings).

Parameters

array &$settings: An array of all JavaScript settings (drupalSettings) being presented on the page.

\Drupal\Core\Asset\AttachedAssetsInterface $assets: The assets attached to the current response.

See also

\Drupal\Core\Asset\AssetResolver

The results of this hook are cached, however modules may use hook_js_settings_alter() to dynamically alter settings.

Related topics

Hooks
Define functions that alter the behavior of Drupal core.
1 function implements hook_js_settings_build()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

system_js_settings_build in core/modules/system/system.module
Implements hook_js_settings_build().

File

core/lib/Drupal/Core/Render/theme.api.php, line 937

Code

function hook_js_settings_build(array &$settings, \Drupal\Core\Asset\AttachedAssetsInterface $assets) {
    // Manipulate settings.
    if (isset($settings['dialog'])) {
        $settings['dialog']['autoResize'] = FALSE;
    }
}

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