for the placement of the "header" region in
* page.tpl.php.
*
* By going to the administer > site building > blocks page you can choose
* which regions various blocks should be placed. New regions you define here
* will automatically show up in the drop-down list by their human readable name.
*
* @return
* An array of regions. The first array element will be used as the default
* region for themes. Each array element takes the format:
* variable_name => t('human readable name')
*/
function zen_regions() {
// Allow a sub-theme to define its own regions.
global $theme_key;
if ($theme_key != 'zen') {
$function = str_replace('-', '_', $theme_key) .'_regions';
if (function_exists($function)) {
return $function();
}
}
return array(
'left' => t('left sidebar'),
'right' => t('right sidebar'),
'navbar' => t('navigation bar'),
'content_top' => t('content top'),
'content_bottom' => t('content bottom'),
'header' => t('header'),
'footer' => t('footer'),
'closure_region' => t('closure'),
);
}
/**
* Return a themed breadcrumb trail.
*
* @param $breadcrumb
* An array containing the breadcrumb links.
* @return
* A string containing the breadcrumb output.
*/
function phptemplate_breadcrumb($breadcrumb) {
$show_breadcrumb = theme_get_setting('zen_breadcrumb');
$show_breadcrumb_home = theme_get_setting('zen_breadcrumb_home');
$breadcrumb_separator = theme_get_setting('zen_breadcrumb_separator');
$trailing_separator = (theme_get_setting('zen_breadcrumb_trailing') || theme_get_setting('zen_breadcrumb_title')) ? $breadcrumb_separator : '';
// Determine if we are to display the breadcrumb
if ($show_breadcrumb == 'yes' || $show_breadcrumb == 'admin' && arg(0) == 'admin') {
if (!$show_breadcrumb_home) {
// Optionally get rid of the homepage link
array_shift($breadcrumb);
}
if (!empty($breadcrumb)) {
// Return the breadcrumb with separators
return ''. implode($breadcrumb_separator, $breadcrumb) ."$trailing_separator
";
}
}
// Otherwise, return an empty string
return '';
}
/*
* CREATE OR MODIFY VARIABLES FOR YOUR THEME
*
* The most powerful function available to themers is _phptemplate_variables().
* It allows you to pass newly created variables to different template (tpl.php)
* files in your theme. Or even unset ones you don't want to use.
*
* It works by switching on the hook, or name of the theme function, such as:
* - page
* - node
* - comment
* - block
*
* By switching on this hook you can send different variables to page.tpl.php
* file, node.tpl.php (and any other derivative node template file, like
* node-forum.tpl.php), comment.tpl.php, and block.tpl.php.
*/
/**
* Intercept template variables
*
* @param $hook
* The name of the theme function being called (name of the .tpl.php file.)
* @param $vars
* A copy of the array containing the variables for the hook.
* @return
* The array containing additional variables to merge with $vars.
*/
function _phptemplate_variables($hook, $vars = array()) {
global $theme_key;
// Allow modules to add or alter variables.
// This construct ensures that we can keep a reference through
// call_user_func_array.
$args = array(&$vars, $hook);
foreach (module_implements('preprocess') as $module) {
if ($module != 'search') { // Don't call search_preprocess().
$function = $module .'_preprocess';
call_user_func_array($function, $args);
}
}
foreach (module_implements('preprocess_'. $hook) as $module) {
$function = $module .'_preprocess_'. $hook;
call_user_func_array($function, $args);
}
// Allow the Zen base theme to add or alter variables.
if ($theme_key != 'zen') {
zen_preprocess($vars, $hook);
$function = 'zen_preprocess_'. $hook;
if (function_exists($function)) {
$function($vars, $hook);
}
}
// Allow a sub-theme to add or alter variables.
$function = $theme_key .'_preprocess';
if (function_exists($function)) {
$function($vars, $hook);
}
else {
$function = 'phptemplate_preprocess';
if (function_exists($function)) {
$function($vars, $hook);
}
}
$function = $theme_key .'_preprocess_'. $hook;
if (function_exists($function)) {
$function($vars, $hook);
}
else {
$function = 'phptemplate_preprocess_'. $hook;
if (function_exists($function)) {
$function($vars, $hook);
}
}
// The following is a deprecated function included for backwards compatibility
// with Zen 5.x-0.8 and earlier. New sub-themes should not use this function.
if (function_exists('zen_variables')) {
$vars = zen_variables($hook, $vars);
}
_zen_hook($hook); // Add support for sub-theme template files.
return $vars;
}
/**
* Override or insert PHPTemplate variables into all templates.
*
* @param $vars
* A sequential array of variables to pass to the theme template.
* @param $hook
* The name of the theme function being called (name of the .tpl.php file.)
*/
function zen_preprocess(&$vars, $hook) {
// Get the currently logged in user
global $user;
// Set a new $is_admin variable. This is determined by looking at the
// currently logged in user and seeing if they are in the role 'admin'. The
// 'admin' role will need to have been created manually for this to work this
// variable is available to all templates.
$vars['is_admin'] = in_array('admin', $user->roles);
// Send a new variable, $logged_in, to tell us if the current user is
// logged in or out. An anonymous user has a user id of 0.
$vars['logged_in'] = ($user->uid > 0) ? TRUE : FALSE;
}
/**
* Override or insert PHPTemplate variables into the page templates.
*
* @param $vars
* A sequential array of variables to pass to the theme template.
*/
function zen_preprocess_page(&$vars) {
global $theme, $theme_key;
// Allow sub-themes to have an ie.css or wireframes.css file.
$vars['subtheme_directory'] = path_to_subtheme();
// These next lines add additional CSS files and redefine
// the $css and $styles variables available to your page template
if ($theme == $theme_key) { // If we're in the main theme
// Load the stylesheet for a liquid layout
if (theme_get_setting('zen_layout') == 'border-politics-liquid') {
drupal_add_css($vars['directory'] .'/layout-liquid.css', 'theme', 'all');
}
// Or load the stylesheet for a fixed width layout
else {
drupal_add_css($vars['directory'] .'/layout-fixed.css', 'theme', 'all');
}
drupal_add_css($vars['directory'] .'/html-elements.css', 'theme', 'all');
drupal_add_css($vars['directory'] .'/tabs.css', 'theme', 'all');
drupal_add_css($vars['directory'] .'/zen.css', 'theme', 'all');
// Avoid IE5 bug that always loads @import print stylesheets
$vars['head'] = zen_add_print_css($vars['directory'] .'/print.css');
}
// Optionally add the block editing styles.
if (theme_get_setting('zen_block_editing')) {
drupal_add_css($vars['directory'] .'/block-editing.css', 'theme', 'all');
}
// Optionally add the wireframes style.
if (theme_get_setting('zen_wireframes')) {
if ($vars['subtheme_directory'] && file_exists($vars['subtheme_directory'] .'/wireframes.css')) {
drupal_add_css($vars['subtheme_directory'] .'/wireframes.css', 'theme', 'all');
}
else {
drupal_add_css($vars['directory'] .'/wireframes.css', 'theme', 'all');
}
}
$vars['css'] = drupal_add_css();
$vars['styles'] = drupal_get_css();
// Add an optional title to the end of the breadcrumb.
if (theme_get_setting('zen_breadcrumb_title') && $vars['breadcrumb']) {
$vars['breadcrumb'] = substr($vars['breadcrumb'], 0, -6) . $vars['title'] .'';
}
// Don't display empty help from node_help().
if ($vars['help'] == "") {
$vars['help'] = '';
}
// Optionally disabled the primary and secondary links.
if (!theme_get_setting('zen_primary_links')) {
$vars['primary_links'] = '';
}
if (!theme_get_setting('zen_secondary_links')) {
$vars['secondary_links'] = '';
}
// Classes for body element. Allows advanced theming based on context
// (home page, node of certain type, etc.)
$classes = array();
$classes[] = ($vars['is_front']) ? 'front' : 'not-front';
$classes[] = ($vars['logged_in']) ? 'logged-in' : 'not-logged-in';
if ($vars['node']->type) {
// If on an individual node page, put the node type in the body classes
$classes[] = 'node-type-'. $vars['node']->type;
}
if ($vars['sidebar_left'] && $vars['sidebar_right']) {
$classes[] = 'two-sidebars';
}
elseif ($vars['sidebar_left']) {
$classes[] = 'one-sidebar sidebar-left';
}
elseif ($vars['sidebar_right']) {
$classes[] = 'one-sidebar sidebar-right';
}
else {
$classes[] = 'no-sidebars';
}
if (!$vars['is_front']) {
// Add unique class for each page.
$path = drupal_get_path_alias($_GET['q']);
$classes[] = zen_id_safe('page-'. $path);
// Add unique class for each website section.
list($section, ) = explode('/', $path, 2);
if (arg(0) == 'node') {
if (arg(1) == 'add') {
$section = 'node-add';
}
elseif (is_numeric(arg(1)) && (arg(2) == 'edit' || arg(2) == 'delete')) {
$section = 'node-'. arg(2);
}
}
$classes[] = zen_id_safe('section-'. $section);
}
$vars['body_classes_array'] = $classes;
$vars['body_classes'] = implode(' ', $classes); // Concatenate with spaces.
}
/**
* Override or insert PHPTemplate variables into the node templates.
*
* @param $vars
* A sequential array of variables to pass to the theme template.
*/
function zen_preprocess_node(&$vars) {
global $user;
// Special classes for nodes
$node_classes = array();
if ($vars['sticky']) {
$node_classes[] = 'sticky';
}
if (!$vars['node']->status) {
$node_classes[] = 'node-unpublished';
$vars['unpublished'] = TRUE;
}
else {
$vars['unpublished'] = FALSE;
}
if ($vars['node']->uid && $vars['node']->uid == $user->uid) {
// Node is authored by current user
$node_classes[] = 'node-mine';
}
if ($vars['teaser']) {
// Node is displayed as teaser
$node_classes[] = 'node-teaser';
}
// Class for node type: "node-type-page", "node-type-story", "node-type-my-custom-type", etc.
$node_classes[] = 'node-type-'. $vars['node']->type;
$vars['node_classes'] = implode(' ', $node_classes); // Concatenate with spaces
}
/**
* Override or insert PHPTemplate variables into the comment templates.
*
* @param $vars
* A sequential array of variables to pass to the theme template.
*/
function zen_preprocess_comment(&$vars) {
global $user;
// We load the node object that the current comment is attached to
$node = node_load($vars['comment']->nid);
// If the author of this comment is equal to the author of the node, we
// set a variable so we can theme this comment uniquely.
$vars['author_comment'] = $vars['comment']->uid == $node->uid ? TRUE : FALSE;
$comment_classes = array();
// Odd/even handling
static $comment_odd = TRUE;
$comment_classes[] = $comment_odd ? 'odd' : 'even';
$comment_odd = !$comment_odd;
if ($vars['comment']->status == COMMENT_NOT_PUBLISHED) {
$comment_classes[] = 'comment-unpublished';
$vars['unpublished'] = TRUE;
}
else {
$vars['unpublished'] = FALSE;
}
if ($vars['author_comment']) {
// Comment is by the node author
$comment_classes[] = 'comment-by-author';
}
if ($vars['comment']->uid == 0) {
// Comment is by an anonymous user
$comment_classes[] = 'comment-by-anon';
}
if ($user->uid && $vars['comment']->uid == $user->uid) {
// Comment was posted by current user
$comment_classes[] = 'comment-mine';
}
$vars['comment_classes'] = implode(' ', $comment_classes);
// If comment subjects are disabled, don't display 'em
if (variable_get('comment_subject_field', 1) == 0) {
$vars['title'] = '';
}
}
/**
* Override or insert PHPTemplate variables into the block templates.
*
* @param $vars
* A sequential array of variables to pass to the theme template.
*/
function zen_preprocess_block(&$vars) {
$block = $vars['block'];
// Special classes for blocks
$block_classes = array();
$block_classes[] = 'block-'. $block->module;
$block_classes[] = 'region-'. $vars['block_zebra'];
$block_classes[] = $vars['zebra'];
$block_classes[] = 'region-count-'. $vars['block_id'];
$block_classes[] = 'count-'. $vars['id'];
$vars['block_classes'] = implode(' ', $block_classes);
$vars['edit_links'] = '';
if (theme_get_setting('zen_block_editing') && user_access('administer blocks')) {
// Display 'edit block' for custom blocks
if ($block->module == 'block') {
$edit_links[] = l(''. t('edit block') .'', 'admin/build/block/configure/'. $block->module .'/'. $block->delta, array('title' => t('edit the content of this block'), 'class' => 'block-edit'), drupal_get_destination(), NULL, FALSE, TRUE);
}
// Display 'configure' for other blocks
else {
$edit_links[] = l(''. t('configure') .'', 'admin/build/block/configure/'. $block->module .'/'. $block->delta, array('title' => t('configure this block'), 'class' => 'block-config'), drupal_get_destination(), NULL, FALSE, TRUE);
}
// Display 'administer views' for views blocks
if ($block->module == 'views' && user_access('administer views')) {
$edit_links[] = l(''. t('edit view') .'', 'admin/build/views/'. $block->delta .'/edit', array('title' => t('edit the view that defines this block'), 'class' => 'block-edit-view'), drupal_get_destination(), 'edit-block', FALSE, TRUE);
}
// Display 'edit menu' for menu blocks
elseif (($block->module == 'menu' || ($block->module == 'user' && $block->delta == 1)) && user_access('administer menu')) {
$edit_links[] = l(''. t('edit menu') .'', 'admin/build/menu', array('title' => t('edit the menu that defines this block'), 'class' => 'block-edit-menu'), drupal_get_destination(), NULL, FALSE, TRUE);
}
$vars['edit_links_array'] = $edit_links;
$vars['edit_links'] = ''. implode(' ', $edit_links) .'
';
}
}
/**
* Converts a string to a suitable html ID attribute.
*
* http://www.w3.org/TR/html4/struct/global.html#h-7.5.2 specifies what makes a
* valid ID attribute in HTML. This function:
*
* - Ensure an ID starts with an alpha character by optionally adding an 'n'.
* - Replaces any character except A-Z, numbers, and underscores with dashes.
* - Converts entire string to lowercase.
*
* @param $string
* The string
* @return
* The converted string
*/
function zen_id_safe($string) {
// Replace with dashes anything that isn't A-Z, numbers, dashes, or underscores.
$string = strtolower(preg_replace('/[^a-zA-Z0-9_-]+/', '-', $string));
// If the first character is not a-z, add 'id' in front.
if (!ctype_lower($string{0})) { // Don't use ctype_alpha since its locale aware.
$string = 'id' . $string;
}
return $string;
}
/**
* Adds a print stylesheet to the page's $head variable.
*
* This is a work-around for a serious bug in IE5 in which it loads print
* stylesheets for screen display when using an @import method, Drupal's default
* method when using drupal_add_css().
*
* @param $url
* The URL of the print stylesheet
* @return
* All the rendered links for the $head variable
*/
function zen_add_print_css($url) {
global $base_path;
return drupal_set_html_head(
' 'stylesheet',
'href' => $base_path . $url,
'type' => 'text/css',
'media' => 'print',
)
) ." />\n"
);
}