summaryrefslogtreecommitdiffstats
path: root/core/modules/block/templates/block.tpl.php
blob: 106dd6b3566becebddbe85a1aaacb259824e1c20 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<?php

/**
 * @file
 * Default theme implementation to display a block.
 *
 * Available variables:
 * - $plugin_id: The ID of the block implementation.
 * - $label: The configured label of the block if visible.
 * - $configuration: An array of the block's configuration values.
 *   - label: The configured label for the block.
 *   - label_display: The display settings for the label.
 *   - module: The module that provided this block plugin.
 *   - cache: The cache settings.
 *   - Block plugin specific settings will also be stored here.
 * - $content: Block content.
 * - $attributes: An instance of Attributes class that can be manipulated as an
 *    array and printed as a string.
 *    It includes the 'class' information, which includes:
 *   - 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:
 * - $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 template_preprocess()
 * @see template_preprocess_block()
 * @see template_process()
 *
 * @ingroup themeable
 */
?>
<?php if (isset($block_html_id)): ?>
  <div id="<?php print $block_html_id; ?>" <?php print $attributes; ?>>
<?php else: ?>
  <div <?php print $attributes; ?>>
<?php endif; ?>

  <?php print render($title_prefix); ?>
<?php if ($label): ?>
  <h2<?php print $title_attributes; ?>><?php print $label; ?></h2>
<?php endif;?>
  <?php print render($title_suffix); ?>

  <div<?php print $content_attributes; ?>>
    <?php print render($content) ?>
  </div>
</div>