Custom blocks with attached drupalSettings not having settings passed to frontend

<?php namespace Drupal\my_custom_module\Plugin\Block; use Drupal\Core\Block\BlockBase; use Drupal\Core\Plugin\ContainerFactoryPluginInterface; use Drupal\my_custom_module\MyCustomTools; /** * Provides a custom block. * * @Block( * id = "my_custom_module_favorite_block", * admin_label = @Translation("My Favorite Custom Block"), * category = @Translation("Custom Blocks"), * ) */ class MyFavoriteCustomBlock extends BlockBase { /** * {@inheritDoc} */ public function build() { $favorite_settings = MyCustomTools::getFavoriteSettings(); $build = [ '#theme' => 'my_custom_block', '#favorite_settings' => $favorite_settings, '#cache' => ['contexts' => ['url.path']], ]; // This isn't working. I have to use hook_page_attachments() to add the settings for the frontend. $build['#attached']['drupalSettings']['my_custom_module']['mycustommodulefavoriteblock'] = $favorite_settings; return $build; } }

!((document, Drupal) => { 'use strict'; /** * JS for Favorite Custom Block */ Drupal.behaviors.favoriteCustomBlock = { attach: function(context, settings) { window.addEventListener('DOMContentLoaded', () => { console.log('settings); }); } }; })(document, Drupal);

Comments & Activities

Issue created by @debra-v
Comment 2 months ago →
🇺🇸United States debra-v
Comment 2 months ago →
cilefen
The JavaScript API documentation → says to use the hook—so that is more the official way than a workaround.

You said this no longer works. Which Drupal release changed the behavior?
Comment 2 months ago →
🇮🇳India kulpratap2002
Right now, when you add #attached['drupalSettings'] in a block’s build() method, those settings don’t always make it into the global drupalSettings unless the block also attaches a library. This feels like a change in behavior compared to earlier versions.

It would be more intuitive if settings from a block were always passed through, even without a library. That way we can attach simple data for frontend scripts without having to create a library just for it.

As a temporary workaround, you can either attach a library in the block or move the settings into hook_page_attachments().
Comment 2 months ago →
cilefen
In which earlier Drupal versions did #attached work? It is important to have this information to understand why the behavior changed.
Comment 2 months ago →
🇺🇸United States debra-v
I just had an AHA moment. The earlier version where it worked was Drupal 10.2+. However, we made a significant change after that version to move to a new theme using SDC components. There is a library that is loaded with that block, but that library is loaded via SDC. **insert suspenseful sound effect**

Comment 2 months ago →

🇺🇸United States debra-v

But wait... it appears libraries aren't being added to blocks either.

# My favorite library:  my_custom_module.libraries.yml
styles:
  css:
    component:
      css/styles.css: {}

...
$build = [
      '#theme' => 'my_custom_block',
      '#favorite_settings' => $favorite_settings,
      '#cache' => ['contexts' => ['url.path']],
      '#attached' => [
        'library' => [
          'my_custom_module/styles',
        ],
      ],
    ];
return $build;
...

The styles.css file doesn't load.

Custom blocks with attached drupalSettings not having settings passed to frontend

Problem/Motivation

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Comments & Activities