4 * Contains theme override functions and preprocess functions for the Zen theme.
6 * IMPORTANT WARNING: DO NOT MODIFY THIS FILE.
8 * The base Zen theme is designed to be easily extended by its sub-themes. You
9 * shouldn't modify this or any of the CSS or PHP files in the root zen/ folder.
10 * See the online documentation for more information:
11 * http://drupal.org/node/193318
14 // Auto-rebuild the theme registry during theme development.
15 if (theme_get_setting('zen_rebuild_registry')) {
16 drupal_rebuild_theme_registry();
21 * Implements HOOK_theme().
23 function zen_theme(&$existing, $type, $theme, $path) {
24 // When #341140 is fixed, replace _zen_path() with drupal_get_path().
25 include_once
'./' .
_zen_path() .
'/zen-internals/template.theme-registry.inc';
26 return _zen_theme($existing, $type, $theme, $path);
30 * Return a themed breadcrumb trail.
33 * An array containing the breadcrumb links.
35 * A string containing the breadcrumb output.
37 function zen_breadcrumb($breadcrumb) {
38 // Determine if we are to display the breadcrumb.
39 $show_breadcrumb = theme_get_setting('zen_breadcrumb');
40 if ($show_breadcrumb == 'yes' || $show_breadcrumb == 'admin' && arg(0) == 'admin') {
42 // Optionally get rid of the homepage link.
43 $show_breadcrumb_home = theme_get_setting('zen_breadcrumb_home');
44 if (!$show_breadcrumb_home) {
45 array_shift($breadcrumb);
48 // Return the breadcrumb with separators.
49 if (!empty($breadcrumb)) {
50 $breadcrumb_separator = theme_get_setting('zen_breadcrumb_separator');
51 $trailing_separator = $title = '';
52 if (theme_get_setting('zen_breadcrumb_title')) {
53 if ($title = drupal_get_title()) {
54 $trailing_separator = $breadcrumb_separator;
57 elseif (theme_get_setting('zen_breadcrumb_trailing')) {
58 $trailing_separator = $breadcrumb_separator;
60 return '<div class="breadcrumb">' .
implode($breadcrumb_separator, $breadcrumb) .
"$trailing_separator$title</div>";
63 // Otherwise, return an empty string.
68 * Return a themed set of links.
71 * A keyed array of links to be themed.
73 * A keyed array of attributes
75 * An optional keyed array or a string for a heading to precede the links.
76 * When using an array the following keys can be used:
77 * - text: the heading text
78 * - level: the heading level (e.g. 'h2', 'h3')
79 * - class: (optional) a string of the CSS classes for the heading
80 * When using a string it will be used as the text of the heading and the
81 * level will default to 'h2'.
82 * Headings should be used on navigation menus and any list of links that
83 * consistently appears on multiple pages. To make the heading invisible
84 * use the 'element-invisible' CSS class. Do not use 'display:none', which
85 * removes it from screen-readers and assistive technology. Headings allow
86 * screen-reader and keyboard only users to navigate to or skip the links.
87 * See http://juicystudio.com/article/screen-readers-display-none.php
88 * and http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
90 * A string containing an unordered list of links.
92 function zen_links($links, $attributes = array('class' => 'links'), $heading = '') {
96 if (count($links) > 0) {
97 // Treat the heading first if it is present to prepend it to the
99 if (!empty($heading)) {
100 if (is_string($heading)) {
101 // Prepare the array that will be used when the passed heading
105 // Set the default level of the heading.
109 $output .
= '<' .
$heading['level'];
110 if (!empty($heading['class'])) {
111 $output .
= drupal_attributes(array('class' => $heading['class']));
113 $output .
= '>' .
check_plain($heading['text']) .
'</' .
$heading['level'] .
'>';
116 $output .
= '<ul'.
drupal_attributes($attributes) .
'>';
118 $num_links = count($links);
121 foreach ($links as
$key => $link) {
124 // Add first, last and active classes to the list of links to help out themers.
128 if ($i == $num_links) {
131 if (isset($link['href']) && ($link['href'] == $_GET['q'] || ($link['href'] == '<front>' && drupal_is_front_page()))
132 && (empty($link['language']) || $link['language']->language
== $language->language
)) {
135 $output .
= '<li'.
drupal_attributes(array('class' => $class)) .
'>';
137 if (isset($link['href'])) {
138 // Pass in $link as $options, they share the same keys.
139 $output .
= l($link['title'], $link['href'], $link);
141 else if (!empty($link['title'])) {
142 // Some links are actually not links, but we wrap these in <span> for adding title and class attributes
143 if (empty($link['html'])) {
144 $link['title'] = check_plain($link['title']);
146 $span_attributes = '';
147 if (isset($link['attributes'])) {
148 $span_attributes = drupal_attributes($link['attributes']);
150 $output .
= '<span'.
$span_attributes .
'>'.
$link['title'] .
'</span>';
154 $output .
= "</li>\n";
164 * Implements theme_menu_item_link()
166 function zen_menu_item_link($link) {
167 if (empty($link['localized_options'])) {
168 $link['localized_options'] = array();
171 // If an item is a LOCAL TASK, render it as a tab
172 if ($link['type'] & MENU_IS_LOCAL_TASK
) {
173 $link['title'] = '<span class="tab">' .
check_plain($link['title']) .
'</span>';
174 $link['localized_options']['html'] = TRUE
;
177 return l($link['title'], $link['href'], $link['localized_options']);
181 * Duplicate of theme_menu_local_tasks() but adds clearfix to tabs.
183 function zen_menu_local_tasks() {
186 // CTools requires a different set of local task functions.
187 if (module_exists('ctools')) {
188 ctools_include('menu');
189 $primary = ctools_menu_primary_local_tasks();
190 $secondary = ctools_menu_secondary_local_tasks();
193 $primary = menu_primary_local_tasks();
194 $secondary = menu_secondary_local_tasks();
198 $output .
= '<ul class="tabs primary clearfix">' .
$primary .
'</ul>';
201 $output .
= '<ul class="tabs secondary clearfix">' .
$secondary .
'</ul>';
208 * Return a set of blocks available for the current user.
211 * Which set of blocks to retrieve.
212 * @param $show_blocks
213 * A boolean to determine whether to render sidebar regions or not. Should be
214 * the same value as passed to theme_page.
216 * A string containing the themed blocks for this region.
218 * @see zen_show_blocks_discovery()
220 function zen_blocks($region, $show_blocks = NULL
) {
221 // Since Drupal 6 doesn't pass $show_blocks to theme_blocks, we manually call
222 // theme('blocks', NULL, $show_blocks) so that this function can remember the
223 // value on later calls.
224 static
$render_sidebars = TRUE
;
225 if (!is_null($show_blocks)) {
226 $render_sidebars = $show_blocks;
229 // If zen_blocks was called with a NULL region, its likely we were just
230 // setting the $render_sidebars static variable.
234 // If $renders_sidebars is FALSE, don't render any region whose name begins
236 if (($render_sidebars || (strpos($region, 'sidebar_') !== 0)) && ($list = block_list($region))) {
237 foreach ($list as
$key => $block) {
238 // $key == module_delta
239 $output .
= theme('block', $block);
243 // Add any content assigned to this region through drupal_set_content() calls.
244 $output .
= drupal_get_content($region);
246 $elements['#children'] = $output;
247 $elements['#region'] = $region;
249 // Set the theme hook suggestions.
250 $hook = array('region_' .
$region);
251 if (strpos($region, 'sidebar_') === 0) {
252 $hook[] = 'region_sidebar';
255 return $output ?
theme($hook, $elements) : '';
260 * Examine the $show_blocks variable before template_preprocess_page() is called.
263 * An array of variables to pass to the page template.
267 function zen_show_blocks_discovery(&$vars) {
268 if ($vars['show_blocks'] == FALSE
) {
269 // Allow zen_blocks() to statically cache the $show_blocks variable. A TRUE
270 // value is assumed, so we only need to override when $show_blocks is FALSE.
271 theme('blocks', NULL
, FALSE
);
276 * Override or insert variables into templates before other preprocess functions have run.
279 * An array of variables to pass to the theme template.
281 * The name of the template being rendered.
283 function zen_preprocess(&$vars, $hook) {
284 // In D6, the page.tpl uses a different variable name to hold the classes.
285 $key = ($hook == 'page' || $hook == 'maintenance_page') ?
'body_classes' : 'classes';
287 // Create a D7-standard classes_array variable.
288 if (array_key_exists($key, $vars)) {
289 // Views (and possibly other modules) have templates with a $classes
290 // variable that isn't a string, so we leave those variables alone.
291 if (is_string($vars[$key])) {
292 $vars['classes_array'] = explode(' ', $vars[$key]);
297 $vars['classes_array'] = array($hook);
299 // Add support for Skinr
300 if (!empty($vars['skinr']) && array_key_exists('classes_array', $vars)) {
301 $vars['classes_array'][] = $vars['skinr'];
306 * Override or insert variables into the page templates.
309 * An array of variables to pass to the theme template.
311 * The name of the template being rendered ("page" in this case.)
313 function zen_preprocess_page(&$vars, $hook) {
314 // If the user is silly and enables Zen as the theme, add some styles.
315 if ($GLOBALS['theme'] == 'zen') {
316 include_once
'./' .
_zen_path() .
'/zen-internals/template.zen.inc';
317 _zen_preprocess_page($vars, $hook);
319 // Add conditional stylesheets.
320 elseif (!module_exists('conditional_styles')) {
321 $vars['styles'] .
= $vars['conditional_styles'] = variable_get('conditional_styles_' .
$GLOBALS['theme'], '');
324 // Classes for body element. Allows advanced theming based on context
325 // (home page, node of certain type, etc.)
326 // Remove the mostly useless page-ARG0 class.
327 if ($index = array_search(preg_replace('![^abcdefghijklmnopqrstuvwxyz0-9-_]+!s', '', 'page-'.
drupal_strtolower(arg(0))), $vars['classes_array'])) {
328 unset($vars['classes_array'][$index]);
330 if (!$vars['is_front']) {
331 // Add unique class for each page.
332 $path = drupal_get_path_alias($_GET['q']);
333 $vars['classes_array'][] = drupal_html_class('page-' .
$path);
334 // Add unique class for each website section.
335 list($section, ) = explode('/', $path, 2);
336 if (arg(0) == 'node') {
337 if (arg(1) == 'add') {
338 $section = 'node-add';
340 elseif (is_numeric(arg(1)) && (arg(2) == 'edit' || arg(2) == 'delete')) {
341 $section = 'node-' .
arg(2);
344 $vars['classes_array'][] = drupal_html_class('section-' .
$section);
346 if (theme_get_setting('zen_wireframes')) {
347 $vars['classes_array'][] = 'with-wireframes'; // Optionally add the wireframes style.
349 // We need to re-do the $layout and body classes because
350 // template_preprocess_page() assumes sidebars are named 'left' and 'right'.
351 $vars['layout'] = 'none';
352 if (!empty($vars['sidebar_first'])) {
353 $vars['layout'] = 'first';
355 if (!empty($vars['sidebar_second'])) {
356 $vars['layout'] = ($vars['layout'] == 'first') ?
'both' : 'second';
358 // If the layout is 'none', then template_preprocess_page() will already have
359 // set a 'no-sidebars' class since it won't find a 'left' or 'right' sidebar.
360 if ($vars['layout'] != 'none') {
361 // Remove the incorrect 'no-sidebars' class.
362 if ($index = array_search('no-sidebars', $vars['classes_array'])) {
363 unset($vars['classes_array'][$index]);
365 // Set the proper layout body classes.
366 if ($vars['layout'] == 'both') {
367 $vars['classes_array'][] = 'two-sidebars';
370 $vars['classes_array'][] = 'one-sidebar';
371 $vars['classes_array'][] = 'sidebar-' .
$vars['layout'];
374 // Store the menu item since it has some useful information.
375 $vars['menu_item'] = menu_get_item();
376 switch ($vars['menu_item']['page_callback']) {
378 // Is this a Views page?
379 $vars['classes_array'][] = 'page-views';
381 case
'page_manager_page_execute':
382 // Is this a Panels page?
383 $vars['classes_array'][] = 'page-panels';
389 * Override or insert variables into the maintenance page template.
392 * An array of variables to pass to the theme template.
394 * The name of the template being rendered ("maintenance_page" in this case.)
396 function zen_preprocess_maintenance_page(&$vars, $hook) {
397 // If Zen is the maintenance theme, add some styles.
398 if ($GLOBALS['theme'] == 'zen') {
399 include_once
'./' .
_zen_path() .
'/zen-internals/template.zen.inc';
400 _zen_preprocess_page($vars, $hook);
402 // Add conditional stylesheets.
403 elseif (!module_exists('conditional_styles')) {
404 $vars['styles'] .
= $vars['conditional_styles'] = variable_get('conditional_styles_' .
$GLOBALS['theme'], '');
407 // Classes for body element. Allows advanced theming based on context
408 // (home page, node of certain type, etc.)
409 $vars['body_classes_array'] = explode(' ', $vars['body_classes']);
413 * Override or insert variables into the node templates.
416 * An array of variables to pass to the theme template.
418 * The name of the template being rendered ("node" in this case.)
420 function zen_preprocess_node(&$vars, $hook) {
421 // Create the build_mode variable.
422 switch ($vars['node']->build_mode
) {
423 case NODE_BUILD_NORMAL
:
424 $vars['build_mode'] = $vars['teaser'] ?
'teaser' : 'full';
426 case NODE_BUILD_PREVIEW
:
427 $vars['build_mode'] = 'preview';
429 case NODE_BUILD_SEARCH_INDEX
:
430 $vars['build_mode'] = 'search_index';
432 case NODE_BUILD_SEARCH_RESULT
:
433 $vars['build_mode'] = 'search_result';
436 $vars['build_mode'] = 'rss';
438 case NODE_BUILD_PRINT
:
439 $vars['build_mode'] = 'print';
443 // Create the user_picture variable.
444 $vars['user_picture'] = $vars['picture'];
446 // Create the Drupal 7 $display_submitted variable.
447 $vars['display_submitted'] = theme_get_setting('toggle_node_info_' .
$vars['node']->type
);
449 // Special classes for nodes.
450 // Class for node type: "node-type-page", "node-type-story", "node-type-my-custom-type", etc.
451 $vars['classes_array'][] = drupal_html_class('node-type-' .
$vars['type']);
452 if ($vars['promote']) {
453 $vars['classes_array'][] = 'node-promoted';
455 if ($vars['sticky']) {
456 $vars['classes_array'][] = 'node-sticky';
458 if (!$vars['status']) {
459 $vars['classes_array'][] = 'node-unpublished';
460 $vars['unpublished'] = TRUE
;
463 $vars['unpublished'] = FALSE
;
465 if ($vars['uid'] && $vars['uid'] == $GLOBALS['user']->uid
) {
466 $vars['classes_array'][] = 'node-by-viewer'; // Node is authored by current user.
468 if ($vars['teaser']) {
469 $vars['classes_array'][] = 'node-teaser'; // Node is displayed as teaser.
471 if (isset($vars['preview'])) {
472 $vars['classes_array'][] = 'node-preview';
477 * Override or insert variables into the comment templates.
480 * An array of variables to pass to the theme template.
482 * The name of the template being rendered ("comment" in this case.)
484 function zen_preprocess_comment(&$vars, $hook) {
485 include_once
'./' .
_zen_path() .
'/zen-internals/template.comment.inc';
486 _zen_preprocess_comment($vars, $hook);
490 * Preprocess variables for region.tpl.php
492 * Prepare the values passed to the theme_region function to be passed into a
493 * pluggable template engine. Uses the region name to generate a template file
494 * suggestions. If none are found, the default region.tpl.php is used.
496 * @see region.tpl.php
498 function zen_preprocess_region(&$vars, $hook) {
499 // Create the $content variable that templates expect.
500 $vars['content'] = $vars['elements']['#children'];
501 $vars['region'] = $vars['elements']['#region'];
503 // Setup the default classes.
504 $region = 'region-' .
str_replace('_', '-', $vars['region']);
505 $vars['classes_array'] = array('region', $region);
507 // Sidebar regions get a common template suggestion a couple extra classes.
508 if (strpos($vars['region'], 'sidebar_') === 0) {
509 $vars['template_files'][] = 'region-sidebar';
510 $vars['classes_array'][] = 'column';
511 $vars['classes_array'][] = 'sidebar';
514 // Setup the default template suggestion.
515 $vars['template_files'][] = $region;
519 * Override or insert variables into the block templates.
522 * An array of variables to pass to the theme template.
524 * The name of the template being rendered ("block" in this case.)
526 function zen_preprocess_block(&$vars, $hook) {
527 $block = $vars['block'];
529 // Drupal 7 uses a $content variable instead of $block->content.
530 $vars['content'] = $block->content
;
531 // Drupal 7 should use a $title variable instead of $block->subject.
532 $vars['title'] = $block->subject
;
534 // Special classes for blocks.
535 $vars['classes_array'][] = 'block-' .
$block->module
;
536 $vars['classes_array'][] = 'region-' .
$vars['block_zebra'];
537 $vars['classes_array'][] = $vars['zebra'];
538 $vars['classes_array'][] = 'region-count-' .
$vars['block_id'];
539 $vars['classes_array'][] = 'count-' .
$vars['id'];
541 // Create the block ID.
542 $vars['block_html_id'] = 'block-' .
$block->module .
'-' .
$block->delta
;
544 $vars['edit_links_array'] = array();
545 if (theme_get_setting('zen_block_editing') && user_access('administer blocks')) {
546 include_once
'./' .
_zen_path() .
'/zen-internals/template.block-editing.inc';
547 zen_preprocess_block_editing($vars, $hook);
548 $vars['classes_array'][] = 'with-block-editing';
553 * Override or insert variables into the views-view templates.
556 * An array of variables to pass to the theme template.
558 * The name of the template being rendered ("views-view" in this case.)
560 function zen_preprocess_views_view(&$vars, $hook) {
561 // Add the default Views classes.
562 $vars['classes_array'][0] = 'view'; // Replace "views-view".
563 $vars['classes_array'][] = 'view-' .
$vars['css_name'];
564 $vars['classes_array'][] = 'view-id-' .
$vars['name'];
565 $vars['classes_array'][] = 'view-display-id-' .
$vars['display_id'];
566 $vars['classes_array'][] = 'view-dom-id-' .
$vars['dom_id'];
570 * Override or insert variables into templates after preprocess functions have run.
573 * An array of variables to pass to the theme template.
575 * The name of the template being rendered.
577 function zen_process(&$vars, $hook) {
578 // Don't clobber Views 3 classes.
579 if (array_key_exists('classes_array', $vars) && !array_key_exists('classes', $vars)) {
580 $vars['classes'] = implode(' ', $vars['classes_array']);
585 * Override or insert variables into the block templates after preprocess functions have run.
588 * An array of variables to pass to the theme template.
590 * The name of the template being rendered ("block" in this case.)
592 function zen_process_block(&$vars, $hook) {
593 $vars['edit_links'] = !empty($vars['edit_links_array']) ?
'<div class="edit">' .
implode(' ', $vars['edit_links_array']) .
'</div>' : '';
596 if (!function_exists('drupal_html_class')) {
598 * Prepare a string for use as a valid class name.
600 * Do not pass one string containing multiple classes as they will be
601 * incorrectly concatenated with dashes, i.e. "one two" will become "one-two".
604 * The class name to clean.
606 * The cleaned class name.
608 function drupal_html_class($class) {
609 // By default, we filter using Drupal's coding standards.
610 $class = strtr(drupal_strtolower($class), array(' ' => '-', '_' => '-', '/' => '-', '[' => '-', ']' => ''));
612 // http://www.w3.org/TR/CSS21/syndata.html#characters shows the syntax for valid
613 // CSS identifiers (including element names, classes, and IDs in selectors.)
615 // Valid characters in a CSS identifier are:
616 // - the hyphen (U+002D)
617 // - a-z (U+0030 - U+0039)
618 // - A-Z (U+0041 - U+005A)
619 // - the underscore (U+005F)
620 // - 0-9 (U+0061 - U+007A)
621 // - ISO 10646 characters U+00A1 and higher
622 // We strip out any character not in the above list.
623 $class = preg_replace('/[^\x{002D}\x{0030}-\x{0039}\x{0041}-\x{005A}\x{005F}\x{0061}-\x{007A}\x{00A1}-\x{FFFF}]/u', '', $class);
627 } /* End of drupal_html_class conditional definition. */
629 if (!function_exists('drupal_html_id')) {
631 * Prepare a string for use as a valid HTML ID and guarantee uniqueness.
638 function drupal_html_id($id) {
639 $id = strtr(drupal_strtolower($id), array(' ' => '-', '_' => '-', '[' => '-', ']' => ''));
641 // As defined in http://www.w3.org/TR/html4/types.html#type-name, HTML IDs can
642 // only contain letters, digits ([0-9]), hyphens ("-"), underscores ("_"),
643 // colons (":"), and periods ("."). We strip out any character not in that
644 // list. Note that the CSS spec doesn't allow colons or periods in identifiers
645 // (http://www.w3.org/TR/CSS21/syndata.html#characters), so we strip those two
646 // characters as well.
647 $id = preg_replace('/[^A-Za-z0-9\-_]/', '', $id);
651 } /* End of drupal_html_id conditional definition. */
654 * Returns the path to the Zen theme.
656 * drupal_get_filename() is broken; see #341140. When that is fixed in Drupal 6,
657 * replace _zen_path() with drupal_get_path('theme', 'zen').
659 function _zen_path() {
660 static
$path = FALSE
;
662 $matches = drupal_system_listing('zen\.info$', 'themes', 'name', 0);
663 if (!empty($matches['zen']->filename
)) {
664 $path = dirname($matches['zen']->filename
);