Issue #1347236 by echoz and JohnAlbin: Convert page markup to HTML5
[project/zen.git] / template.php
CommitLineData
0c91c6b4 1<?php
0c91c6b4 2/**
8c1acf80 3 * @file
0b1037f4 4 * Contains theme override functions and preprocess functions for the Zen theme.
7c5fa196 5 *
0b1037f4 6 * IMPORTANT WARNING: DO NOT MODIFY THIS FILE.
28511ba8
J
7 *
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
960bac1c
TS
12 */
13
89804871 14// Auto-rebuild the theme registry during theme development.
74cf7b61 15if (theme_get_setting('zen_rebuild_registry') && !defined('MAINTENANCE_MODE')) {
c37ef432 16 // Rebuild .info data.
e28f5335 17 system_rebuild_theme_data();
c37ef432
J
18 // Rebuild theme registry.
19 drupal_theme_rebuild();
89804871 20}
7c5fa196 21
719059ea 22
4f5c1d0c
J
23/**
24 * Implements HOOK_theme().
52521ba9 25 */
4f5c1d0c 26function zen_theme(&$existing, $type, $theme, $path) {
fb2d48c9 27 include_once './' . drupal_get_path('theme', 'zen') . '/zen-internals/template.theme-registry.inc';
4f5c1d0c
J
28 return _zen_theme($existing, $type, $theme, $path);
29}
52521ba9 30
7c5fa196
J
31/**
32 * Return a themed breadcrumb trail.
7081db43 33 *
3f537ac5
J
34 * @param $variables
35 * - title: An optional string to be used as a navigational heading to give
36 * context for breadcrumb links to screen-reader users.
37 * - title_attributes_array: Array of HTML attributes for the title. It is
38 * flattened into a string within the theme function.
39 * - breadcrumb: An array containing the breadcrumb links.
7c5fa196
J
40 * @return
41 * A string containing the breadcrumb output.
7081db43 42 */
fb2d48c9
J
43function zen_breadcrumb($variables) {
44 $breadcrumb = $variables['breadcrumb'];
261a11a7
J
45 $output = '';
46
d60c8c02 47 // Determine if we are to display the breadcrumb.
59794464 48 $show_breadcrumb = theme_get_setting('zen_breadcrumb');
52521ba9 49 if ($show_breadcrumb == 'yes' || $show_breadcrumb == 'admin' && arg(0) == 'admin') {
59794464 50
d60c8c02 51 // Optionally get rid of the homepage link.
59794464 52 $show_breadcrumb_home = theme_get_setting('zen_breadcrumb_home');
52521ba9 53 if (!$show_breadcrumb_home) {
52521ba9
J
54 array_shift($breadcrumb);
55 }
59794464 56
d60c8c02 57 // Return the breadcrumb with separators.
52521ba9 58 if (!empty($breadcrumb)) {
59794464 59 $breadcrumb_separator = theme_get_setting('zen_breadcrumb_separator');
d60c8c02
J
60 $trailing_separator = $title = '';
61 if (theme_get_setting('zen_breadcrumb_title')) {
660c4307
J
62 $item = menu_get_item();
63 if (!empty($item['tab_parent'])) {
f134138f 64 // If we are on a non-default tab, use the tab's title.
261a11a7 65 $breadcrumb[] = check_plain($item['title']);
660c4307
J
66 }
67 else {
261a11a7 68 $breadcrumb[] = drupal_get_title();
b6656287 69 }
d60c8c02
J
70 }
71 elseif (theme_get_setting('zen_breadcrumb_trailing')) {
72 $trailing_separator = $breadcrumb_separator;
73 }
95b795f9
J
74
75 // Provide a navigational heading to give context for breadcrumb links to
3f537ac5
J
76 // screen-reader users.
77 if (empty($variables['title'])) {
78 $variables['title'] = t('You are here');
79 }
80 // Unless overridden by a preprocess function, make the heading invisible.
81 if (!isset($variables['title_attributes_array']['class'])) {
82 $variables['title_attributes_array']['class'][] = 'element-invisible';
83 }
95b795f9 84
261a11a7
J
85 // Build the breadcrumb trail.
86 $output = '<nav class="breadcrumb">';
87 $output .= '<h2' . drupal_attributes($variables['title_attributes_array']) . '>' . $variables['title'] . '</h2>';
88 $output .= '<ul><li>' . implode($breadcrumb_separator . '</li><li>', $breadcrumb) . $trailing_separator . '</li></ul>';
89 $output .= '</nav>';
52521ba9 90 }
7c5fa196 91 }
261a11a7
J
92
93 return $output;
7c5fa196
J
94}
95
4f5c1d0c 96/**
fa28a506 97 * Override or insert variables into the html template.
87695e28 98 *
b6e4708e 99 * @param $variables
0b1037f4 100 * An array of variables to pass to the theme template.
e6f4a124 101 * @param $hook
fa28a506 102 * The name of the template being rendered ("html" in this case.)
87695e28 103 */
b6e4708e 104function zen_preprocess_html(&$variables, $hook) {
190b3d2a 105 // Add paths needed for html5shim.
c6e9e869 106 $variables['base_path'] = base_path();
dd468c11 107 $variables['path_to_zen'] = drupal_get_path('theme', 'zen');
190b3d2a 108 $variables['add_html5_respond_js'] = theme_get_setting('zen_add_html5_respond_js');
c6e9e869 109
78d8d215
J
110 // If the user is silly and enables Zen as the theme, add some styles.
111 if ($GLOBALS['theme'] == 'zen') {
dd468c11 112 include_once './' . $variables['path_to_zen'] . '/zen-internals/template.zen.inc';
b6e4708e 113 _zen_preprocess_html($variables, $hook);
78d8d215 114 }
719059ea 115
104f8e30
J
116 // Attributes for html element.
117 $variables['html_attributes_array'] = array(
118 'lang' => $variables['language']->language,
119 'dir' => $variables['language']->dir,
120 );
121
e0a8f494
J
122 // Classes for body element. Allows advanced theming based on context
123 // (home page, node of certain type, etc.)
b6e4708e 124 if (!$variables['is_front']) {
363d1497 125 // Add unique class for each page.
9faf4798 126 $path = drupal_get_path_alias($_GET['q']);
363d1497 127 // Add unique class for each website section.
8357c010 128 list($section, ) = explode('/', $path, 2);
a2831350
J
129 $arg = explode('/', $_GET['q']);
130 if ($arg[0] == 'node') {
131 if ($arg[1] == 'add') {
363d1497 132 $section = 'node-add';
28511ba8 133 }
63231c44 134 elseif (isset($arg[2]) && is_numeric($arg[1]) && ($arg[2] == 'edit' || $arg[2] == 'delete')) {
a2831350 135 $section = 'node-' . $arg[2];
28511ba8
J
136 }
137 }
b6e4708e 138 $variables['classes_array'][] = drupal_html_class('section-' . $section);
960bac1c 139 }
2041a7c1 140 if (theme_get_setting('zen_wireframes')) {
b6e4708e 141 $variables['classes_array'][] = 'with-wireframes'; // Optionally add the wireframes style.
2041a7c1 142 }
711885f1 143 // Store the menu item since it has some useful information.
b6e4708e
J
144 $variables['menu_item'] = menu_get_item();
145 switch ($variables['menu_item']['page_callback']) {
711885f1
J
146 case 'views_page':
147 // Is this a Views page?
b6e4708e 148 $variables['classes_array'][] = 'page-views';
711885f1
J
149 break;
150 case 'page_manager_page_execute':
151 case 'page_manager_node_view':
152 case 'page_manager_contact_site':
153 // Is this a Panels page?
b6e4708e 154 $variables['classes_array'][] = 'page-panels';
711885f1
J
155 break;
156 }
aeec717d
J
157 $variables['skip_link_anchor'] = theme_get_setting('zen_skip_link_anchor');
158 $variables['skip_link_text'] = theme_get_setting('zen_skip_link_text');
e0a8f494 159}
7c5fa196 160
e0a8f494 161/**
104f8e30
J
162 * Override or insert variables into the html templates.
163 *
164 * @param $variables
165 * An array of variables to pass to the theme template.
166 * @param $hook
167 * The name of the template being rendered ("html" in this case.)
168 */
169function zen_process_html(&$variables, $hook) {
170 // Flatten out html_attributes.
171 $variables['html_attributes'] = drupal_attributes($variables['html_attributes_array']);
172}
173
174/**
abb4efe9
J
175 * Override or insert variables in the html_tag theme function.
176 */
177function zen_process_html_tag(&$variables) {
178 $tag = &$variables['element'];
179
180 if ($tag['#tag'] == 'style' || $tag['#tag'] == 'script') {
181 // Remove redundant type attribute and CDATA comments.
182 unset($tag['#attributes']['type'], $tag['#value_prefix'], $tag['#value_suffix']);
183
184 // Remove media="all" but leave others unaffected.
185 if (isset($tag['#attributes']['media']) && $tag['#attributes']['media'] === 'all') {
186 unset($tag['#attributes']['media']);
187 }
188 }
189}
190
191/**
1256823c
J
192 * Implement hook_html_head_alter().
193 */
194function zen_html_head_alter(&$head) {
195 // Simplify the meta tag for character encoding.
196 $head['system_meta_content_type']['#attributes'] = array('charset' => str_replace('text/html; charset=', '', $head['system_meta_content_type']['#attributes']['content']));
197}
198
199/**
551c3139
J
200 * Override or insert variables into the page template.
201 *
202 * @param $variables
203 * An array of variables to pass to the theme template.
204 * @param $hook
205 * The name of the template being rendered ("page" in this case.)
206 */
207function zen_preprocess_page(&$variables, $hook) {
208 // Find the title of the menu used by the secondary links.
209 $secondary_links = variable_get('menu_secondary_links_source', 'user-menu');
9d330c3b
J
210 if ($secondary_links) {
211 $menus = function_exists('menu_get_menus') ? menu_get_menus() : menu_list_system_menus();
212 $variables['secondary_menu_heading'] = $menus[$secondary_links];
213 }
214 else {
215 $variables['secondary_menu_heading'] = '';
216 }
551c3139
J
217}
218
219/**
3183d194
J
220 * Override or insert variables into the maintenance page template.
221 *
b6e4708e 222 * @param $variables
3183d194
J
223 * An array of variables to pass to the theme template.
224 * @param $hook
31c1fbc2 225 * The name of the template being rendered ("maintenance_page" in this case.)
3183d194 226 */
b6e4708e 227function zen_preprocess_maintenance_page(&$variables, $hook) {
f92efd05
J
228 // Add paths needed or html5shim.
229 $variables['base_path'] = base_path();
230 $variables['path_to_zen'] = drupal_get_path('theme', 'zen');
231
3183d194
J
232 // If Zen is the maintenance theme, add some styles.
233 if ($GLOBALS['theme'] == 'zen') {
fb2d48c9 234 include_once './' . drupal_get_path('theme', 'zen') . '/zen-internals/template.zen.inc';
b6e4708e 235 _zen_preprocess_html($variables, $hook);
3183d194 236 }
104f8e30
J
237
238 // Attributes for html element.
239 $variables['html_attributes_array'] = array(
240 'lang' => $variables['language']->language,
241 'dir' => $variables['language']->dir,
242 );
243}
244
245/**
246 * Override or insert variables into the maintenance page template.
247 *
248 * @param $variables
249 * An array of variables to pass to the theme template.
250 * @param $hook
251 * The name of the template being rendered ("maintenance_page" in this case.)
252 */
253function zen_process_maintenance_page(&$variables, $hook) {
254 // Flatten out html_attributes.
255 $variables['html_attributes'] = drupal_attributes($variables['html_attributes_array']);
3183d194
J
256}
257
258/**
0b1037f4 259 * Override or insert variables into the node templates.
e0a8f494 260 *
b6e4708e 261 * @param $variables
0b1037f4 262 * An array of variables to pass to the theme template.
e6f4a124 263 * @param $hook
0b1037f4 264 * The name of the template being rendered ("node" in this case.)
e0a8f494 265 */
b6e4708e 266function zen_preprocess_node(&$variables, $hook) {
e7ce78eb 267 // Add $unpublished variable.
b6e4708e 268 $variables['unpublished'] = (!$variables['status']) ? TRUE : FALSE;
911d5130 269
64d0d22d
J
270 // Add pubdate to submitted variable.
271 $variables['pubdate'] = '<time pubdate datetime="' . format_date($variables['node']->created, 'custom', 'c') . '">' . $variables['date'] . '</time>';
272 if ($variables['display_submitted']) {
273 $variables['submitted'] = t('Submitted by !username on !datetime', array('!username' => $variables['name'], '!datetime' => $variables['pubdate']));
274 }
275
bfea55ea
J
276 // Add a class for the view mode.
277 if (!$variables['teaser']) {
278 $variables['classes_array'][] = 'view-mode-' . $variables['view_mode'];
279 }
280
e7ce78eb 281 // Add a class to show node is authored by current user.
b6e4708e
J
282 if ($variables['uid'] && $variables['uid'] == $GLOBALS['user']->uid) {
283 $variables['classes_array'][] = 'node-by-viewer';
c91ed8a5 284 }
4e316b5a 285
b6e4708e 286 $variables['title_attributes_array']['class'][] = 'node-title';
e0a8f494 287}
7c5fa196 288
e0a8f494 289/**
0b1037f4 290 * Override or insert variables into the comment templates.
e0a8f494 291 *
b6e4708e 292 * @param $variables
0b1037f4 293 * An array of variables to pass to the theme template.
e6f4a124 294 * @param $hook
0b1037f4 295 * The name of the template being rendered ("comment" in this case.)
e0a8f494 296 */
b6e4708e 297function zen_preprocess_comment(&$variables, $hook) {
e8e12945 298 // If comment subjects are disabled, don't display them.
b6e4708e
J
299 if (variable_get('comment_subject_field_' . $variables['node']->type, 1) == 0) {
300 $variables['title'] = '';
e8e12945
J
301 }
302
64d0d22d
J
303 // Add pubdate to submitted variable.
304 $variables['pubdate'] = '<time pubdate datetime="' . format_date($variables['comment']->created, 'custom', 'c') . '">' . $variables['created'] . '</time>';
305 $variables['submitted'] = t('!username replied on !datetime', array('!username' => $variables['author'], '!datetime' => $variables['pubdate']));
306
e8e12945 307 // Zebra striping.
b6e4708e
J
308 if ($variables['id'] == 1) {
309 $variables['classes_array'][] = 'first';
e8e12945 310 }
b6e4708e
J
311 if ($variables['id'] == $variables['node']->comment_count) {
312 $variables['classes_array'][] = 'last';
e8e12945 313 }
b6e4708e 314 $variables['classes_array'][] = $variables['zebra'];
e8e12945 315
b6e4708e 316 $variables['title_attributes_array']['class'][] = 'comment-title';
960bac1c 317}
4dd0f1bf
JR
318
319/**
94f89279
J
320 * Preprocess variables for region.tpl.php
321 *
7f47e51d
J
322 * @param $variables
323 * An array of variables to pass to the theme template.
324 * @param $hook
325 * The name of the template being rendered ("region" in this case.)
94f89279 326 */
b6e4708e 327function zen_preprocess_region(&$variables, $hook) {
6b8155aa 328 // Sidebar regions get some extra classes and a common template suggestion.
b6e4708e
J
329 if (strpos($variables['region'], 'sidebar_') === 0) {
330 $variables['classes_array'][] = 'column';
331 $variables['classes_array'][] = 'sidebar';
6b8155aa 332 // Allow a region-specific template to override Zen's region--sidebar.
23e39483 333 array_unshift($variables['theme_hook_suggestions'], 'region__sidebar');
995d309c 334 }
67c4a567 335 // Use a template with no wrapper for the content region.
786931f7 336 elseif ($variables['region'] == 'content') {
23e39483
J
337 // Allow a region-specific template to override Zen's region--no-wrapper.
338 array_unshift($variables['theme_hook_suggestions'], 'region__no_wrapper');
786931f7 339 }
94f89279
J
340}
341
342/**
0b1037f4 343 * Override or insert variables into the block templates.
28511ba8 344 *
b6e4708e 345 * @param $variables
0b1037f4 346 * An array of variables to pass to the theme template.
e6f4a124 347 * @param $hook
0b1037f4 348 * The name of the template being rendered ("block" in this case.)
28511ba8 349 */
b6e4708e 350function zen_preprocess_block(&$variables, $hook) {
67c4a567 351 // Use a template with no wrapper for the page's main content.
786931f7 352 if ($variables['block_html_id'] == 'block-system-main') {
67c4a567 353 $variables['theme_hook_suggestions'][] = 'block__no_wrapper';
786931f7
J
354 }
355
288001f7 356 // Classes describing the position of the block within the region.
b6e4708e
J
357 if ($variables['block_id'] == 1) {
358 $variables['classes_array'][] = 'first';
288001f7
J
359 }
360 // The last_in_region property is set in zen_page_alter().
b6e4708e
J
361 if (isset($variables['block']->last_in_region)) {
362 $variables['classes_array'][] = 'last';
288001f7 363 }
b6e4708e 364 $variables['classes_array'][] = $variables['block_zebra'];
4e316b5a 365
b6e4708e 366 $variables['title_attributes_array']['class'][] = 'block-title';
3183d194 367}
a3f7ecae
J
368
369/**
370 * Override or insert variables into the block templates.
371 *
b6e4708e 372 * @param $variables
a3f7ecae
J
373 * An array of variables to pass to the theme template.
374 * @param $hook
375 * The name of the template being rendered ("block" in this case.)
376 */
b6e4708e 377function zen_process_block(&$variables, $hook) {
a3f7ecae 378 // Drupal 7 should use a $title variable instead of $block->subject.
b6e4708e 379 $variables['title'] = $variables['block']->subject;
a3f7ecae 380}
288001f7
J
381
382/**
383 * Implements hook_page_alter().
384 *
385 * Look for the last block in the region. This is impossible to determine from
386 * within a preprocess_block function.
387 *
388 * @param $page
389 * Nested array of renderable elements that make up the page.
390 */
391function zen_page_alter(&$page) {
392 // Look in each visible region for blocks.
393 foreach (system_region_list($GLOBALS['theme'], REGIONS_VISIBLE) as $region => $name) {
394 if (!empty($page[$region])) {
395 // Find the last block in the region.
396 $blocks = array_reverse(element_children($page[$region]));
397 while ($blocks && !isset($page[$region][$blocks[0]]['#block'])) {
398 array_shift($blocks);
399 }
400 if ($blocks) {
401 $page[$region][$blocks[0]]['#block']->last_in_region = TRUE;
402 }
403 }
404 }
405}
e63ff516
J
406
407/**
408 * Implements hook_form_BASE_FORM_ID_alter().
409 *
410 * Prevent user-facing field styling from screwing up node edit forms by
411 * renaming the classes on the node edit form's field wrappers.
412 */
413function zen_form_node_form_alter(&$form, &$form_state, $form_id) {
414 // Remove if #1245218 is backported to D7 core.
415 foreach (array_keys($form) as $item) {
416 if (strpos($item, 'field_') === 0) {
417 if (!empty($form[$item]['#attributes']['class'])) {
418 foreach ($form[$item]['#attributes']['class'] as &$class) {
419 if (strpos($class, 'field-type-') === 0 || strpos($class, 'field-name-') === 0) {
420 // Make the class different from that used in theme_field().
421 $class = 'form-' . $class;
422 }
423 }
424 }
425 }
426 }
427}