Newer
Older
Dries Buytaert
committed
// $Id$
* The theme system, which controls the output of Drupal.
*
* The theme system allows for nearly all output of the Drupal system to be
* customized by user themes.
*/
Dries Buytaert
committed
/**
Dries Buytaert
committed
* @name Content markers
* @{
* Markers used by theme_mark() and node_mark() to designate content.
* @see theme_mark(), node_mark()
*/
/**
* Mark content as read.
*/
define('MARK_READ', 0);
/**
* Mark content as being new.
*/
define('MARK_NEW', 1);
/**
* Mark content as being updated.
*/
Dries Buytaert
committed
define('MARK_UPDATED', 2);
Dries Buytaert
committed
/**
* @} End of "Content markers".
*/
Dries Buytaert
committed
/**
* Determines if a theme is available to use.
*
* @param $theme
Angie Byron
committed
* Either the name of a theme or a full theme object.
*
Dries Buytaert
committed
* @return
* Boolean TRUE if the theme is enabled or is the site administration theme;
* FALSE otherwise.
*/
function drupal_theme_access($theme) {
Angie Byron
committed
if (is_object($theme)) {
return _drupal_theme_access($theme);
}
else {
$themes = list_themes();
return isset($themes[$theme]) && _drupal_theme_access($themes[$theme]);
}
}
/**
* Helper function for determining access to a theme.
*
* @see drupal_theme_access()
*/
function _drupal_theme_access($theme) {
Dries Buytaert
committed
$admin_theme = variable_get('admin_theme');
return !empty($theme->status) || ($admin_theme && $theme->name == $admin_theme);
}
Dries Buytaert
committed
function drupal_theme_initialize() {
Dries Buytaert
committed
global $theme, $user, $theme_key;
Dries Buytaert
committed
// If $theme is already set, assume the others are set, too, and do nothing
if (isset($theme)) {
return;
}
drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
// Only select the user selected theme if it is available in the
Dries Buytaert
committed
// list of themes that can be accessed.
Angie Byron
committed
$theme = !empty($user->theme) && drupal_theme_access($user->theme) ? $user->theme : variable_get('theme_default', 'garland');
Angie Byron
committed
// Allow modules to override the theme. Validation has already been performed
// inside menu_get_custom_theme(), so we do not need to check it again here.
Dries Buytaert
committed
$custom_theme = menu_get_custom_theme();
Angie Byron
committed
$theme = !empty($custom_theme) ? $custom_theme : $theme;
// Store the identifier for retrieving theme settings with.
$theme_key = $theme;
Dries Buytaert
committed
// Find all our ancestor themes and put them in an array.
$base_theme = array();
$ancestor = $theme;
while ($ancestor && isset($themes[$ancestor]->base_theme)) {
Gábor Hojtsy
committed
$base_theme[] = $new_base_theme = $themes[$themes[$ancestor]->base_theme];
$ancestor = $themes[$ancestor]->base_theme;
Dries Buytaert
committed
}
Dries Buytaert
committed
_drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
Angie Byron
committed
// Themes can have alter functions, so reset the drupal_alter() cache.
drupal_static_reset('drupal_alter');
Dries Buytaert
committed
}
/**
* Initialize the theme system given already loaded information. This
* function is useful to initialize a theme when no database is present.
*
* @param $theme
* An object with the following information:
* filename
* The .info file for this theme. The 'path' to
* the theme will be in this file's directory. (Required)
* owner
* The path to the .theme file or the .engine file to load for
* the theme. (Required)
* stylesheet
* The primary stylesheet for the theme. (Optional)
* engine
* The name of theme engine to use. (Optional)
* @param $base_theme
* An optional array of objects that represent the 'base theme' if the
* theme is meant to be derivative of another theme. It requires
* the same information as the $theme object. It should be in
* 'oldest first' order, meaning the top level of the chain will
* be first.
* @param $registry_callback
* The callback to invoke to set the theme registry.
Dries Buytaert
committed
*/
Dries Buytaert
committed
function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callback = '_theme_load_registry') {
Dries Buytaert
committed
global $theme_info, $base_theme_info, $theme_engine, $theme_path;
$theme_info = $theme;
$base_theme_info = $base_theme;
$theme_path = dirname($theme->filename);
Gábor Hojtsy
committed
// Prepare stylesheets from this theme as well as all ancestor themes.
// We work it this way so that we can have child themes override parent
// theme stylesheets easily.
$final_stylesheets = array();
// Grab stylesheets from base theme
foreach ($base_theme as $base) {
if (!empty($base->stylesheets)) {
foreach ($base->stylesheets as $media => $stylesheets) {
foreach ($stylesheets as $name => $stylesheet) {
$final_stylesheets[$media][$name] = $stylesheet;
}
}
}
}
Gábor Hojtsy
committed
// Add stylesheets used by this theme.
if (!empty($theme->stylesheets)) {
foreach ($theme->stylesheets as $media => $stylesheets) {
Gábor Hojtsy
committed
foreach ($stylesheets as $name => $stylesheet) {
$final_stylesheets[$media][$name] = $stylesheet;
}
}
}
// And now add the stylesheets properly
foreach ($final_stylesheets as $media => $stylesheets) {
foreach ($stylesheets as $stylesheet) {
Dries Buytaert
committed
drupal_add_css($stylesheet, array('weight' => CSS_THEME, 'media' => $media));
Gábor Hojtsy
committed
}
}
// Do basically the same as the above for scripts
$final_scripts = array();
// Grab scripts from base theme
foreach ($base_theme as $base) {
if (!empty($base->scripts)) {
foreach ($base->scripts as $name => $script) {
$final_scripts[$name] = $script;
Dries Buytaert
committed
}
Gábor Hojtsy
committed
Gábor Hojtsy
committed
// Add scripts used by this theme.
if (!empty($theme->scripts)) {
Gábor Hojtsy
committed
foreach ($theme->scripts as $name => $script) {
$final_scripts[$name] = $script;
Gábor Hojtsy
committed
}
}
Gábor Hojtsy
committed
// Add scripts used by this theme.
foreach ($final_scripts as $script) {
Angie Byron
committed
drupal_add_js($script, array('weight' => JS_THEME));
Gábor Hojtsy
committed
}
Dries Buytaert
committed
$theme_engine = NULL;
// Initialize the theme.
if (isset($theme->engine)) {
// Include the engine.
Angie Byron
committed
include_once DRUPAL_ROOT . '/' . $theme->owner;
Dries Buytaert
committed
$theme_engine = $theme->engine;
if (function_exists($theme_engine . '_init')) {
Dries Buytaert
committed
foreach ($base_theme as $base) {
call_user_func($theme_engine . '_init', $base);
Dries Buytaert
committed
}
call_user_func($theme_engine . '_init', $theme);
Dries Buytaert
committed
}
}
else {
// include non-engine theme files
foreach ($base_theme as $base) {
// Include the theme file or the engine.
if (!empty($base->owner)) {
Angie Byron
committed
include_once DRUPAL_ROOT . '/' . $base->owner;
Dries Buytaert
committed
}
}
// and our theme gets one too.
if (!empty($theme->owner)) {
Angie Byron
committed
include_once DRUPAL_ROOT . '/' . $theme->owner;
if (function_exists($registry_callback)) {
Dries Buytaert
committed
$registry_callback($theme, $base_theme, $theme_engine);
}
Dries Buytaert
committed
/**
* Get the theme registry.
* @return
* The theme registry array if it has been stored in memory, NULL otherwise.
Dries Buytaert
committed
*/
function theme_get_registry() {
return _theme_set_registry();
Dries Buytaert
committed
}
/**
* Store the theme registry in memory.
* @param $registry
* A registry array as returned by _theme_build_registry()
* The theme registry array stored in memory
Dries Buytaert
committed
*/
function _theme_set_registry($registry = NULL) {
static $theme_registry = NULL;
if (isset($registry)) {
$theme_registry = $registry;
}
return $theme_registry;
Dries Buytaert
committed
}
/**
* Get the theme_registry cache from the database; if it doesn't exist, build it.
Dries Buytaert
committed
*
* @param $theme
* The loaded $theme object as returned by list_themes().
Dries Buytaert
committed
* @param $base_theme
* An array of loaded $theme objects representing the ancestor themes in
* oldest first order.
* @param theme_engine
* The name of the theme engine.
Dries Buytaert
committed
*/
Dries Buytaert
committed
function _theme_load_registry($theme, $base_theme = NULL, $theme_engine = NULL) {
// Check the theme registry cache; if it exists, use it.
$cache = cache_get("theme_registry:$theme->name", 'cache');
Dries Buytaert
committed
if (isset($cache->data)) {
Dries Buytaert
committed
$registry = $cache->data;
Dries Buytaert
committed
_theme_set_registry($registry);
Dries Buytaert
committed
}
else {
Dries Buytaert
committed
// If not, build one and cache it.
$registry = _theme_build_registry($theme, $base_theme, $theme_engine);
Dries Buytaert
committed
// Only persist this registry if all modules are loaded. This assures a
Dries Buytaert
committed
// complete set of theme hooks.
Angie Byron
committed
if (module_load_all(NULL)) {
Dries Buytaert
committed
_theme_save_registry($theme, $registry);
_theme_set_registry($registry);
}
Dries Buytaert
committed
}
}
/**
* Write the theme_registry cache into the database.
*/
function _theme_save_registry($theme, $registry) {
Dries Buytaert
committed
cache_set("theme_registry:$theme->name", $registry);
Dries Buytaert
committed
}
/**
* Force the system to rebuild the theme registry; this should be called
* when modules are added to the system, or when a dynamic system needs
* to add more theme hooks.
*/
function drupal_theme_rebuild() {
Dries Buytaert
committed
cache_clear_all('theme_registry', 'cache', TRUE);
}
/**
* Process a single implementation of hook_theme().
Dries Buytaert
committed
*
* @param $cache
* The theme registry that will eventually be cached; It is an associative
* array keyed by theme hooks, whose values are associative arrays describing
* the hook:
* - 'type': The passed in $type.
* - 'theme path': The passed in $path.
* - 'function': The name of the function generating output for this theme
* hook. Either defined explicitly in hook_theme() or, if neither 'function'
* nor 'template' is defined, then the default theme function name is used.
* The default theme function name is the theme hook prefixed by either
* 'theme_' for modules or '$name_' for everything else. If 'function' is
* defined, 'template' is not used.
* - 'template': The filename of the template generating output for this
* theme hook. The template is in the directory defined by the 'path' key of
* hook_theme() or defaults to $path.
* - 'variables': The variables for this theme hook as defined in
* hook_theme(). If there is more than one implementation and 'variables' is
* not specified in a later one, then the previous definition is kept.
* - 'render element': The renderable element for this theme hook as defined
* in hook_theme(). If there is more than one implementation and
* 'render element' is not specified in a later one, then the previous
* definition is kept.
* - 'preprocess functions': See theme() for detailed documentation.
Angie Byron
committed
* - 'process functions': See theme() for detailed documentation.
* @param $name
* The name of the module, theme engine, base theme engine, theme or base
* theme implementing hook_theme().
* @param $type
* One of 'module', 'theme_engine', 'base_theme_engine', 'theme', or
* 'base_theme'. Unlike regular hooks that can only be implemented by modules,
* each of these can implement hook_theme(). _theme_process_registry() is
* called in aforementioned order and new entries override older ones. For
* example, if a theme hook is both defined by a module and a theme, then the
* definition in the theme will be used.
* @param $theme
* The loaded $theme object as returned from list_themes().
* @param $path
* The directory where $name is. For example, modules/system or
* themes/garland.
*
* @see theme()
* @see _theme_process_registry()
* @see hook_theme()
* @see list_themes()
Dries Buytaert
committed
*/
Dries Buytaert
committed
function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
$result = array();
$function = $name . '_theme';
Angie Byron
committed
Angie Byron
committed
// Processor functions work in two distinct phases with the process
Angie Byron
committed
// functions always being executed after the preprocess functions.
Angie Byron
committed
$variable_process_phases = array(
Angie Byron
committed
'preprocess functions' => 'preprocess',
'process functions' => 'process',
);
if (function_exists($function)) {
Dries Buytaert
committed
$result = $function($cache, $type, $theme, $path);
Dries Buytaert
committed
foreach ($result as $hook => $info) {
$result[$hook]['type'] = $type;
Dries Buytaert
committed
$result[$hook]['theme path'] = $path;
Dries Buytaert
committed
// if function and file are left out, default to standard naming
// conventions.
if (!isset($info['template']) && !isset($info['function'])) {
$result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
Dries Buytaert
committed
}
// If a path is set in the info, use what was set. Otherwise use the
// default path. This is mostly so system.module can declare theme
// functions on behalf of core .include files.
// All files are included to be safe. Conditionally included
// files can prevent them from getting registered.
if (isset($cache[$hook]['includes'])) {
$result[$hook]['includes'] = $cache[$hook]['includes'];
}
if (isset($info['file'])) {
$include_file = isset($info['path']) ? $info['path'] : $path;
$include_file .= '/' . $info['file'];
include_once DRUPAL_ROOT . '/' . $include_file;
$result[$hook]['includes'][] = $include_file;
}
// If 'variables' have been defined previously, carry them forward.
Dries Buytaert
committed
// This should happen if a theme overrides a Drupal defined theme
// function, for example.
if (!isset($info['variables']) && isset($cache[$hook]['variables'])) {
$result[$hook]['variables'] = $cache[$hook]['variables'];
}
// Same for 'render element'.
if (!isset($info['render element']) && isset($cache[$hook]['render element'])) {
$result[$hook]['render element'] = $cache[$hook]['render element'];
Dries Buytaert
committed
}
Angie Byron
committed
// The following apply only to theming hooks implemented as templates.
if (isset($info['template'])) {
// Prepend the current theming path when none is set.
if (!isset($info['path'])) {
$result[$hook]['template'] = $path . '/' . $info['template'];
Gábor Hojtsy
committed
}
Angie Byron
committed
}
Angie Byron
committed
Angie Byron
committed
// Allow variable processors for all theming hooks, whether the hook is
// implemented as a template or as a function.
foreach ($variable_process_phases as $phase_key => $phase) {
// Check for existing variable processors. Ensure arrayness.
if (!isset($info[$phase_key]) || !is_array($info[$phase_key])) {
$info[$phase_key] = array();
$prefixes = array();
if ($type == 'module') {
// Default variable processor prefix.
$prefixes[] = 'template';
// Add all modules so they can intervene with their own variable
// processors. This allows them to provide variable processors even
// if they are not the owner of the current hook.
$prefixes += module_list();
}
elseif ($type == 'theme_engine' || $type == 'base_theme_engine') {
// Theme engines get an extra set that come before the normally
// named variable processors.
$prefixes[] = $name . '_engine';
// The theme engine registers on behalf of the theme using the
// theme's name.
$prefixes[] = $theme;
Dries Buytaert
committed
}
Angie Byron
committed
else {
// This applies when the theme manually registers their own variable
// processors.
$prefixes[] = $name;
Dries Buytaert
committed
}
Angie Byron
committed
foreach ($prefixes as $prefix) {
// Only use non-hook-specific variable processors for theming hooks
// implemented as templates. @see theme().
if (isset($info['template']) && function_exists($prefix . '_' . $phase)) {
$info[$phase_key][] = $prefix . '_' . $phase;
}
if (function_exists($prefix . '_' . $phase . '_' . $hook)) {
$info[$phase_key][] = $prefix . '_' . $phase . '_' . $hook;
}
Angie Byron
committed
}
Dries Buytaert
committed
}
Angie Byron
committed
// Check for the override flag and prevent the cached variable
// processors from being used. This allows themes or theme engines to
// remove variable processors set earlier in the registry build.
if (!empty($info['override ' . $phase_key])) {
// Flag not needed inside the registry.
unset($result[$hook]['override ' . $phase_key]);
}
elseif (isset($cache[$hook][$phase_key]) && is_array($cache[$hook][$phase_key])) {
$info[$phase_key] = array_merge($cache[$hook][$phase_key], $info[$phase_key]);
}
$result[$hook][$phase_key] = $info[$phase_key];
Dries Buytaert
committed
}
Dries Buytaert
committed
}
Dries Buytaert
committed
// Merge the newly created theme hooks into the existing cache.
Dries Buytaert
committed
$cache = array_merge($cache, $result);
}
Angie Byron
committed
// Let themes have variable processors even if they didn't register a template.
if ($type == 'theme' || $type == 'base_theme') {
foreach ($cache as $hook => $info) {
Angie Byron
committed
// Check only if not registered by the theme or engine.
if (empty($result[$hook])) {
foreach ($variable_process_phases as $phase_key => $phase) {
Angie Byron
committed
if (!isset($info[$phase_key])) {
$cache[$hook][$phase_key] = array();
}
Angie Byron
committed
// Only use non-hook-specific variable processors for theming hooks
// implemented as templates. @see theme().
if (isset($info['template']) && function_exists($name . '_' . $phase)) {
$cache[$hook][$phase_key][] = $name . '_' . $phase;
Angie Byron
committed
}
Angie Byron
committed
if (function_exists($name . '_' . $phase . '_' . $hook)) {
$cache[$hook][$phase_key][] = $name . '_' . $phase . '_' . $hook;
Angie Byron
committed
$cache[$hook]['theme path'] = $path;
Angie Byron
committed
}
// Ensure uniqueness.
$cache[$hook][$phase_key] = array_unique($cache[$hook][$phase_key]);
}
}
}
}
Dries Buytaert
committed
}
/**
* Rebuild the theme registry cache.
Dries Buytaert
committed
*
* @param $theme
* The loaded $theme object as returned by list_themes().
Dries Buytaert
committed
* @param $base_theme
* An array of loaded $theme objects representing the ancestor themes in
* oldest first order.
* @param theme_engine
* The name of the theme engine.
Dries Buytaert
committed
*/
Dries Buytaert
committed
function _theme_build_registry($theme, $base_theme, $theme_engine) {
Dries Buytaert
committed
$cache = array();
Dries Buytaert
committed
// First, process the theme hooks advertised by modules. This will
// serve as the basic registry.
Dries Buytaert
committed
foreach (module_implements('theme') as $module) {
Dries Buytaert
committed
_theme_process_registry($cache, $module, 'module', $module, drupal_get_path('module', $module));
}
// Process each base theme.
foreach ($base_theme as $base) {
// If the base theme uses a theme engine, process its hooks.
Dries Buytaert
committed
$base_path = dirname($base->filename);
if ($theme_engine) {
_theme_process_registry($cache, $theme_engine, 'base_theme_engine', $base->name, $base_path);
}
_theme_process_registry($cache, $base->name, 'base_theme', $base->name, $base_path);
Dries Buytaert
committed
}
Dries Buytaert
committed
// And then the same thing, but for the theme.
Dries Buytaert
committed
if ($theme_engine) {
Dries Buytaert
committed
_theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
Dries Buytaert
committed
}
Dries Buytaert
committed
// Finally, hooks provided by the theme itself.
_theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
Dries Buytaert
committed
Angie Byron
committed
// Let modules alter the registry.
Gábor Hojtsy
committed
drupal_alter('theme_registry', $cache);
Angie Byron
committed
// Optimize the registry to not have empty arrays for functions.
foreach ($cache as $hook => $info) {
foreach (array('preprocess functions', 'process functions') as $phase) {
if (empty($info[$phase])) {
unset($cache[$hook][$phase]);
}
}
}
Dries Buytaert
committed
return $cache;
}
* Return a list of all currently available themes.
* Retrieved from the database, if available and the site is not in maintenance
* mode; otherwise compiled freshly from the filesystem.
*
* Whether to reload the list of themes from the database. Defaults to FALSE.
* An associative array of the currently available themes. The keys are the
* names of the themes and the values are objects having the following
* properties:
* - 'filename': The name of the .info file.
* - 'name': The name of the theme.
* - 'status': 1 for enabled, 0 for disabled themes.
* - 'info': The contents of the .info file.
* - 'stylesheets': A two dimensional array, using the first key for the
* 'media' attribute (e.g. 'all'), the second for the name of the file
* (e.g. style.css). The value is a complete filepath
* (e.g. themes/garland/style.css).
* - 'scripts': An associative array of JavaScripts, using the filename as key
* and the complete filepath as value.
* - 'engine': The name of the theme engine.
* - 'base theme': The name of the base theme.
function list_themes($refresh = FALSE) {
$list = &drupal_static(__FUNCTION__, array());
Dries Buytaert
committed
system_list_reset();
$themes = array();
// Extract from the database only when it is available.
// Also check that the site is not in the middle of an install or update.
Angie Byron
committed
if (!defined('MAINTENANCE_MODE') && db_is_active()) {
Dries Buytaert
committed
foreach (system_list('theme') as $theme) {
if (file_exists($theme->filename)) {
$theme->info = unserialize($theme->info);
$themes[] = $theme;
Dries Buytaert
committed
}
}
}
else {
// Scan the installation when the database should not be read.
Angie Byron
committed
$themes = _system_rebuild_theme_data();
}
foreach ($themes as $theme) {
foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
foreach ($stylesheets as $stylesheet => $path) {
Dries Buytaert
committed
$theme->stylesheets[$media][$stylesheet] = $path;
Gábor Hojtsy
committed
}
}
foreach ($theme->info['scripts'] as $script => $path) {
if (file_exists($path)) {
$theme->scripts[$script] = $path;
Dries Buytaert
committed
}
if (isset($theme->info['engine'])) {
$theme->engine = $theme->info['engine'];
if (isset($theme->info['base theme'])) {
$theme->base_theme = $theme->info['base theme'];
}
// Status is normally retrieved from the database. Add zero values when
// read from the installation directory to prevent notices.
if (!isset($theme->status)) {
$theme->status = 0;
}
$list[$theme->name] = $theme;
Dries Buytaert
committed
* Generate the themed output.
*
* All requests for theme hooks must go through this function. It examines
* the request and routes it to the appropriate theme function. The theme
* registry is checked to determine which implementation to use, which may
* be a function or a template.
*
Dries Buytaert
committed
* If the implementation is a template, the following functions may be used to
* modify the $variables array. They are processed in two distinct phases;
* "preprocess" and "process" functions. The order listed here is the order in
* which they execute.
Gábor Hojtsy
committed
* - template_preprocess(&$variables)
* This sets a default set of variables for all template implementations.
Dries Buytaert
committed
*
Gábor Hojtsy
committed
* - template_preprocess_HOOK(&$variables)
* This is the first preprocessor called specific to the hook; it should be
* implemented by the module that registers it.
Dries Buytaert
committed
*
Gábor Hojtsy
committed
* - MODULE_preprocess(&$variables)
* This will be called for all templates; it should only be used if there
* is a real need. It's purpose is similar to template_preprocess().
Dries Buytaert
committed
*
Gábor Hojtsy
committed
* - MODULE_preprocess_HOOK(&$variables)
* This is for modules that want to alter or provide extra variables for
* theming hooks not registered to itself. For example, if a module named
Angie Byron
committed
* "foo" wanted to alter the $classes_array variable for the hook "node" a
Gábor Hojtsy
committed
* preprocess function of foo_preprocess_node() can be created to intercept
* and alter the variable.
Dries Buytaert
committed
*
Gábor Hojtsy
committed
* - ENGINE_engine_preprocess(&$variables)
* This function should only be implemented by theme engines and exists
* so that it can set necessary variables for all hooks.
Dries Buytaert
committed
*
Gábor Hojtsy
committed
* - ENGINE_engine_preprocess_HOOK(&$variables)
* This is the same as the previous function, but it is called for a single
* theming hook.
*
* - THEME_preprocess(&$variables)
Angie Byron
committed
* This is for themes that want to alter or provide extra variables. For
Angie Byron
committed
* example, if a theme named "foo" wanted to alter the $classes_array variable
* for the hook "node" a preprocess function of foo_preprocess_node() can be
Angie Byron
committed
* created to intercept and alter the variable.
Dries Buytaert
committed
*
Gábor Hojtsy
committed
* - THEME_preprocess_HOOK(&$variables)
* The same applies from the previous function, but it is called for a
* specific hook.
Angie Byron
committed
* - template_process(&$variables)
* This sets a default set of variables for all template implementations.
*
* - template_process_HOOK(&$variables)
* This is the first processor called specific to the hook; it should be
* implemented by the module that registers it.
*
* - MODULE_process(&$variables)
* This will be called for all templates; it should only be used if there
* is a real need. It's purpose is similar to template_process().
*
* - MODULE_process_HOOK(&$variables)
* This is for modules that want to alter or provide extra variables for
* theming hooks not registered to itself. For example, if a module named
Angie Byron
committed
* "foo" wanted to alter the $classes_array variable for the hook "node" a
Angie Byron
committed
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
* process function of foo_process_node() can be created to intercept
* and alter the variable.
*
* - ENGINE_engine_process(&$variables)
* This function should only be implemented by theme engines and exists
* so that it can set necessary variables for all hooks.
*
* - ENGINE_engine_process_HOOK(&$variables)
* This is the same as the previous function, but it is called for a single
* theming hook.
*
* - ENGINE_process(&$variables)
* This is meant to be used by themes that utilize a theme engine. It is
* provided so that the processor is not locked into a specific theme.
* This makes it easy to share and transport code but theme authors must be
* careful to prevent fatal re-declaration errors when using sub-themes that
* have their own processor named exactly the same as its base theme. In
* the default theme engine (PHPTemplate), sub-themes will load their own
* template.php file in addition to the one used for its parent theme. This
* increases the risk for these errors. A good practice is to use the engine
* name for the base theme and the theme name for the sub-themes to minimize
* this possibility.
*
* - ENGINE_process_HOOK(&$variables)
* The same applies from the previous function, but it is called for a
* specific hook.
*
* - THEME_process(&$variables)
* These functions are based upon the raw theme; they should primarily be
* used by themes that do not use an engine or by sub-themes. It serves the
* same purpose as ENGINE_process().
*
* - THEME_process_HOOK(&$variables)
* The same applies from the previous function, but it is called for a
* specific hook.
*
Angie Byron
committed
* If the implementation is a function, only the hook-specific preprocess
* and process functions (the ones ending in _HOOK) are called from the
Dries Buytaert
committed
* above list. This is because theme hooks with function implementations
* need to be fast, and calling the non-hook-specific preprocess and process
* functions for them would incur a noticeable performance penalty.
Angie Byron
committed
*
Angie Byron
committed
* There are two special variables that these preprocess and process functions
* can set:
* 'theme_hook_suggestion' and 'theme_hook_suggestions'. These will be merged
* together to form a list of 'suggested' alternate hooks to use, in
* reverse order of priority. theme_hook_suggestion will always be a higher
* priority than items in theme_hook_suggestions. theme() will use the
* highest priority implementation that exists. If none exists, theme() will
* use the implementation for the theme hook it was called with. These
* suggestions are similar to and are used for similar reasons as calling
* theme() with an array as the $hook parameter (see below). The difference
* is whether the suggestions are determined by the code that calls theme() or
* by a preprocess or process function.
Angie Byron
committed
*
Dries Buytaert
committed
* @param $hook
Angie Byron
committed
* The name of the theme hook to call. If the name contains a
* double-underscore ('__') and there isn't an implementation for the full
* name, the part before the '__' is checked. This allows a fallback to a more
* generic implementation. For example, if theme('links__node', ...) is
* called, but there is no implementation of that hook, then the 'links'
* implementation is used. This process is iterative, so if
* theme('links__contextual__node', ...) is called, theme() checks for the
* following implementations, and uses the first one that exists:
* - links__contextual__node
* - links__contextual
* - links
* This allows themes to create specific theme implementations for named
* objects and contexts of otherwise generic theme hooks. The $hook parameter
* may also be an array, in which case the first hook that has an
* implementation is used. This allows for the code that calls theme() to
* explicitly specify the fallback order in a situation where using the '__'
* convention is not desired or insufficient.
Dries Buytaert
committed
*
* @param $variables
* An associative array of variables to merge with defaults from the theme
* registry, pass to preprocess and process functions for modification, and
* finally, pass to the function or template implementing the theme hook.
* Alternatively, this can be a renderable array, in which case, its properties
* are mapped to variables expected by the theme hook implementations.
*
* @return
* An HTML string that generates the themed output.
Dries Buytaert
committed
function theme($hook, $variables = array()) {
Dries Buytaert
committed
static $hooks = NULL;
if (!isset($hooks)) {
Dries Buytaert
committed
drupal_theme_initialize();
Dries Buytaert
committed
$hooks = theme_get_registry();
}
Dries Buytaert
committed
Dries Buytaert
committed
// If an array of hook candidates were passed, use the first one that has an
// implementation.
Dries Buytaert
committed
if (is_array($hook)) {
foreach ($hook as $candidate) {
if (isset($hooks[$candidate])) {
break;
}
}
$hook = $candidate;
}
Angie Byron
committed
// If there's no implementation, check for more generic fallbacks. If there's
// still no implementation, log an error and return an empty string.
Dries Buytaert
committed
if (!isset($hooks[$hook])) {
Angie Byron
committed
// Iteratively strip everything after the last '__' delimiter, until an
// implementation is found.
while ($pos = strrpos($hook, '__')) {
$hook = substr($hook, 0, $pos);
if (isset($hooks[$hook])) {
break;
}
}
if (!isset($hooks[$hook])) {
watchdog('theme', 'Theme key "@key" not found.', array('@key' => $hook), WATCHDOG_WARNING);
return '';
}
}
Dries Buytaert
committed
$info = $hooks[$hook];
Dries Buytaert
committed
global $theme_path;
$temp = $theme_path;
// point path_to_theme() to the currently used theme path:
$theme_path = $info['theme path'];
Angie Byron
committed
// Include a file if the theme function or variable processor is held elsewhere.
if (!empty($info['includes'])) {
foreach ($info['includes'] as $include_file) {
include_once DRUPAL_ROOT . '/' . $include_file;
}
}
Dries Buytaert
committed
// If a renderable array is passed as $variables, then set $variables to
// the arguments expected by the theme function.
Dries Buytaert
committed
if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
$element = $variables;
$variables = array();
if (isset($info['variables'])) {
foreach (array_keys($info['variables']) as $name) {
Dries Buytaert
committed
if (isset($element["#$name"])) {
$variables[$name] = $element["#$name"];
}
Angie Byron
committed
}
}
else {
$variables[$info['render element']] = $element;
}
Dries Buytaert
committed
}
Angie Byron
committed
Dries Buytaert
committed
// Merge in argument defaults.
if (!empty($info['variables'])) {
$variables += $info['variables'];
}
elseif (!empty($info['render element'])) {
$variables += array($info['render element'] => array());
Dries Buytaert
committed
}
Angie Byron
committed
Dries Buytaert
committed
// Invoke the variable processors, if any. The processors may specify
Angie Byron
committed
// alternate suggestions for which hook's template/function to use.
Dries Buytaert
committed
if (isset($info['preprocess functions']) || isset($info['process functions'])) {
Angie Byron
committed
$variables['theme_hook_suggestions'] = array();
Dries Buytaert
committed
foreach (array('preprocess functions', 'process functions') as $phase) {
if (!empty($info[$phase])) {
foreach ($info[$phase] as $processor_function) {
if (function_exists($processor_function)) {
// We don't want a poorly behaved process function changing $hook.
$hook_clone = $hook;
$processor_function($variables, $hook_clone);
Angie Byron
committed
}
}
}
Dries Buytaert
committed
}
Angie Byron
committed
// If the preprocess/process functions specified hook suggestions, and the
// suggestion exists in the theme registry, use it instead of the hook that
// theme() was called with. This allows the preprocess/process step to
// route to a more specific theme hook. For example, a function may call
// theme('node', ...), but a preprocess function can add 'node__article' as
// a suggestion, enabling a theme to have an alternate template file for
// article nodes. Suggestions are checked in the following order:
// - The 'theme_hook_suggestion' variable is checked first. It overrides
// all others.
// - The 'theme_hook_suggestions' variable is checked in FILO order, so the
// last suggestion added to the array takes precedence over suggestions
// added earlier.
Dries Buytaert
committed
$suggestions = array();
Angie Byron
committed
if (!empty($variables['theme_hook_suggestions'])) {
$suggestions = $variables['theme_hook_suggestions'];
Dries Buytaert
committed
}
Angie Byron
committed
if (!empty($variables['theme_hook_suggestion'])) {
$suggestions[] = $variables['theme_hook_suggestion'];
Dries Buytaert
committed
}
foreach (array_reverse($suggestions) as $suggestion) {
Angie Byron
committed
if (isset($hooks[$suggestion])) {
$info = $hooks[$suggestion];
Dries Buytaert
committed
break;
}
Angie Byron
committed
}
Dries Buytaert
committed
}
Angie Byron
committed
Dries Buytaert
committed
// Generate the output using either a function or a template.
if (isset($info['function'])) {
if (function_exists($info['function'])) {
Dries Buytaert
committed
$output = $info['function']($variables);
Dries Buytaert
committed
else {
Dries Buytaert
committed
// Default render function and extension.
Dries Buytaert
committed
$render_function = 'theme_render_template';
$extension = '.tpl.php';
Angie Byron
committed
// The theme engine may use a different extension and a different renderer.
Dries Buytaert
committed
global $theme_engine;
if (isset($theme_engine)) {
if ($info['type'] != 'module') {
if (function_exists($theme_engine . '_render_template')) {
$render_function = $theme_engine . '_render_template';
Dries Buytaert
committed
}
$extension_function = $theme_engine . '_extension';
Dries Buytaert
committed
if (function_exists($extension_function)) {
$extension = $extension_function();
}
}
}
Dries Buytaert
committed
// In some cases, a template implementation may not have had
// template_preprocess() run (for example, if the default implementation is
// a function, but a template overrides that default implementation). In
// these cases, a template should still be able to expect to have access to
// the variables provided by template_preprocess(), so we add them here if
// they don't already exist. We don't want to run template_preprocess()
// twice (it would be inefficient and mess up zebra striping), so we use the
// 'directory' variable to determine if it has already run, which while not
// completely intuitive, is reasonably safe, and allows us to save on the
// overhead of adding some new variable to track that.
if (!isset($variables['directory'])) {
$default_template_variables = array();
template_preprocess($default_template_variables, $hook);
$variables += $default_template_variables;
}
Angie Byron
committed
// Render the output using the template file.
$template_file = $info['template'] . $extension;
if (isset($info['path'])) {
$template_file = $info['path'] . '/' . $template_file;
Dries Buytaert
committed
}
Dries Buytaert
committed
$output = $render_function($template_file, $variables);
Dries Buytaert
committed
Dries Buytaert
committed
// restore path_to_theme()
$theme_path = $temp;
return $output;
Dries Buytaert
committed
}
* Return the path to the current themed element.
*
* It can point to the active theme or the module handling a themed implementation.
* For example, when invoked within the scope of a theming call it will depend
* on where the theming function is handled. If implemented from a module, it
* will point to the module. If implemented from the active theme, it will point
* to the active theme. When called outside the scope of a theming call, it will
* always point to the active theme.
Dries Buytaert
committed
global $theme_path;
Dries Buytaert
committed
if (!isset($theme_path)) {
Dries Buytaert
committed
drupal_theme_initialize();
}
Dries Buytaert
committed
return $theme_path;
}
Dries Buytaert
committed
/**
* Allow themes and/or theme engines to easily discover overridden theme functions.
Dries Buytaert
committed
*
* @param $cache
* The existing cache of theme hooks to test against.
* @param $prefixes
* An array of prefixes to test, in reverse order of importance.
*
* @return $templates
* The functions found, suitable for returning from hook_theme;
*/
function drupal_find_theme_functions($cache, $prefixes) {
$templates = array();
$functions = get_defined_functions();
foreach ($cache as $hook => $info) {
foreach ($prefixes as $prefix) {
Angie Byron
committed
$pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
if (!empty($pattern)) {
$matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
Dries Buytaert
committed
if ($matches) {
foreach ($matches as $match) {
$new_hook = str_replace($prefix . '_', '', $match);
$arg_name = isset($info['variables']) ? 'variables' : 'render element';
Dries Buytaert
committed
$templates[$new_hook] = array(
'function' => $match,
$arg_name => $info[$arg_name],
Dries Buytaert
committed
);
}
}
}
if (function_exists($prefix . '_' . $hook)) {
Dries Buytaert
committed
$templates[$hook] = array(
'function' => $prefix . '_' . $hook,
Dries Buytaert
committed
);
Angie Byron
committed
// Ensure that the pattern is maintained from base themes to its sub-themes.
// Each sub-theme will have their functions scanned so the pattern must be
// held for subsequent runs.
if (isset($info['pattern'])) {
$templates[$hook]['pattern'] = $info['pattern'];
}
Dries Buytaert
committed
}
}
}
return $templates;