Issue #2088687: Change base to init in documentation.
[project/zen.git] / template.php
index 3d7f4d5..33e5c2f 100644 (file)
@@ -1,14 +1,14 @@
 <?php
 /**
  * @file
- * Contains theme override functions and preprocess functions for the Zen theme.
+ * 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:
- *   http://drupal.org/node/193318
+ *   https://drupal.org/documentation/theme/zen
  */
 
 // Auto-rebuild the theme registry during theme development.
@@ -56,7 +56,7 @@ function zen_breadcrumb($variables) {
 
     // Return the breadcrumb with separators.
     if (!empty($breadcrumb)) {
-      $breadcrumb_separator = theme_get_setting('zen_breadcrumb_separator');
+      $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();
@@ -107,10 +107,12 @@ 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');
-  $html5_respond_meta = 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['add_responsive_meta'] = in_array('meta', $html5_respond_meta);
+  // 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') {
@@ -124,15 +126,41 @@ function zen_preprocess_html(&$variables, $hook) {
     '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'] = theme_get_setting('zen_skip_link_anchor');
+  $variables['skip_link_text'] = 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'] && $hook == 'html') {
+  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') {
+    if ($arg[0] == 'node' && isset($arg[1])) {
       if ($arg[1] == 'add') {
         $section = 'node-add';
       }
@@ -146,25 +174,31 @@ function zen_preprocess_html(&$variables, $hook) {
     $variables['classes_array'][] = 'with-wireframes'; // Optionally add the wireframes style.
   }
   // Store the menu item since it has some useful information.
-  if ($hook == 'html') {
-    $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_page_execute':
-        case 'page_manager_node_view':
-        case 'page_manager_contact_site':
-          // Is this a Panels page?
-          $variables['classes_array'][] = 'page-panels';
-          break;
-      }
+  $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;
     }
   }
-  $variables['skip_link_anchor'] = theme_get_setting('zen_skip_link_anchor');
-  $variables['skip_link_text'] = theme_get_setting('zen_skip_link_text');
 }
 
 /**
@@ -202,7 +236,9 @@ function zen_process_html_tag(&$variables) {
  */
 function zen_html_head_alter(&$head) {
   // Simplify the meta tag for character encoding.
-  $head['system_meta_content_type']['#attributes'] = array('charset' => str_replace('text/html; charset=', '', $head['system_meta_content_type']['#attributes']['content']));
+  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']));
+  }
 }
 
 /**
@@ -235,6 +271,8 @@ function zen_preprocess_page(&$variables, $hook) {
  */
 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);
 }
 
 /**
@@ -284,6 +322,7 @@ function zen_preprocess_node(&$variables, $hook) {
     $variables['classes_array'][] = 'node-by-viewer';
   }
 
+  $variables['title_attributes_array']['class'][] = 'node__title';
   $variables['title_attributes_array']['class'][] = 'node-title';
 }
 
@@ -314,6 +353,7 @@ function zen_preprocess_comment(&$variables, $hook) {
   }
   $variables['classes_array'][] = $variables['zebra'];
 
+  $variables['title_attributes_array']['class'][] = 'comment__title';
   $variables['title_attributes_array']['class'][] = 'comment-title';
 }
 
@@ -338,6 +378,10 @@ function zen_preprocess_region(&$variables, $hook) {
     // 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');
+  }
 }
 
 /**
@@ -364,6 +408,7 @@ function zen_preprocess_block(&$variables, $hook) {
   }
   $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.
@@ -437,7 +482,7 @@ function zen_preprocess_block(&$variables, $hook) {
  */
 function zen_process_block(&$variables, $hook) {
   // Drupal 7 should use a $title variable instead of $block->subject.
-  $variables['title'] = $variables['block']->subject;
+  $variables['title'] = isset($variables['block']->subject) ? $variables['block']->subject : '';
 }
 
 /**
@@ -477,7 +522,8 @@ function zen_form_node_form_alter(&$form, &$form_state, $form_id) {
     if (strpos($item, 'field_') === 0) {
       if (!empty($form[$item]['#attributes']['class'])) {
         foreach ($form[$item]['#attributes']['class'] as &$class) {
-          if (strpos($class, 'field-type-') === 0 || strpos($class, 'field-name-') === 0) {
+          // 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;
           }
@@ -486,3 +532,174 @@ function zen_form_node_form_alter(&$form, &$form_state, $form_id) {
     }
   }
 }
+
+/**
+ * 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']);
+}