diff options
| author | Gábor Hojtsy <gabor@hojtsy.hu> | 2007-08-28 11:35:34 +0000 |
|---|---|---|
| committer | Gábor Hojtsy <gabor@hojtsy.hu> | 2007-08-28 11:35:34 +0000 |
| commit | 43d73f81c93ceda3b3380058135169dc340a7146 (patch) | |
| tree | 575436ae3e78a36875a2de14f6f4f0cbd91f3450 /modules/system | |
| parent | 42be9d1311b5fd689f68f57e513503a3a7c52356 (diff) | |
| download | brdo-43d73f81c93ceda3b3380058135169dc340a7146.tar.gz brdo-43d73f81c93ceda3b3380058135169dc340a7146.tar.bz2 | |
#166071 by jjeff and dvessel: move default template preprocess code to template_preprocess, and add *lots* of documentation to template files and functions
Diffstat (limited to 'modules/system')
| -rw-r--r-- | modules/system/block.tpl.php | 31 | ||||
| -rw-r--r-- | modules/system/page.tpl.php | 6 |
2 files changed, 31 insertions, 6 deletions
diff --git a/modules/system/block.tpl.php b/modules/system/block.tpl.php index 52bf62b10..3b60cf9f0 100644 --- a/modules/system/block.tpl.php +++ b/modules/system/block.tpl.php @@ -1,11 +1,38 @@ <?php // $Id$ + +/** + * @file block.tpl.php + * + * Theme implementation to display a block. + * + * Available variables: + * - $block->subject: Block title. + * - $block->content: Block content. + * - $block->module: Module that generated the block. + * - $block->delta: This is a numeric id connected to each module. + * - $block->region: The block region embedding the current block. + * + * Helper variables: + * - $block_zebra: Outputs 'odd' and 'even' dependent on the default sidebar + * block regions. + * - $zebra: Same output as $block_zebra but independent of any block region. + * - $block_id: counter within the default sidebar block regions. + * - $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. + * + * @see template_preprocess() + * @see template_preprocess_block() + */ ?> <div id="block-<?php print $block->module .'-'. $block->delta; ?>" class="block block-<?php print $block->module ?>"> - <?php if ($block->subject): ?> <h2><?php print $block->subject ?></h2> <?php endif;?> - <div class="content"><?php print $block->content ?></div> + <div class="content"> + <?php print $block->content ?> + </div> </div> diff --git a/modules/system/page.tpl.php b/modules/system/page.tpl.php index a71b18d8f..d6ee32686 100644 --- a/modules/system/page.tpl.php +++ b/modules/system/page.tpl.php @@ -14,7 +14,7 @@ * - $css: An array of CSS files for the current page. * - $directory: The directory the theme is located in, e.g. themes/garland or * themes/garland/minelli. - * - $is_front: TRUE if the current page is the front page. + * - $is_front: TRUE if the current page is the front page. Used to toggle the mission statement. * - $logged_in: TRUE if the user is registered and signed in. * - $is_admin: TRUE if the user has permission to access administration pages. * @@ -30,8 +30,6 @@ * - $body_classes: A set of CSS classes for the BODY tag. This contains flags * indicating the current layout (multiple columns, single column), the current * path, whether the user is logged in, and so on. - * - $is_front: True if the front page is currently being displayed. Used to - * toggle the mission. * * Site identity: * - $logo: The path to the logo image, as defined in theme configuration. @@ -69,8 +67,8 @@ * - $closure: Final closing markup from any modules that have altered the page. * This variable should always be output last, after all other dynamic content. * + * @see template_preprocess() * @see template_preprocess_page() - * @see phptemplate_engine_preprocess() */ ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |