hook_block_view_alter

Versions

7

hook_block_view_alter(&$data, $block)

Perform alterations to the content of a block.

This hook allows you to modify any data returned by hook_block_view().

Note that instead of hook_block_view_alter(), which is called for all blocks, you can also use hook_block_view_MODULE_DELTA_alter() to alter a specific block.

See also

hook_block_view_alter()

@see hook_block_view()

Parameters

$data An array of data, as returned from the hook_block_view() implementation of the module that defined the block:

• subject: The localized title of the block.
• content: Either a string or a renderable array representing the content of the block. You should check that the content is an array before trying to modify parts of the renderable structure.

$block The block object, as loaded from the database, having the main properties:

• module: The name of the module that defined the block.
• delta: The identifier for the block within that module, as defined within hook_block_info().

Related topics

Hooks

Allow modules to interact with the Drupal core.

Code

modules/block/block.api.php, line 178

<?php
function hook_block_view_alter(&$data, $block) {
  // Remove the contextual links on all blocks that provide them.
  if (is_array($data['content']) && isset($data['content']['#contextual_links'])) {
    unset($data['content']['#contextual_links']);
  }
  // Add a theme wrapper function defined by the current module to all blocks
  // provided by the "somemodule" module.
  if (is_array($data['content']) && $block->module == 'somemodule') {
    $data['content']['#theme_wrappers'][] = 'mymodule_special_block';
  }
}
?>

Login or register to post comments