6 默认的模板文件

作者：老葛，北京亚艾元软件有限责任公司，http://www.yaiyuan.com

接下来，我们将modules\system下面的html.tpl.php文件，复制到templates文件夹下面，如果不复制过来，默认仍然会使用modules\system下面的html.tpl.php，复制过来有个好处，将来覆写这个模板文件的时候方便。

Drupal版本:

drupal7

6.1 html.tpl.php

作者：老葛，北京亚艾元软件有限责任公司，http://www.yaiyuan.com

我们来看一下这个模板文件：

/**

* @file

* Default theme implementation to display the basic html structure of a single

* Drupal page.

* Variables:

* - $css: An array of CSS files for the current page.

* - $language: (object) The language the site is being displayed in.

* $language->language contains its textual representation.

* $language->dir contains the language direction. It will either be 'ltr' or 'rtl'.

* - $rdf_namespaces: All the RDF namespace prefixes used in the HTML document.

* - $grddl_profile: A GRDDL profile allowing agents to extract the RDF data.

* - $head_title: A modified version of the page title, for use in the TITLE

* tag.

* - $head_title_array: (array) An associative array containing the string parts

* that were used to generate the $head_title variable, already prepared to be

* output as TITLE tag. The key/value pairs may contain one or more of the

* following, depending on conditions:

* - title: The title of the current page, if any.

* - name: The name of the site.

* - slogan: The slogan of the site, if any, and if there is no title.

* - $head: Markup for the HEAD section (including meta tags, keyword tags, and

* so on).

* - $styles: Style tags necessary to import all CSS files for the page.

* - $scripts: Script tags necessary to load the JavaScript files and settings

* for the page.

* - $page_top: Initial markup from any modules that have altered the

* page. This variable should always be output first, before all other dynamic

* content.

* - $page: The rendered page content.

* - $page_bottom: Final closing markup from any modules that have altered the

* page. This variable should always be output last, after all other dynamic

* content.

* - $classes String of classes that can be used to style contextually through

* CSS.

* @see template_preprocess()

* @see template_preprocess_html()

* @see template_process()

* @ingroup themeable

?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML+RDFa 1.0//EN"

"http://www.w3.org/MarkUp/DTD/xhtml-rdfa-1.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<?php print $language->language; ?>" version="XHTML+RDFa 1.0" dir="<?php print $language->dir; ?>"<?php print $rdf_namespaces; ?>>

<?php print $head; ?>

<?php print $styles; ?>

<?php print $scripts; ?>

</head>

</div>

<?php print $page_top; ?>

<?php print $page; ?>

<?php print $page_bottom; ?>

</body>

</html>

在这个模板文件的上面，是注释，核心自带的模板文件里面，都有注释的，注释里面给出了当前模板文件里面可用的变量；在注释的结尾处，给出了预处理函数、处理函数，我们这里使用的变量都是在这些预处理函数、处理函数里面定义的。

我们看到，html.tpl.php模板文件里面，主要负责head里面变量的输出，里面包含$head、$head_title、$styles、$scripts，后面的两个变量，分别负责样式、脚本的输出，我们在info文件里面定义的stylesheets和scripts就是通过这两个变量输出的。而在body里面，主要是输出$page，其它都是起辅助作用的。

在Drupal6里面，这些变量内容，其实是放在page.tpl.php里面，由于每个页面的这部分内容，基本上是比较固定的，所在Drupal7里面，就将其独立成一个单独的文件了，这样page.tpl.php里面的内容，就少了很多。

template_preprocess和template_process里面定义的变量，在所有的模板文件里面都可以使用。在里面主要定义了下面四个变量：

$variables['zebra'] = ($count[$hook] % 2) ? 'odd' : 'even';

$variables['id'] = $count[$hook]++;

// Tell all templates where they are located.

$variables['directory'] = path_to_theme();

// Initialize html class attribute for the current hook.

$variables['classes_array'] = array(drupal_html_class($hook));

此外，还有一些默认变量是通过_template_preprocess_default_variables定义，这些变量大致包括：

$variables = array(

'attributes_array' => array(),

'title_attributes_array' => array(),

'content_attributes_array' => array(),

'title_prefix' => array(),

'title_suffix' => array(),

'user' => $user,

'db_is_active' => !defined('MAINTENANCE_MODE'),

'is_admin' => FALSE,

'logged_in' => FALSE,

);

$variables['is_front'] = drupal_is_front_page();

在template_process里面，也可以定义变量，不过这些变量，都是直接来源于预处理函书中的，比如：

$variables['classes'] = implode(' ', $variables['classes_array']);

处理函数中的classes变量，就是直接根源于预处理函数中的classes_array，只不过将它从数组的形式转成了字符串。

template_preprocess_html定义了一些变量：

$variables['classes_array'][] = $variables['is_front'] ? 'front' : 'not-front';

$variables['rdf_namespaces'] = drupal_get_rdf_namespaces();

$variables['grddl_profile'] = 'http://www.w3.org/1999/xhtml/vocab';

$variables['language'] = $GLOBALS['language'];

$variables['language']->dir = $GLOBALS['language']->direction ? 'rtl' : 'ltr';

$variables['head_title_array'] = $head_title;

$variables['head_title'] = implode(' | ', $head_title);

$variables['theme_hook_suggestions'] = $suggestions;

我们注意到，好几个变量都没有在这里定义，此时我们可以尝试Google一下template_process_html，在api.drupal.org找到这个函数的定义，里面就有我们在模板里面用到的变量：

// Render page_top and page_bottom into top level variables.

$variables['page_top'] = drupal_render($variables['page']['page_top']);

$variables['page_bottom'] = drupal_render($variables['page']['page_bottom']);

// Place the rendered HTML for the page body into a top level variable.

$variables['page'] = $variables['page']['#children'];

$variables['page_bottom'] .= drupal_get_js('footer');

$variables['head'] = drupal_get_html_head();

$variables['css'] = drupal_add_css();

$variables['styles'] = drupal_get_css();

$variables['scripts'] = drupal_get_js();

我们在这里，只需要知道变量是在预处理函数、处理函数里面定义的即可，用到的时候再去查找相应的函数。还有一个问题，Drupal是怎么把模板文件和对应的变量合并成HTML片段的，经常有人问这个问题，这时通过theme_render_template函数完成的，我们在第4集的时候，简单的介绍过这个函数。

我们在html.tpl.php里面使用这么两句话输出CSS、JS文件：

<?php print $styles; ?>

<?php print $scripts; ?>

在实际的项目中，我们还经常这样用：

<?php print $styles; ?>

<?php print $scripts; ?>

我们直接在模板文件里面输出了CSS、JS文件，而不是通过主题的info文件，这不是什么Drupal高手推荐的方式，但是却是在实际项目当中，用的最多的一种方式。另外，就是这里的base_path().path_to_theme()，这两个函数，我们在后面还会用到。我们这里也可以使用$base_path.$directory，效果是一样的，不过我更喜欢直接使用函数的形式。注意，变量的形式，只能用于模板文件中，而函数的形式，适用的范围更广泛一些。

Drupal版本:

drupal7

6.2 page.tpl.php

作者：老葛，北京亚艾元软件有限责任公司，http://www.yaiyuan.com

接下来，我们将modules\system下面的page.tpl.php文件，复制到sites\all\themes\snt\templates文件夹下面。我建议每个学习Drupal的用户，都把这个默认模板文件看上几遍。

<?php

/**

* @file

* Default theme implementation to display a single Drupal page.

* The doctype, html, head and body tags are not in this template. Instead they

* can be found in the html.tpl.php template in this directory.

* Available variables:

* General utility variables:

* - $base_path: The base URL path of the Drupal installation. At the very

* least, this will always default to /.

* - $directory: The directory the template is located in, e.g. modules/system

* or themes/bartik.

* - $is_front: TRUE if the current page is the front page.

* - $logged_in: TRUE if the user is registered and signed in.

* - $is_admin: TRUE if the user has permission to access administration pages.

* Site identity:

* - $front_page: The URL of the front page. Use this instead of $base_path,

* when linking to the front page. This includes the language domain or

* prefix.

* - $logo: The path to the logo image, as defined in theme configuration.

* - $site_name: The name of the site, empty when display has been disabled

* in theme settings.

* - $site_slogan: The slogan of the site, empty when display has been disabled

* in theme settings.

* Navigation:

* - $main_menu (array): An array containing the Main menu links for the

* site, if they have been configured.

* - $secondary_menu (array): An array containing the Secondary menu links for

* the site, if they have been configured.

* - $breadcrumb: The breadcrumb trail for the current page.

* Page content (in order of occurrence in the default page.tpl.php):

* - $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: The page title, for use in the actual HTML content.

* - $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.

* - $messages: HTML for status and error messages. Should be displayed

* prominently.

* - $tabs (array): Tabs linking to any sub-pages beneath the current page

* (e.g., the view and edit tabs when displaying a node).

* - $action_links (array): Actions local to the page, such as 'Add menu' on the

* menu administration interface.

* - $feed_icons: A string of all feed icons for the current page.

* - $node: The node object, if there is an automatically-loaded node

* associated with the page, and the node ID is the second argument

* in the page's path (e.g. node/12345 and node/12345/revisions, but not

* comment/reply/12345).

* Regions:

* - $page['help']: Dynamic help text, mostly for admin pages.

* - $page['highlighted']: Items for the highlighted content region.

* - $page['content']: The main content of the current page.

* - $page['sidebar_first']: Items for the first sidebar.

* - $page['sidebar_second']: Items for the second sidebar.

* - $page['header']: Items for the header region.

* - $page['footer']: Items for the footer region.

* @see template_preprocess()

* @see template_preprocess_page()

* @see template_process()

* @see html.tpl.php

* @ingroup themeable

<?php if ($logo): ?>

<a href="<?php print $front_page; ?>" title="<?php print t('Home'); ?>" rel="home" id="logo">

</a>

<?php endif; ?>

<?php if ($site_name || $site_slogan): ?>

<?php if ($site_name): ?>

<?php if ($title): ?>

<a href="<?php print $front_page; ?>" title="<?php print t('Home'); ?>" rel="home"><span><?php print $site_name; ?></span></a>

</strong></div>

<?php else: /* Use h1 when the content title is empty */ ?>

