<?php
/**
* @file
* Contains functions to alter Drupal's markup for the Zen theme.
*
* IMPORTANT WARNING: DO NOT MODIFY THIS FILE.
*
* The base Zen theme is designed to be easily extended by its sub-themes. You
* shouldn't modify this or any of the CSS or PHP files in the root zen/ folder.
* See the online documentation for more information:
* https://drupal.org/documentation/theme/zen
*/
// Auto-rebuild the theme registry during theme development.
if (theme_get_setting('zen_rebuild_registry') && !defined('MAINTENANCE_MODE')) {
// Rebuild .info data.
system_rebuild_theme_data();
// Rebuild theme registry.
drupal_theme_rebuild();
}
/**
* Implements HOOK_theme().
*/
function zen_theme(&$existing, $type, $theme, $path) {
include_once './' . drupal_get_path('theme', 'zen') . '/zen-internals/template.theme-registry.inc';
return _zen_theme($existing, $type, $theme, $path);
}
/**
* Return a themed breadcrumb trail.
*
* @param $variables
* - title: An optional string to be used as a navigational heading to give
* context for breadcrumb links to screen-reader users.
* - title_attributes_array: Array of HTML attributes for the title. It is
* flattened into a string within the theme function.
* - breadcrumb: An array containing the breadcrumb links.
* @return
* A string containing the breadcrumb output.
*/
function zen_breadcrumb($variables) {
$breadcrumb = $variables['breadcrumb'];
$output = '';
// Determine if we are to display the breadcrumb.
$show_breadcrumb = theme_get_setting('zen_breadcrumb');
if ($show_breadcrumb == 'yes' || $show_breadcrumb == 'admin' && arg(0) == 'admin') {
// Optionally get rid of the homepage link.
$show_breadcrumb_home = theme_get_setting('zen_breadcrumb_home');
if (!$show_breadcrumb_home) {
array_shift($breadcrumb);
}
// Return the breadcrumb with separators.
if (!empty($breadcrumb)) {
$breadcrumb_separator = filter_xss_admin(theme_get_setting('zen_breadcrumb_separator'));
$trailing_separator = $title = '';
if (theme_get_setting('zen_breadcrumb_title')) {
$item = menu_get_item();
if (!empty($item['tab_parent'])) {
// If we are on a non-default tab, use the tab's title.
$breadcrumb[] = check_plain($item['title']);
}
else {
$breadcrumb[] = drupal_get_title();
}
}
elseif (theme_get_setting('zen_breadcrumb_trailing')) {
$trailing_separator = $breadcrumb_separator;
}
// Provide a navigational heading to give context for breadcrumb links to
// screen-reader users.
if (empty($variables['title'])) {
$variables['title'] = t('You are here');
}
// Unless overridden by a preprocess function, make the heading invisible.
if (!isset($variables['title_attributes_array']['class'])) {
$variables['title_attributes_array']['class'][] = 'element-invisible';
}
// Build the breadcrumb trail.
$output = '<nav class="breadcrumb" role="navigation">';
$output .= '<h2' . drupal_attributes($variables['title_attributes_array']) . '>' . $variables['title'] . '</h2>';
$output .= '<ol><li>' . implode($breadcrumb_separator . '</li><li>', $breadcrumb) . $trailing_separator . '</li></ol>';
$output .= '</nav>';
}
}
return $output;
}
/**
* Override or insert variables into the html template.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered. This is usually "html", but can
* also be "maintenance_page" since zen_preprocess_maintenance_page() calls
* this function to have consistent variables.
*/
function zen_preprocess_html(&$variables, $hook) {
// Add variables and paths needed for HTML5 and responsive support.
$variables['base_path'] = base_path();
$variables['path_to_zen'] = drupal_get_path('theme', 'zen');
// Get settings for HTML5 and responsive support. array_filter() removes
// items from the array that have been disabled.
$html5_respond_meta = array_filter((array) theme_get_setting('zen_html5_respond_meta'));
$variables['add_respond_js'] = in_array('respond', $html5_respond_meta);
$variables['add_html5_shim'] = in_array('html5', $html5_respond_meta);
$variables['default_mobile_metatags'] = in_array('meta', $html5_respond_meta);
// If the user is silly and enables Zen as the theme, add some styles.
if ($GLOBALS['theme'] == 'zen') {
include_once './' . $variables['path_to_zen'] . '/zen-internals/template.zen.inc';
_zen_preprocess_html($variables, $hook);
}
// Attributes for html element.
$variables['html_attributes_array'] = array(
'lang' => $variables['language']->language,
'dir' => $variables['language']->dir,
);
// Send X-UA-Compatible HTTP header to force IE to use the most recent
// rendering engine or use Chrome's frame rendering engine if available.
// This also prevents the IE compatibility mode button to appear when using
// conditional classes on the html tag.
if (is_null(drupal_get_http_header('X-UA-Compatible'))) {
drupal_add_http_header('X-UA-Compatible', 'IE=edge,chrome=1');
}
$variables['skip_link_anchor'] = check_plain(theme_get_setting('zen_skip_link_anchor'));
$variables['skip_link_text'] = check_plain(theme_get_setting('zen_skip_link_text'));
// Return early, so the maintenance page does not call any of the code below.
if ($hook != 'html') {
return;
}
// Serialize RDF Namespaces into an RDFa 1.1 prefix attribute.
if ($variables['rdf_namespaces']) {
$prefixes = array();
foreach (explode("\n ", ltrim($variables['rdf_namespaces'])) as $namespace) {
// Remove xlmns: and ending quote and fix prefix formatting.
$prefixes[] = str_replace('="', ': ', substr($namespace, 6, -1));
}
$variables['rdf_namespaces'] = ' prefix="' . implode(' ', $prefixes) . '"';
}
// Classes for body element. Allows advanced theming based on context
// (home page, node of certain type, etc.)
if (!$variables['is_front']) {
// Add unique class for each page.
$path = drupal_get_path_alias($_GET['q']);
// Add unique class for each website section.
list($section, ) = explode('/', $path, 2);
$arg = explode('/', $_GET['q']);
if ($arg[0] == 'node' && isset($arg[1])) {
if ($arg[1] == 'add') {
$section = 'node-add';
}
elseif (isset($arg[2]) && is_numeric($arg[1]) && ($arg[2] == 'edit' || $arg[2] == 'delete')) {
$section = 'node-' . $arg[2];
}
}
$variables['classes_array'][] = drupal_html_class('section-' . $section);
}
if (theme_get_setting('zen_wireframes')) {
$variables['classes_array'][] = 'with-wireframes'; // Optionally add the wireframes style.
}
// Store the menu item since it has some useful information.
$variables['menu_item'] = menu_get_item();
if ($variables['menu_item']) {
switch ($variables['menu_item']['page_callback']) {
case 'views_page':
// Is this a Views page?
$variables['classes_array'][] = 'page-views';
break;
case 'page_manager_blog':
case 'page_manager_blog_user':
case 'page_manager_contact_site':
case 'page_manager_contact_user':
case 'page_manager_node_add':
case 'page_manager_node_edit':
case 'page_manager_node_view_page':
case 'page_manager_page_execute':
case 'page_manager_poll':
case 'page_manager_search_page':
case 'page_manager_term_view_page':
case 'page_manager_user_edit_page':
case 'page_manager_user_view_page':
// Is this a Panels page?
$variables['classes_array'][] = 'page-panels';
break;
}
}
}
/**
* Override or insert variables into the html templates.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("html" in this case.)
*/
function zen_process_html(&$variables, $hook) {
// Flatten out html_attributes.
$variables['html_attributes'] = drupal_attributes($variables['html_attributes_array']);
}
/**
* Override or insert variables in the html_tag theme function.
*/
function zen_process_html_tag(&$variables) {
$tag = &$variables['element'];
if ($tag['#tag'] == 'style' || $tag['#tag'] == 'script') {
// Remove redundant type attribute and CDATA comments.
unset($tag['#attributes']['type'], $tag['#value_prefix'], $tag['#value_suffix']);
// Remove media="all" but leave others unaffected.
if (isset($tag['#attributes']['media']) && $tag['#attributes']['media'] === 'all') {
unset($tag['#attributes']['media']);
}
}
}
/**
* Implement hook_html_head_alter().
*/
function zen_html_head_alter(&$head) {
// Simplify the meta tag for character encoding.
if (isset($head['system_meta_content_type']['#attributes']['content'])) {
$head['system_meta_content_type']['#attributes'] = array('charset' => str_replace('text/html; charset=', '', $head['system_meta_content_type']['#attributes']['content']));
}
}
/**
* Override or insert variables into the page template.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("page" in this case.)
*/
function zen_preprocess_page(&$variables, $hook) {
// Find the title of the menu used by the secondary links.
$secondary_links = variable_get('menu_secondary_links_source', 'user-menu');
if ($secondary_links) {
$menus = function_exists('menu_get_menus') ? menu_get_menus() : menu_list_system_menus();
$variables['secondary_menu_heading'] = $menus[$secondary_links];
}
else {
$variables['secondary_menu_heading'] = '';
}
}
/**
* Override or insert variables into the maintenance page template.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("maintenance_page" in this case.)
*/
function zen_preprocess_maintenance_page(&$variables, $hook) {
zen_preprocess_html($variables, $hook);
// There's nothing maintenance-related in zen_preprocess_page(). Yet.
//zen_preprocess_page($variables, $hook);
}
/**
* Override or insert variables into the maintenance page template.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("maintenance_page" in this case.)
*/
function zen_process_maintenance_page(&$variables, $hook) {
zen_process_html($variables, $hook);
// Ensure default regions get a variable. Theme authors often forget to remove
// a deleted region's variable in maintenance-page.tpl.
foreach (array('header', 'navigation', 'highlighted', 'help', 'content', 'sidebar_first', 'sidebar_second', 'footer', 'bottom') as $region) {
if (!isset($variables[$region])) {
$variables[$region] = '';
}
}
}
/**
* Override or insert variables into the node templates.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("node" in this case.)
*/
function zen_preprocess_node(&$variables, $hook) {
// Add $unpublished variable.
$variables['unpublished'] = (!$variables['status']) ? TRUE : FALSE;
// Add pubdate to submitted variable.
$variables['pubdate'] = '<time pubdate datetime="' . format_date($variables['node']->created, 'custom', 'c') . '">' . $variables['date'] . '</time>';
if ($variables['display_submitted']) {
$variables['submitted'] = t('Submitted by !username on !datetime', array('!username' => $variables['name'], '!datetime' => $variables['pubdate']));
}
// Add a class for the view mode.
if (!$variables['teaser']) {
$variables['classes_array'][] = 'view-mode-' . $variables['view_mode'];
}
// Add a class to show node is authored by current user.
if ($variables['uid'] && $variables['uid'] == $GLOBALS['user']->uid) {
$variables['classes_array'][] = 'node-by-viewer';
}
$variables['title_attributes_array']['class'][] = 'node__title';
$variables['title_attributes_array']['class'][] = 'node-title';
}
/**
* Override or insert variables into the comment templates.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("comment" in this case.)
*/
function zen_preprocess_comment(&$variables, $hook) {
// If comment subjects are disabled, don't display them.
if (variable_get('comment_subject_field_' . $variables['node']->type, 1) == 0) {
$variables['title'] = '';
}
// Add pubdate to submitted variable.
$variables['pubdate'] = '<time pubdate datetime="' . format_date($variables['comment']->created, 'custom', 'c') . '">' . $variables['created'] . '</time>';
$variables['submitted'] = t('!username replied on !datetime', array('!username' => $variables['author'], '!datetime' => $variables['pubdate']));
// Zebra striping.
if ($variables['id'] == 1) {
$variables['classes_array'][] = 'first';
}
if ($variables['id'] == $variables['node']->comment_count) {
$variables['classes_array'][] = 'last';
}
$variables['classes_array'][] = $variables['zebra'];
$variables['title_attributes_array']['class'][] = 'comment__title';
$variables['title_attributes_array']['class'][] = 'comment-title';
}
/**
* Preprocess variables for region.tpl.php
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("region" in this case.)
*/
function zen_preprocess_region(&$variables, $hook) {
// Sidebar regions get some extra classes and a common template suggestion.
if (strpos($variables['region'], 'sidebar_') === 0) {
$variables['classes_array'][] = 'column';
$variables['classes_array'][] = 'sidebar';
// Allow a region-specific template to override Zen's region--sidebar.
array_unshift($variables['theme_hook_suggestions'], 'region__sidebar');
}
// Use a template with no wrapper for the content region.
elseif ($variables['region'] == 'content') {
// Allow a region-specific template to override Zen's region--no-wrapper.
array_unshift($variables['theme_hook_suggestions'], 'region__no_wrapper');
}
// Add a SMACSS-style class for header region.
elseif ($variables['region'] == 'header') {
array_unshift($variables['classes_array'], 'header__region');
}
}
/**
* Override or insert variables into the block templates.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("block" in this case.)
*/
function zen_preprocess_block(&$variables, $hook) {
// Use a template with no wrapper for the page's main content.
if ($variables['block_html_id'] == 'block-system-main') {
$variables['theme_hook_suggestions'][] = 'block__no_wrapper';
}
// Classes describing the position of the block within the region.
if ($variables['block_id'] == 1) {
$variables['classes_array'][] = 'first';
}
// The last_in_region property is set in zen_page_alter().
if (isset($variables['block']->last_in_region)) {
$variables['classes_array'][] = 'last';
}
$variables['classes_array'][] = $variables['block_zebra'];
$variables['title_attributes_array']['class'][] = 'block__title';
$variables['title_attributes_array']['class'][] = 'block-title';
// Add Aria Roles via attributes.
switch ($variables['block']->module) {
case 'system':
switch ($variables['block']->delta) {
case 'main':
// Note: the "main" role goes in the page.tpl, not here.
break;
case 'help':
case 'powered-by':
$variables['attributes_array']['role'] = 'complementary';
break;
default:
// Any other "system" block is a menu block.
$variables['attributes_array']['role'] = 'navigation';
break;
}
break;
case 'menu':
case 'menu_block':
case 'blog':
case 'book':
case 'comment':
case 'forum':
case 'shortcut':
case 'statistics':
$variables['attributes_array']['role'] = 'navigation';
break;
case 'search':
$variables['attributes_array']['role'] = 'search';
break;
case 'help':
case 'aggregator':
case 'locale':
case 'poll':
case 'profile':
$variables['attributes_array']['role'] = 'complementary';
break;
case 'node':
switch ($variables['block']->delta) {
case 'syndicate':
$variables['attributes_array']['role'] = 'complementary';
break;
case 'recent':
$variables['attributes_array']['role'] = 'navigation';
break;
}
break;
case 'user':
switch ($variables['block']->delta) {
case 'login':
$variables['attributes_array']['role'] = 'form';
break;
case 'new':
case 'online':
$variables['attributes_array']['role'] = 'complementary';
break;
}
break;
}
}
/**
* Override or insert variables into the block templates.
*
* @param $variables
* An array of variables to pass to the theme template.
* @param $hook
* The name of the template being rendered ("block" in this case.)
*/
function zen_process_block(&$variables, $hook) {
// Drupal 7 should use a $title variable instead of $block->subject.
$variables['title'] = isset($variables['block']->subject) ? $variables['block']->subject : '';
}
/**
* Implements hook_page_alter().
*
* Look for the last block in the region. This is impossible to determine from
* within a preprocess_block function.
*
* @param $page
* Nested array of renderable elements that make up the page.
*/
function zen_page_alter(&$page) {
// Look in each visible region for blocks.
foreach (system_region_list($GLOBALS['theme'], REGIONS_VISIBLE) as $region => $name) {
if (!empty($page[$region])) {
// Find the last block in the region.
$blocks = array_reverse(element_children($page[$region]));
while ($blocks && !isset($page[$region][$blocks[0]]['#block'])) {
array_shift($blocks);
}
if ($blocks) {
$page[$region][$blocks[0]]['#block']->last_in_region = TRUE;
}
}
}
}
/**
* Implements hook_form_BASE_FORM_ID_alter().
*
* Prevent user-facing field styling from screwing up node edit forms by
* renaming the classes on the node edit form's field wrappers.
*/
function zen_form_node_form_alter(&$form, &$form_state, $form_id) {
// Remove if #1245218 is backported to D7 core.
foreach (array_keys($form) as $item) {
if (strpos($item, 'field_') === 0) {
if (!empty($form[$item]['#attributes']['class'])) {
foreach ($form[$item]['#attributes']['class'] as &$class) {
// Core bug: the field-type-text-with-summary class is used as a JS hook.
if ($class != 'field-type-text-with-summary' && strpos($class, 'field-type-') === 0 || strpos($class, 'field-name-') === 0) {
// Make the class different from that used in theme_field().
$class = 'form-' . $class;
}
}
}
}
}
}
/**
* Returns HTML for primary and secondary local tasks.
*
* @ingroup themeable
*/
function zen_menu_local_tasks(&$variables) {
$output = '';
// Add theme hook suggestions for tab type.
foreach (array('primary', 'secondary') as $type) {
if (!empty($variables[$type])) {
foreach (array_keys($variables[$type]) as $key) {
if (isset($variables[$type][$key]['#theme']) && ($variables[$type][$key]['#theme'] == 'menu_local_task' || is_array($variables[$type][$key]['#theme']) && in_array('menu_local_task', $variables[$type][$key]['#theme']))) {
$variables[$type][$key]['#theme'] = array('menu_local_task__' . $type, 'menu_local_task');
}
}
}
}
if (!empty($variables['primary'])) {
$variables['primary']['#prefix'] = '<h2 class="element-invisible">' . t('Primary tabs') . '</h2>';
$variables['primary']['#prefix'] .= '<ul class="tabs-primary tabs primary">';
$variables['primary']['#suffix'] = '</ul>';
$output .= drupal_render($variables['primary']);
}
if (!empty($variables['secondary'])) {
$variables['secondary']['#prefix'] = '<h2 class="element-invisible">' . t('Secondary tabs') . '</h2>';
$variables['secondary']['#prefix'] .= '<ul class="tabs-secondary tabs secondary">';
$variables['secondary']['#suffix'] = '</ul>';
$output .= drupal_render($variables['secondary']);
}
return $output;
}
/**
* Returns HTML for a single local task link.
*
* @ingroup themeable
*/
function zen_menu_local_task($variables) {
$type = $class = FALSE;
$link = $variables['element']['#link'];
$link_text = $link['title'];
// Check for tab type set in zen_menu_local_tasks().
if (is_array($variables['element']['#theme'])) {
$type = in_array('menu_local_task__secondary', $variables['element']['#theme']) ? 'tabs-secondary' : 'tabs-primary';
}
// Add SMACSS-style class names.
if ($type) {
$link['localized_options']['attributes']['class'][] = $type . '__tab-link';
$class = $type . '__tab';
}
if (!empty($variables['element']['#active'])) {
// Add text to indicate active tab for non-visual users.
$active = ' <span class="element-invisible">' . t('(active tab)') . '</span>';
// If the link does not contain HTML already, check_plain() it now.
// After we set 'html'=TRUE the link will not be sanitized by l().
if (empty($link['localized_options']['html'])) {
$link['title'] = check_plain($link['title']);
}
$link['localized_options']['html'] = TRUE;
$link_text = t('!local-task-title!active', array('!local-task-title' => $link['title'], '!active' => $active));
if (!$type) {
$class = 'active';
}
else {
$link['localized_options']['attributes']['class'][] = 'is-active';
$class .= ' is-active';
}
}
return '<li' . ($class ? ' class="' . $class . '"' : '') . '>' . l($link_text, $link['href'], $link['localized_options']) . "</li>\n";
}
/**
* Implements hook_preprocess_menu_link().
*/
function zen_preprocess_menu_link(&$variables, $hook) {
foreach ($variables['element']['#attributes']['class'] as $key => $class) {
switch ($class) {
// Menu module classes.
case 'expanded':
case 'collapsed':
case 'leaf':
case 'active':
// Menu block module classes.
case 'active-trail':
array_unshift($variables['element']['#attributes']['class'], 'is-' . $class);
break;
case 'has-children':
array_unshift($variables['element']['#attributes']['class'], 'is-parent');
break;
}
}
array_unshift($variables['element']['#attributes']['class'], 'menu__item');
if (empty($variables['element']['#localized_options']['attributes']['class'])) {
$variables['element']['#localized_options']['attributes']['class'] = array();
}
else {
foreach ($variables['element']['#localized_options']['attributes']['class'] as $key => $class) {
switch ($class) {
case 'active':
case 'active-trail':
array_unshift($variables['element']['#localized_options']['attributes']['class'], 'is-' . $class);
break;
}
}
}
array_unshift($variables['element']['#localized_options']['attributes']['class'], 'menu__link');
}
/**
* Returns HTML for status and/or error messages, grouped by type.
*/
function zen_status_messages($variables) {
$display = $variables['display'];
$output = '';
$status_heading = array(
'status' => t('Status message'),
'error' => t('Error message'),
'warning' => t('Warning message'),
);
foreach (drupal_get_messages($display) as $type => $messages) {
$output .= "<div class=\"messages--$type messages $type\">\n";
if (!empty($status_heading[$type])) {
$output .= '<h2 class="element-invisible">' . $status_heading[$type] . "</h2>\n";
}
if (count($messages) > 1) {
$output .= " <ul class=\"messages__list\">\n";
foreach ($messages as $message) {
$output .= ' <li class=\"messages__item\">' . $message . "</li>\n";
}
$output .= " </ul>\n";
}
else {
$output .= $messages[0];
}
$output .= "</div>\n";
}
return $output;
}
/**
* Returns HTML for a marker for new or updated content.
*/
function zen_mark($variables) {
$type = $variables['type'];
if ($type == MARK_NEW) {
return ' <mark class="new">' . t('new') . '</mark>';
}
elseif ($type == MARK_UPDATED) {
return ' <mark class="updated">' . t('updated') . '</mark>';
}
}
/**
* Alters the default Panels render callback so it removes the panel separator.
*/
function zen_panels_default_style_render_region($variables) {
return implode('', $variables['panes']);
}