/includes/theme.inc
Pascal | 2561 lines | 1535 code | 113 blank | 913 comment | 197 complexity | 79051068abfd31784658b77ec048b858 MD5 | raw file
Large files files are truncated, but you can click here to view the full file
- <?php
- // $Id: theme.inc,v 1.605 2010-08-08 19:35:48 dries Exp $
- /**
- * @file
- * 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.
- */
- /**
- * @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.
- */
- define('MARK_UPDATED', 2);
- /**
- * @} End of "Content markers".
- */
- /**
- * Determines if a theme is available to use.
- *
- * @param $theme
- * Either the name of a theme or a full theme object.
- *
- * @return
- * Boolean TRUE if the theme is enabled or is the site administration theme;
- * FALSE otherwise.
- */
- function drupal_theme_access($theme) {
- 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) {
- $admin_theme = variable_get('admin_theme');
- return !empty($theme->status) || ($admin_theme && $theme->name == $admin_theme);
- }
- /**
- * Initialize the theme system by loading the theme.
- */
- function drupal_theme_initialize() {
- global $theme, $user, $theme_key;
- // If $theme is already set, assume the others are set, too, and do nothing
- if (isset($theme)) {
- return;
- }
- drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
- $themes = list_themes();
- // Only select the user selected theme if it is available in the
- // list of themes that can be accessed.
- $theme = !empty($user->theme) && drupal_theme_access($user->theme) ? $user->theme : variable_get('theme_default', 'bartik');
- // 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.
- $custom_theme = menu_get_custom_theme();
- $theme = !empty($custom_theme) ? $custom_theme : $theme;
- // Store the identifier for retrieving theme settings with.
- $theme_key = $theme;
- // Find all our ancestor themes and put them in an array.
- $base_theme = array();
- $ancestor = $theme;
- while ($ancestor && isset($themes[$ancestor]->base_theme)) {
- $base_theme[] = $new_base_theme = $themes[$themes[$ancestor]->base_theme];
- $ancestor = $themes[$ancestor]->base_theme;
- }
- _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
- // Themes can have alter functions, so reset the drupal_alter() cache.
- drupal_static_reset('drupal_alter');
- }
- /**
- * 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.
- */
- function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callback = '_theme_load_registry') {
- global $theme_info, $base_theme_info, $theme_engine, $theme_path;
- $theme_info = $theme;
- $base_theme_info = $base_theme;
- $theme_path = dirname($theme->filename);
- // 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;
- }
- }
- }
- }
- // Add stylesheets used by this theme.
- if (!empty($theme->stylesheets)) {
- foreach ($theme->stylesheets as $media => $stylesheets) {
- 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) {
- drupal_add_css($stylesheet, array('weight' => CSS_THEME, 'media' => $media, 'preprocess' => TRUE));
- }
- }
- // 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;
- }
- }
- }
- // Add scripts used by this theme.
- if (!empty($theme->scripts)) {
- foreach ($theme->scripts as $name => $script) {
- $final_scripts[$name] = $script;
- }
- }
- // Add scripts used by this theme.
- foreach ($final_scripts as $script) {
- drupal_add_js($script, array('weight' => JS_THEME, 'preprocess' => TRUE));
- }
- $theme_engine = NULL;
- // Initialize the theme.
- if (isset($theme->engine)) {
- // Include the engine.
- include_once DRUPAL_ROOT . '/' . $theme->owner;
- $theme_engine = $theme->engine;
- if (function_exists($theme_engine . '_init')) {
- foreach ($base_theme as $base) {
- call_user_func($theme_engine . '_init', $base);
- }
- call_user_func($theme_engine . '_init', $theme);
- }
- }
- else {
- // include non-engine theme files
- foreach ($base_theme as $base) {
- // Include the theme file or the engine.
- if (!empty($base->owner)) {
- include_once DRUPAL_ROOT . '/' . $base->owner;
- }
- }
- // and our theme gets one too.
- if (!empty($theme->owner)) {
- include_once DRUPAL_ROOT . '/' . $theme->owner;
- }
- }
- if (function_exists($registry_callback)) {
- $registry_callback($theme, $base_theme, $theme_engine);
- }
- }
- /**
- * Get the theme registry.
- *
- * @return
- * The theme registry array if it has been stored in memory, NULL otherwise.
- */
- function theme_get_registry() {
- return _theme_set_registry();
- }
- /**
- * Store the theme registry in memory.
- *
- * @param $registry
- * A registry array as returned by _theme_build_registry()
- *
- * @return
- * The theme registry array stored in memory
- */
- function _theme_set_registry($registry = NULL) {
- static $theme_registry = NULL;
- if (isset($registry)) {
- $theme_registry = $registry;
- }
- return $theme_registry;
- }
- /**
- * Get the theme_registry cache from the database; if it doesn't exist, build it.
- *
- * @param $theme
- * The loaded $theme object as returned by list_themes().
- * @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.
- */
- 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');
- if (isset($cache->data)) {
- $registry = $cache->data;
- _theme_set_registry($registry);
- }
- else {
- // If not, build one and cache it.
- $registry = _theme_build_registry($theme, $base_theme, $theme_engine);
- // Only persist this registry if all modules are loaded. This assures a
- // complete set of theme hooks.
- if (module_load_all(NULL)) {
- _theme_save_registry($theme, $registry);
- _theme_set_registry($registry);
- }
- }
- }
- /**
- * Write the theme_registry cache into the database.
- */
- function _theme_save_registry($theme, $registry) {
- cache_set("theme_registry:$theme->name", $registry);
- }
- /**
- * 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() {
- cache_clear_all('theme_registry', 'cache', TRUE);
- }
- /**
- * Process a single implementation of hook_theme().
- *
- * @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.
- * - '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/bartik.
- *
- * @see theme()
- * @see _theme_process_registry()
- * @see hook_theme()
- * @see list_themes()
- */
- function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
- $result = array();
- $function = $name . '_theme';
- // Processor functions work in two distinct phases with the process
- // functions always being executed after the preprocess functions.
- $variable_process_phases = array(
- 'preprocess functions' => 'preprocess',
- 'process functions' => 'process',
- );
- if (function_exists($function)) {
- $result = $function($cache, $type, $theme, $path);
- foreach ($result as $hook => $info) {
- $result[$hook]['type'] = $type;
- $result[$hook]['theme path'] = $path;
- // 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;
- }
- // 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 these keys are left unspecified within overridden entries returned
- // by hook_theme(), carry them forward from the prior entry. This is so
- // that themes don't need to specify this information, since the module
- // that registered the theme hook already has.
- foreach (array('variables', 'render element', 'pattern', 'base hook') as $key) {
- if (!array_key_exists($key, $info) && isset($cache[$hook][$key])) {
- $result[$hook][$key] = $cache[$hook][$key];
- }
- }
- // 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'];
- }
- }
- // 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;
- }
- else {
- // This applies when the theme manually registers their own variable
- // processors.
- $prefixes[] = $name;
- }
- 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;
- }
- }
- }
- // 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];
- }
- }
- // Merge the newly created theme hooks into the existing cache.
- $cache = array_merge($cache, $result);
- }
- // Let themes have variable processors even if they didn't register a template.
- if ($type == 'theme' || $type == 'base_theme') {
- foreach ($cache as $hook => $info) {
- // Check only if not registered by the theme or engine.
- if (empty($result[$hook])) {
- foreach ($variable_process_phases as $phase_key => $phase) {
- if (!isset($info[$phase_key])) {
- $cache[$hook][$phase_key] = array();
- }
- // 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;
- }
- if (function_exists($name . '_' . $phase . '_' . $hook)) {
- $cache[$hook][$phase_key][] = $name . '_' . $phase . '_' . $hook;
- $cache[$hook]['theme path'] = $path;
- }
- // Ensure uniqueness.
- $cache[$hook][$phase_key] = array_unique($cache[$hook][$phase_key]);
- }
- }
- }
- }
- }
- /**
- * Rebuild the theme registry cache.
- *
- * @param $theme
- * The loaded $theme object as returned by list_themes().
- * @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.
- */
- function _theme_build_registry($theme, $base_theme, $theme_engine) {
- $cache = array();
- // First, process the theme hooks advertised by modules. This will
- // serve as the basic registry.
- foreach (module_implements('theme') as $module) {
- _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.
- $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);
- }
- // And then the same thing, but for the theme.
- if ($theme_engine) {
- _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
- }
- // Finally, hooks provided by the theme itself.
- _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
- // Let modules alter the registry.
- drupal_alter('theme_registry', $cache);
- // 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]);
- }
- }
- }
- 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.
- *
- * @param $refresh
- * Whether to reload the list of themes from the database. Defaults to FALSE.
- *
- * @return
- * 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/bartik/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());
- if ($refresh) {
- $list = array();
- system_list_reset();
- }
- if (empty($list)) {
- $list = array();
- $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.
- if (!defined('MAINTENANCE_MODE')) {
- try {
- foreach (system_list('theme') as $theme) {
- if (file_exists($theme->filename)) {
- $theme->info = unserialize($theme->info);
- $themes[] = $theme;
- }
- }
- }
- catch (Exception $e) {
- // If the database is not available, rebuild the theme data.
- $themes = _system_rebuild_theme_data();
- }
- }
- else {
- // Scan the installation when the database should not be read.
- $themes = _system_rebuild_theme_data();
- }
- foreach ($themes as $theme) {
- foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
- foreach ($stylesheets as $stylesheet => $path) {
- $theme->stylesheets[$media][$stylesheet] = $path;
- }
- }
- foreach ($theme->info['scripts'] as $script => $path) {
- if (file_exists($path)) {
- $theme->scripts[$script] = $path;
- }
- }
- 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;
- }
- }
- return $list;
- }
- /**
- * Generates themed output.
- *
- * All requests for themed output must go through this function. It examines
- * the request and routes it to the appropriate theme function or template, by
- * checking the theme registry.
- *
- * The first argument to this function is the name of the theme hook. For
- * instance, to theme a table, the theme hook name is 'table'. By default, this
- * theme hook could be implemented by a function called 'theme_table' or a
- * template file called 'table.tpl.php', but hook_theme() can override the
- * default function or template name.
- *
- * If the implementation is a template file, several functions are called
- * before the template file is invoked, to modify the $variables array. These
- * fall into the "preprocessing" phase and the "processing" phase, and are
- * executed (if they exist), in the following order (note that in the following
- * list, HOOK indicates the theme hook name, MODULE indicates a module name,
- * THEME indicates a theme name, and ENGINE indicates a theme engine name):
- * - template_preprocess(&$variables, $hook): Creates a default set of variables
- * for all theme hooks.
- * - template_preprocess_HOOK(&$variables): Should be implemented by
- * the module that registers the theme hook, to set up default variables.
- * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
- * implementing modules.
- * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
- * all implementing modules, so that modules that didn't define the theme hook
- * can alter the variables.
- * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
- * set necessary variables for all theme hooks.
- * - ENGINE_engine_preprocess_HOOK(&$variables): Allows the theme engine to set
- * necessary variables for the particular theme hook.
- * - THEME_preprocess(&$variables, $hook): Allows the theme to set necessary
- * variables for all theme hooks.
- * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
- * variables specific to the particular theme hook.
- * - template_process(&$variables, $hook): Creates a default set of variables
- * for all theme hooks.
- * - template_process_HOOK(&$variables): This is the first processor specific
- * to the theme hook; it should be implemented by the module that registers
- * it.
- * - MODULE_process(&$variables, $hook): hook_process() is invoked on all
- * implementing modules.
- * - MODULE_process_HOOK(&$variables): hook_process_HOOK() is invoked on
- * on all implementing modules, so that modules that didn't define the theme
- * hook can alter the variables.
- * - ENGINE_engine_process(&$variables, $hook): Allows the theme engine to set
- * necessary variables for all theme hooks.
- * - ENGINE_engine_process_HOOK(&$variables): Allows the theme engine to set
- * necessary variables for the particular theme hook.
- * - ENGINE_process(&$variables, $hook): Allows the theme engine to process the
- * variables.
- * - ENGINE_process_HOOK(&$variables): Allows the theme engine to process the
- * variables specific to the theme hook.
- * - THEME_process(&$variables, $hook): Allows the theme to process the
- * variables.
- * - THEME_process_HOOK(&$variables): Allows the theme to process the
- * variables specific to the theme hook.
- *
- * If the implementation is a function, only the theme-hook-specific preprocess
- * and process functions (the ones ending in _HOOK) are called from the
- * list above. This is because theme hooks with function implementations
- * need to be fast, and calling the non-theme-hook-specific preprocess and
- * process functions for them would incur a noticeable performance penalty.
- *
- * 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 theme 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.
- *
- * @param $hook
- * 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 theme 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 theme 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 is insufficient.
- * @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 representing the themed output.
- */
- function theme($hook, $variables = array()) {
- static $hooks = NULL;
- // If called before all modules are loaded, we do not necessarily have a full
- // theme registry to work with, and therefore cannot process the theme
- // request properly. See also _theme_load_registry().
- if (!module_load_all(NULL) && !defined('MAINTENANCE_MODE')) {
- throw new Exception(t('theme() may not be called until all modules are loaded.'));
- }
- if (!isset($hooks)) {
- drupal_theme_initialize();
- $hooks = theme_get_registry();
- }
- // If an array of hook candidates were passed, use the first one that has an
- // implementation.
- if (is_array($hook)) {
- foreach ($hook as $candidate) {
- if (isset($hooks[$candidate])) {
- break;
- }
- }
- $hook = $candidate;
- }
- // If there's no implementation, check for more generic fallbacks. If there's
- // still no implementation, log an error and return an empty string.
- if (!isset($hooks[$hook])) {
- // 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 '';
- }
- }
- $info = $hooks[$hook];
- global $theme_path;
- $temp = $theme_path;
- // point path_to_theme() to the currently used theme path:
- $theme_path = $info['theme path'];
- // 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;
- }
- }
- // If a renderable array is passed as $variables, then set $variables to
- // the arguments expected by the theme function.
- if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
- $element = $variables;
- $variables = array();
- if (isset($info['variables'])) {
- foreach (array_keys($info['variables']) as $name) {
- if (isset($element["#$name"])) {
- $variables[$name] = $element["#$name"];
- }
- }
- }
- else {
- $variables[$info['render element']] = $element;
- }
- }
- // Merge in argument defaults.
- if (!empty($info['variables'])) {
- $variables += $info['variables'];
- }
- elseif (!empty($info['render element'])) {
- $variables += array($info['render element'] => array());
- }
- // Invoke the variable processors, if any. The processors may specify
- // alternate suggestions for which hook's template/function to use. If the
- // hook is a suggestion of a base hook, invoke the variable processors of
- // the base hook, but retain the suggestion as a high priority suggestion to
- // be used unless overridden by a variable processor function.
- if (isset($info['base hook'])) {
- $base_hook = $info['base hook'];
- $base_hook_info = $hooks[$base_hook];
- if (isset($base_hook_info['preprocess functions']) || isset($base_hook_info['process functions'])) {
- $variables['theme_hook_suggestion'] = $hook;
- $hook = $base_hook;
- $info = $base_hook_info;
- }
- }
- if (isset($info['preprocess functions']) || isset($info['process functions'])) {
- $variables['theme_hook_suggestions'] = array();
- 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);
- }
- }
- }
- }
- // 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.
- $suggestions = array();
- if (!empty($variables['theme_hook_suggestions'])) {
- $suggestions = $variables['theme_hook_suggestions'];
- }
- if (!empty($variables['theme_hook_suggestion'])) {
- $suggestions[] = $variables['theme_hook_suggestion'];
- }
- foreach (array_reverse($suggestions) as $suggestion) {
- if (isset($hooks[$suggestion])) {
- $info = $hooks[$suggestion];
- break;
- }
- }
- }
- // Generate the output using either a function or a template.
- if (isset($info['function'])) {
- if (function_exists($info['function'])) {
- $output = $info['function']($variables);
- }
- }
- else {
- // Default render function and extension.
- $render_function = 'theme_render_template';
- $extension = '.tpl.php';
- // The theme engine may use a different extension and a different renderer.
- global $theme_engine;
- if (isset($theme_engine)) {
- if ($info['type'] != 'module') {
- if (function_exists($theme_engine . '_render_template')) {
- $render_function = $theme_engine . '_render_template';
- }
- $extension_function = $theme_engine . '_extension';
- if (function_exists($extension_function)) {
- $extension = $extension_function();
- }
- }
- }
- // 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;
- }
- // Render the output using the template file.
- $template_file = $info['template'] . $extension;
- if (isset($info['path'])) {
- $template_file = $info['path'] . '/' . $template_file;
- }
- $output = $render_function($template_file, $variables);
- }
- // restore path_to_theme()
- $theme_path = $temp;
- return $output;
- }
- /**
- * 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.
- */
- function path_to_theme() {
- global $theme_path;
- if (!isset($theme_path)) {
- drupal_theme_initialize();
- }
- return $theme_path;
- }
- /**
- * Allow themes and/or theme engines to easily discover overridden theme functions.
- *
- * @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 $implementations
- * The functions found, suitable for returning from hook_theme;
- */
- function drupal_find_theme_functions($cache, $prefixes) {
- $implementations = array();
- $functions = get_defined_functions();
- foreach ($cache as $hook => $info) {
- foreach ($prefixes as $prefix) {
- // Find theme functions that implement possible "suggestion" variants of
- // registered theme hooks and add those as new registered theme hooks.
- // The 'pattern' key defines a common prefix that all suggestions must
- // start with. The default is the name of the hook followed by '__'. An
- // 'base hook' key is added to each entry made for a found suggestion,
- // so that common functionality can be implemented for all suggestions of
- // the same base hook. To keep things simple, deep heirarchy of
- // suggestions is not supported: each suggestion's 'base hook' key
- // refers to a base hook, not to another suggestion, and all suggestions
- // are found using the base hook's pattern, not a pattern from an
- // intermediary suggestion.
- $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
- if (!isset($info['base hook']) && !empty($pattern)) {
- $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
- if ($matches) {
- foreach ($matches as $match) {
- $new_hook = str_replace($prefix . '_', '', $match);
- $arg_name = isset($info['variables']) ? 'variables' : 'render element';
- $implementations[$new_hook] = array(
- 'function' => $match,
- $arg_name => $info[$arg_name],
- 'base hook' => $hook,
- );
- }
- }
- }
- // Find theme functions that implement registered theme hooks and include
- // that in what is returned so that the registry knows that the theme has
- // this implementation.
- if (function_exists($prefix . '_' . $hook)) {
- $implementations[$hook] = array(
- 'function' => $prefix . '_' . $hook,
- );
- }
- }
- }
- return $implementations;
- }
- /**
- * Allow themes and/or theme engines to easily discover overridden templates.
- *
- * @param $cache
- * The existing cache of theme hooks to test against.
- * @param $extension
- * The extension that these templates will have.
- * @param $path
- * The path to search.
- */
- function drupal_find_theme_templates($cache, $extension, $path) {
- $implementations = array();
- // Collect paths to all sub-themes grouped by base themes. These will be
- // used for filtering. This allows base themes to have sub-themes in its
- // folder hierarchy without affecting the base themes template discovery.
- $theme_paths = array();
- foreach (list_themes() as $theme_info) {
- if (!empty($theme_info->base_theme)) {
- $theme_paths[$theme_info->base_theme][$theme_info->name] = dirname($theme_info->filename);
- }
- }
- foreach ($theme_paths as $basetheme => $subthemes) {
- foreach ($subthemes as $subtheme => $subtheme_path) {
- if (isset($theme_paths[$subtheme])) {
- $theme_paths[$basetheme] = array_merge($theme_paths[$basetheme], $theme_paths[$subtheme]);
- }
- }
- }
- global $theme;
- $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
- // Escape the periods in the extension.
- $regex = '/' . str_replace('.', '\.', $extension) . '$/';
- // Get a listing of all template files in the path to search.
- $files = drupal_system_listing($regex, $path, 'name', 0);
- // Find templates that implement registered theme hooks and include that in
- // what is returned so that the registry knows that the theme has this
- // implementation.
- foreach ($files as $template => $file) {
- // Ignore sub-theme templates for the current theme.
- if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
- continue;
- }
- // Chop off the remaining extensions if there are any. $template already
- // has the rightmost extension removed, but there might still be more,
- // such as with .tpl.php, which still has .tpl in $template at this point.
- if (($pos = strpos($template, '.')) !== FALSE) {
- $template = substr($template, 0, $pos);
- }
- // Transform - in filenames to _ to match function naming scheme
- // for the purposes of searching.
- $hook = strtr($template, '-', '_');
- if (isset($cache[$hook])) {
- $implementations[$hook] = array(
- 'template' => $template,
- 'path' => dirname($file->uri),
- );
- }
- }
- // Find templates that implement possible "suggestion" variants of registered
- // theme hooks and add those as new registered theme hooks. See
- // drupal_find_theme_functions() for more information about suggestions and
- // the use of 'pattern' and 'base hook'.
- $patterns = array_keys($files);
- foreach ($cache as $hook => $info) {
- $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
- if (!isset($info['base hook']) && !empty($pattern)) {
- // Transform _ in pattern to - to match file naming scheme
- // for the purposes of searching.
- $pattern = strtr($pattern, '_', '-');
- $matches = preg_grep('/^' . $pattern . '/', $patterns);
- if ($matches) {
- foreach ($matches as $match) {
- $file = substr($match, 0, strpos($match, '.'));
- // Put the underscores back in for the hook name and register this pattern.
- $arg_name = isset($info['variables']) ? 'variables' : 'render element';
- $implementations[strtr($file, '-', '_')] = array(
- 'template' => $file,
- 'path' => dirname($files[$match]->uri),
- $arg_name => $info[$arg_name],
- 'base hook' => $hook,
- );
- }
- }
- }
- }
- return $implementations;
- }
- /**
- * Retrieve a setting for the current theme or for a given theme.
- *
- * The final setting is obtained from the last value found in the following
- * sources:
- * - the default global settings specified in this function
- * - the default theme-specific settings defined in any base theme's .info file
- * - the default theme-specific settings defined in the theme's .info file
- * - the saved values from the global theme settings form
- * - the saved values from the theme's settings form
- * To only retrieve the default global theme setting, an empty string should be
- * given for $theme.
- *
- * @param $setting_name
- * The name of the setting to be retrieved.
- * @param $theme
- * The name of a given theme; defaults to the current theme.
- *
- * @return
- * The value of the requested setting, NULL if the setting does not exist.
- */
- function theme_get_setting($setting_name, $theme = NULL) {
- $cache = &drupal_static(__FUNCTION__, array());
- // If no key is given, use the current theme if we can determine it.
- if (is_null($theme)) {
- $theme = !empty($GLOBALS['theme_key']) ? $GLOBALS['theme_key'] : '';
- }
- if (empty($cache[$theme])) {
- // Set the default values for each global setting.
- // To add new global settings, add their default values below, and then
- // add form elements to system_theme_settings() in system.admin.inc.
- $cache[$theme] = array(
- 'default_logo' => 1,
- 'logo_path' => '',
- 'default_favicon' => 1,
- 'favicon_path' => '',
- // Use the IANA-registered MIME type for ICO files as default.
- 'favicon_mimetype' => 'image/vnd.microsoft.icon',
- );
- // Turn on all default features.
- $features = _system_default_theme_features();
- foreach ($features as $feature) {
- $cache[$theme]['toggle_' . $feature] = 1;
- }
- // Get the values for the theme-specific settings from the .info files of
- // the theme and all its base themes.
- if ($theme) {
- $themes = list_themes();
- $theme_object = $themes[$theme];
- // Create a list which includes the current theme and all its base themes.
- if (isset($theme_object->base_themes)) {
- $theme_keys = array_keys($theme_object->base_themes);
- $theme_keys[] = $theme;
- }
- else {
- $theme_keys = array($theme);
- }
- foreach ($theme_keys as $theme_key) {
- if (!empty($themes[$theme_key]->info['settings'])) {
- $cache[$theme] = array_merge($cache[$theme], $themes[$theme_key]->info['settings']);
- }
- }
- }
- // Get the saved global settings from the database.
- $cache[$theme] = array_merge($cache[$theme], variable_get('theme_settings', array()));
- if ($theme) {
- // Get the saved theme-specific settings from the database.
- $cache[$theme] = array_merge($cache[$theme], variable_get('theme_' . $theme . '_settings', array()));
- // If the theme does not support a particular feature, override the global
- // setting and set the value to NULL.
- if (!empty($theme_object->info['features'])) {
- foreach ($features as $feature) {
- if (!in_array($feature, $theme_object->info['features'])) {
- $cache[$theme]['toggle_' . $feature] = NULL;
- }
- }
- }
- // Generate the path to the logo image.
- if ($cache[$theme]['toggle_logo']) {
- if ($cache[$theme]['default_logo']) {
- $cache[$theme]['logo'] = file_create_url(dirname($theme_object->filename) . '/logo.png');
- }
- elseif ($cache[$theme]['logo_path']) {
- $cache[$theme]['logo'] = file_create_url($cache[$theme]['logo_path']);
- }
- }
- // Generate the path to the favicon.
- if ($cache[$theme]['toggle_favicon']) {
- if ($cache[$theme]['default_favicon']) {
- if (file_exists($favicon = dirname($theme_object->filename) . '/favicon.ico')) {
- $cache[$theme]['favicon'] = file_create_url($favicon);
- }
- else {
- $cache[$theme]['favicon'] = file_create_url('misc/favicon.ico');
- }
- }
- elseif ($cache[$theme]['favicon_path']) {
- $cache[$theme]['favicon'] = file_create_url($cache[$theme]['favicon_path']);
- }
- else {
- $cache[$theme]['toggle_favicon'] = FALSE;
- }
- }
- }
- }
- return isset($cache[$theme][$setting_name]) ? $cache[$theme][$setting_name] : NULL;
- }
- /**
- * Render a system default template, which is essentially a PHP template.
- *
- * @param $template_file
- * The filename of the template to render.
- * @param $variables
- * A keyed array of variables that will appear in the output.
- *
- * @return
- * The output generated by the template.
- */
- function theme_render_template($template_file, $variables) {
- extract($variables, EXTR_SKIP); // Extract the variables to a local namespace
- ob_start(); // Start output buffering
- include DRUPAL_ROOT . '/' . $template_file; // Include the template file
- return ob_get_clean(); // End buffering and return its contents
- }
- /**
- * Enable a given list of themes.
- *
- * @param $theme_list
- * An array of theme names.
- */
- function theme_enable($theme_list) {
- drupal_clear_css_cache();
- foreach ($theme_list as $key) {
- db_update('system')
- ->fields(array('status' => 1))
- ->condition('type', 'theme')
- ->condition('name', $key)
- ->execute();
- }
- list_themes(TRUE);
- menu_rebuild();
- drupal_theme_rebuild();
- // Notify locale module about new themes being enabled, so translations can
- // be imported. This might start a batch, and only return to the redirect
- // path after that.
- module_invoke('locale', 'system_update', $theme_list);
- // Invoke hook_themes_enabled after the themes have been enabled.
- module_invoke_all('themes_enabled', $theme_list);
- return;
- }
- /**
- * Disable a given list of themes.
- *
- * @param $theme_list
- * An array of theme names.
- */
- function theme_disable($theme_list) {
- // Don't disable the default theme.
- if ($pos = array_search(variable_get('theme_default', 'bartik'), $theme_list) !== FALSE) {
- unset($theme_list[$pos]);
- if (empty($theme_list)) {
- return;
- }
- }
- drupal_clear_css_cache();
- foreach ($theme_list as $key) {
- db_update('system')
- ->fields(array('status' => 0))
- ->condition('type', 'theme')
- ->condition('name', $key)
- ->execute();
- }
- list_themes(TRUE);
- menu_rebuild();
- drupal_theme_rebuild();
- // Invoke hook_themes_enabled after the themes have been enabled.
- module_invoke_all('themes_disabled', $theme_list);
- return;
- }
- /**
- * @ingroup themeable
- * @{
- */
- /**
- * Returns HTML for status and/or error messages, grouped by type.
- *
- * An invisible heading identifies the messages for assistive technology.
- * Sighted users see a colored box. See http://www.w3.org/TR/WCAG-TECHS/H69.html
- * for info.
- *
- * @param $variables
- * An associative array containing:
- * - display: (optional) Set to 'status' or 'error' to display only messages
- * of that type.
- */
- function theme_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\">\n";
- if (!empty($status_heading[$type])) {
- $output .= '<h2 class="element-invisible">' . $status_heading[$type] . "</h2>\n";
- }
- if (count($messages) > 1) {
- $output .= " <ul>\n";
- foreach ($messages as $message) {
- $output .= ' <li>' . $message . "</li>\n";
- }
- $output .= " </ul>\n";
- }
- else {
- $output .= $messages[0];
- }
- $output .= "</div>\n";
- }
- return $output;
- }
- /**
- * Return…
Large files files are truncated, but you can click here to view the full file