block.tpl.php

You are here

  1. 7 modules/block/block.tpl.php
  2. 4.7 themes/pushbutton/block.tpl.php
  3. 4.7 themes/bluemarine/block.tpl.php
  4. 4.7 themes/engines/phptemplate/block.tpl.php
  5. 5 themes/bluemarine/block.tpl.php
  6. 5 themes/engines/phptemplate/block.tpl.php
  7. 5 themes/garland/block.tpl.php
  8. 5 themes/pushbutton/block.tpl.php
  9. 6 modules/system/block.tpl.php
  10. 6 themes/pushbutton/block.tpl.php
  11. 6 themes/garland/block.tpl.php
  12. 6 themes/bluemarine/block.tpl.php

Default theme implementation to display a block.

Available variables:

  • $block->subject: 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'.
  • $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()

template_process()

4 theme calls to block.tpl.php
poll_view_results in modules/poll/poll.module
Generates a graphical representation of the results of a poll.
theme_admin_page in modules/system/system.admin.inc
Returns HTML for an administrative page.
theme_dashboard_disabled_blocks in modules/dashboard/dashboard.module
Returns HTML for disabled blocks, for use in dashboard customization mode.
theme_system_admin_index in modules/system/system.admin.inc
Returns HTML for the output of the dashboard page.

File

modules/block/block.tpl.php
View source
  1. <?php
  2. /**
  3. * @file
  4. * Default theme implementation to display a block.
  5. *
  6. * Available variables:
  7. * - $block->subject: Block title.
  8. * - $content: Block content.
  9. * - $block->module: Module that generated the block.
  10. * - $block->delta: An ID for the block, unique within each module.
  11. * - $block->region: The block region embedding the current block.
  12. * - $classes: String of classes that can be used to style contextually through
  13. * CSS. It can be manipulated through the variable $classes_array from
  14. * preprocess functions. The default values can be one or more of the
  15. * following:
  16. * - block: The current template type, i.e., "theming hook".
  17. * - block-[module]: The module generating the block. For example, the user
  18. * module is responsible for handling the default user navigation block. In
  19. * that case the class would be 'block-user'.
  20. * - $title_prefix (array): An array containing additional output populated by
  21. * modules, intended to be displayed in front of the main title tag that
  22. * appears in the template.
  23. * - $title_suffix (array): An array containing additional output populated by
  24. * modules, intended to be displayed after the main title tag that appears in
  25. * the template.
  26. *
  27. * Helper variables:
  28. * - $classes_array: Array of html class attribute values. It is flattened
  29. * into a string within the variable $classes.
  30. * - $block_zebra: Outputs 'odd' and 'even' dependent on each block region.
  31. * - $zebra: Same output as $block_zebra but independent of any block region.
  32. * - $block_id: Counter dependent on each block region.
  33. * - $id: Same output as $block_id but independent of any block region.
  34. * - $is_front: Flags true when presented in the front page.
  35. * - $logged_in: Flags true when the current user is a logged-in member.
  36. * - $is_admin: Flags true when the current user is an administrator.
  37. * - $block_html_id: A valid HTML ID and guaranteed unique.
  38. *
  39. * @see template_preprocess()
  40. * @see template_preprocess_block()
  41. * @see template_process()
  42. *
  43. * @ingroup themeable
  44. */
  45. ?>
  46. <div id="<?php print $block_html_id; ?>" class="<?php print $classes; ?>"<?php print $attributes; ?>>
  47. <?php print render($title_prefix); ?>
  48. <?php if ($block->subject): ?>
  49. <h2<?php print $title_attributes; ?>><?php print $block->subject ?></h2>
  50. <?php endif;?>
  51. <?php print render($title_suffix); ?>
  52. <div class="content"<?php print $content_attributes; ?>>
  53. <?php print $content ?>
  54. </div>
  55. </div>

Related topics

Comments

If you have a custom theme, the $title_suffix is necessary to show contextual links - https://drupal.org/documentation/modules/contextual