<a href="<?php print $front_page; ?>" title="<?php print t('Home'); ?>" rel="home"><span><?php print $site_name; ?></span></a>

</h1>

<?php endif; ?>

<?php if ($site_slogan): ?>

<?php endif; ?>

</div>

<?php endif; ?>

<?php print render($page['header']); ?>

</div></div>

<?php if ($main_menu || $secondary_menu): ?>

<?php print theme('links__system_main_menu', array('links' => $main_menu, 'attributes' => array('id' => 'main-menu', 'class' => array('links', 'inline', 'clearfix')), 'heading' => t('Main menu'))); ?>

<?php print theme('links__system_secondary_menu', array('links' => $secondary_menu, 'attributes' => array('id' => 'secondary-menu', 'class' => array('links', 'inline', 'clearfix')), 'heading' => t('Secondary menu'))); ?>

</div></div>

<?php endif; ?>

<?php if ($breadcrumb): ?>

<?php endif; ?>

<?php print $messages; ?>

<?php if ($page['highlighted']): ?><div id="highlighted"><?php print render($page['highlighted']); ?></div><?php endif; ?>

<?php print render($title_prefix); ?>

<?php if ($title): ?><h1 class="title" id="page-title"><?php print $title; ?></h1><?php endif; ?>

<?php print render($title_suffix); ?>

<?php if ($tabs): ?><div class="tabs"><?php print render($tabs); ?></div><?php endif; ?>

<?php print render($page['help']); ?>

<?php if ($action_links): ?><ul class="action-links"><?php print render($action_links); ?></ul><?php endif; ?>

<?php print render($page['content']); ?>

<?php print $feed_icons; ?>

</div></div>

<?php if ($page['sidebar_first']): ?>

<?php print render($page['sidebar_first']); ?>

</div></div>

<?php endif; ?>

<?php if ($page['sidebar_second']): ?>

<?php print render($page['sidebar_second']); ?>

</div></div>

<?php endif; ?>

</div></div>

<?php print render($page['footer']); ?>

</div></div>

</div></div>

这仍然是HTML里面嵌套了对应的变量，这里面的变量很多，但是实际上，最常用的是区域变量，它们的调用方式都是一样的：

<?php print render($page['footer']); ?>

像page.tpl.php里面特有的变量，比如$logo、$breadcrumb，以及主导航链接，二级导航链接的输出，正在被区块的形式所取代。统一采用区块的形式，学习起来更易于掌握。

Drupal版本:

drupal7