On this page
block.tpl.php
Last updated on
7 December 2017
Drupal 7 will no longer be supported after January 5, 2025. Learn more and find resources for Drupal 7 sites
The block.tpl.php file returns the HTML for a block.
Available variables:
- $title
- Block title.
- $content
- Block content.
- $block->module
- Module that generated the block.
- $block->delta
- An ID for the block, unique within each module.
- $block->region
- The block region embedding the current block.
- $classes
- String of classes that can be used to style contextually through CSS. It can be manipulated through the variable $classes_array from preprocess functions. The default values can be one or more of the following:
- block: The current template type, i.e., "theming hook".
- block-[module]: The module generating the block. For example, the user module is responsible for handling the default user navigation block. In that case the class would be "block-user".
- first: The first block in the region.
- last: The last block in the region.
- odd: An odd-numbered block in the region's list of blocks.
- even: An even-numbered block in the region's list of blocks.
- $title_prefix (array)
- An array containing additional output populated by modules, intended to be displayed in front of the main title tag that appears in the template.
- $title_suffix (array)
- An array containing additional output populated by modules, intended to be displayed after the main title tag that appears in the template.
Helper variables:
- $classes_array
- Array of html class attribute values. It is flattened into a string within the variable $classes.
- $block_zebra
- Outputs 'odd' and 'even' dependent on each block region.
- $zebra
- Same output as $block_zebra but independent of any block region.
- $block_id
- Counter dependent on each block region.
- $id
- Same output as $block_id but independent of any block region.
- $is_front
- Flags true when presented in the front page.
- $logged_in
- Flags true when the current user is a logged-in member.
- $is_admin
- Flags true when the current user is an administrator.
- $block_html_id
- A valid HTML ID and guaranteed unique.
See also
template_preprocess()
template_preprocess_block()
zen_preprocess_block() in Zen's template.php
template_process()
zen_process_block() in Zen's template.php
Help improve this page
Page status: No known problems
You can:
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion