function hook_block_alter

Same name in other branches
  1. 9 core/modules/block/block.api.php \hook_block_alter()
  2. 10 core/modules/block/block.api.php \hook_block_alter()

Allow modules to alter the block plugin definitions.

Parameters

array[] $definitions: The array of block definitions, keyed by plugin ID.

Related topics

4 functions implement hook_block_alter()

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

block_test_block_alter in core/modules/block/tests/modules/block_test/block_test.module
Implements hook_block_alter().
olivero_theme_suggestions_block_alter in core/themes/olivero/olivero.theme
Implements hook_theme_suggestions_HOOK_alter() for block().
statistics_block_alter in core/modules/statistics/statistics.module
Implements hook_block_alter().
umami_theme_suggestions_block_alter in core/profiles/demo_umami/themes/umami/umami.theme
Implements hook_theme_suggestions_HOOK_alter() for block templates.

File

core/modules/block/block.api.php, line 255

Code

function hook_block_alter(&$definitions) {
    foreach ($definitions as $id => $definition) {
        if (str_starts_with($id, 'system_menu_block:')) {
            // Replace $definition properties: id, deriver, class, provider to ones
            // provided by this custom module.
        }
    }
}

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