Newer
Older
Angie Byron
committed
* 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.
*/
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Template\Attribute;
use Drupal\Core\Utility\ThemeRegistry;
Angie Byron
committed
Dries Buytaert
committed
/**
* @defgroup content_flags Content markers
Dries Buytaert
committed
* @{
* Markers used by theme_mark() and node_mark() to designate content.
* @see theme_mark(), node_mark()
*/
/**
* Mark content as read.
*/
const MARK_READ = 0;
/**
* Mark content as being new.
*/
const MARK_NEW = 1;
/**
* Mark content as being updated.
*/
const MARK_UPDATED = 2;
/**
* A responsive table class; hide table cell on narrow devices.
*
* Indicates that a column has medium priority and thus can be hidden on narrow
* width devices and shown on medium+ width devices (i.e. tablets and desktops).
*/
const RESPONSIVE_PRIORITY_MEDIUM = 'priority-medium';
/**
* A responsive table class; only show table cell on wide devices.
*
* Indicates that a column has low priority and thus can be hidden on narrow
* and medium viewports and shown on wide devices (i.e. desktops).
*/
const RESPONSIVE_PRIORITY_LOW = 'priority-low';
Dries Buytaert
committed
/**
* @} End of "defgroup content_flags".
Dries Buytaert
committed
*/
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)) {
Dries Buytaert
committed
return !empty($theme->status);
Angie Byron
committed
}
else {
$themes = list_themes();
Dries Buytaert
committed
return !empty($themes[$theme]->status);
Angie Byron
committed
}
}
Jennifer Hodgdon
committed
* Initializes the theme system by loading the 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.
Dries Buytaert
committed
$theme = !empty($user->theme) && drupal_theme_access($user->theme) ? $user->theme : variable_get('theme_default', 'stark');
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
$ancestor = $themes[$ancestor]->base_theme;
$base_theme[] = $themes[$ancestor];
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
}
/**
Jennifer Hodgdon
committed
* Initializes the theme system given already loaded information.
*
* This function is useful to initialize a theme when no database is present.
Dries Buytaert
committed
*
* @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();
// CSS file basenames to override, pointing to the final, overridden filepath.
$theme->stylesheets_override = array();
// CSS file basenames to remove.
$theme->stylesheets_remove = array();
Gábor Hojtsy
committed
// 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;
}
}
}
$base_theme_path = dirname($base->filename);
if (!empty($base->info['stylesheets-remove'])) {
foreach ($base->info['stylesheets-remove'] as $basename) {
$theme->stylesheets_remove[$basename] = $base_theme_path . '/' . $basename;
}
}
if (!empty($base->info['stylesheets-override'])) {
foreach ($base->info['stylesheets-override'] as $name) {
$basename = drupal_basename($name);
$theme->stylesheets_override[$basename] = $base_theme_path . '/' . $name;
}
}
Gábor Hojtsy
committed
}
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;
}
}
}
if (!empty($theme->info['stylesheets-remove'])) {
foreach ($theme->info['stylesheets-remove'] as $basename) {
$theme->stylesheets_remove[$basename] = $theme_path . '/' . $basename;
if (isset($theme->stylesheets_override[$basename])) {
unset($theme->stylesheets_override[$basename]);
}
}
}
if (!empty($theme->info['stylesheets-override'])) {
foreach ($theme->info['stylesheets-override'] as $name) {
$basename = drupal_basename($name);
$theme->stylesheets_override[$basename] = $theme_path . '/' . $name;
if (isset($theme->stylesheets_remove[$basename])) {
unset($theme->stylesheets_remove[$basename]);
}
}
}
Gábor Hojtsy
committed
// And now add the stylesheets properly
foreach ($final_stylesheets as $media => $stylesheets) {
foreach ($stylesheets as $stylesheet) {
Dries Buytaert
committed
drupal_add_css($stylesheet, array('group' => CSS_THEME, 'every_page' => TRUE, '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) {
Dries Buytaert
committed
drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
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;
Dries Buytaert
committed
// Load twig as secondary always available engine.
// @todo Make twig the default engine and remove this. This is required
// because (by design) the theme system doesn't allow modules to register more
// than one type of extension. We need a temporary backwards compatibility
// layer to allow us to perform core-wide .tpl.php to .twig conversion.
include_once DRUPAL_ROOT . '/core/themes/engines/twig/twig.engine';
Dries Buytaert
committed
if (isset($registry_callback)) {
_theme_registry_callback($registry_callback, array($theme, $base_theme, $theme_engine));
Dries Buytaert
committed
}
Dries Buytaert
committed
/**
Jennifer Hodgdon
committed
* Gets the theme registry.
Dries Buytaert
committed
*
* @param bool $complete
* Optional boolean to indicate whether to return the complete theme registry
Angie Byron
committed
* array or an instance of the Drupal\Core\Utility\ThemeRegistry class.
* If TRUE, the complete theme registry array will be returned. This is useful
* if you want to foreach over the whole registry, use array_* functions or
* inspect it in a debugger. If FALSE, an instance of the
* Drupal\Core\Utility\ThemeRegistry class will be returned, this provides an
* ArrayObject which allows it to be accessed with array syntax and isset(),
* and should be more lightweight than the full registry. Defaults to TRUE.
*
Angie Byron
committed
* The complete theme registry array, or an instance of the
* Drupal\Core\Utility\ThemeRegistry class.
Dries Buytaert
committed
*/
function theme_get_registry($complete = TRUE) {
// Use the advanced drupal_static() pattern, since this is called very often.
static $drupal_static_fast;
if (!isset($drupal_static_fast)) {
$drupal_static_fast['registry'] = &drupal_static('theme_get_registry');
}
$theme_registry = &$drupal_static_fast['registry'];
// Initialize the theme, if this is called early in the bootstrap, or after
// static variables have been reset.
if (!is_array($theme_registry)) {
drupal_theme_initialize();
$theme_registry = array();
}
$key = (int) $complete;
Dries Buytaert
committed
if (!isset($theme_registry[$key])) {
Dries Buytaert
committed
list($callback, $arguments) = _theme_registry_callback();
if (!$complete) {
$arguments[] = FALSE;
}
$theme_registry[$key] = call_user_func_array($callback, $arguments);
Dries Buytaert
committed
}
return $theme_registry[$key];
Dries Buytaert
committed
}
/**
Jennifer Hodgdon
committed
* Sets the callback that will be used by theme_get_registry().
Dries Buytaert
committed
*
Dries Buytaert
committed
* @param $callback
* The name of the callback function.
* @param $arguments
* The arguments to pass to the function.
Dries Buytaert
committed
*/
Dries Buytaert
committed
function _theme_registry_callback($callback = NULL, array $arguments = array()) {
static $stored;
if (isset($callback)) {
$stored = array($callback, $arguments);
}
Dries Buytaert
committed
return $stored;
Dries Buytaert
committed
}
/**
Jennifer Hodgdon
committed
* Gets the theme_registry cache; if it doesn't exist, builds 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.
Angie Byron
committed
* @param $theme_engine
Dries Buytaert
committed
* The name of the theme engine.
* @param $complete
* Whether to load the complete theme registry or an instance of the
Angie Byron
committed
* Drupal\Core\Utility\ThemeRegistry class.
*
* @return
Angie Byron
committed
* The theme registry array, or an instance of the
* Drupal\Core\Utility\ThemeRegistry class.
Dries Buytaert
committed
*/
function _theme_load_registry($theme, $base_theme = NULL, $theme_engine = NULL, $complete = TRUE) {
if ($complete) {
// Check the theme registry cache; if it exists, use it.
$cached = cache()->get("theme_registry:$theme->name");
if (isset($cached->data)) {
$registry = $cached->data;
}
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);
}
}
return $registry;
Dries Buytaert
committed
}
else {
return new ThemeRegistry('theme_registry:runtime:' . $theme->name, 'cache', array('theme_registry' => TRUE));
Dries Buytaert
committed
}
}
/**
Jennifer Hodgdon
committed
* Writes the theme_registry cache into the database.
Dries Buytaert
committed
*/
function _theme_save_registry($theme, $registry) {
cache()->set("theme_registry:$theme->name", $registry, CacheBackendInterface::CACHE_PERMANENT, array('theme_registry' => TRUE));
Dries Buytaert
committed
}
/**
Jennifer Hodgdon
committed
* Forces the system to rebuild the theme registry.
*
* This function should be called when modules are added to the system, or when
* a dynamic system needs to add more theme hooks.
Dries Buytaert
committed
*/
function drupal_theme_rebuild() {
drupal_static_reset('theme_get_registry');
cache()->invalidateTags(array('theme_registry' => TRUE));
Dries Buytaert
committed
}
/**
* 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:
Dries Buytaert
committed
* - 'type': The passed-in $type.
* - 'theme path': The passed-in $path.
* - 'function': The name of the function generating output for this theme
Jennifer Hodgdon
committed
* 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
Angie Byron
committed
* hook_theme() or defaults to "$path/templates".
* - 'variables': The variables for this theme hook as defined in
Jennifer Hodgdon
committed
* 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
Dries Buytaert
committed
* themes/bartik.
*
* @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();
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',
);
Dries Buytaert
committed
$hook_defaults = array(
'variables' => TRUE,
'render element' => TRUE,
'pattern' => TRUE,
'base hook' => TRUE,
);
// Invoke the hook_theme() implementation, process what is returned, and
// merge it into $cache.
$function = $name . '_theme';
if (function_exists($function)) {
Dries Buytaert
committed
$result = $function($cache, $type, $theme, $path);
Dries Buytaert
committed
foreach ($result as $hook => $info) {
Dries Buytaert
committed
// When a theme or engine overrides a module's theme function
// $result[$hook] will only contain key/value pairs for information being
// overridden. Pull the rest of the information from what was defined by
// an earlier hook.
// Fill in the type and path of the module, theme, or engine that
// implements this theme function.
Dries Buytaert
committed
$result[$hook]['type'] = $type;
Dries Buytaert
committed
$result[$hook]['theme path'] = $path;
Dries Buytaert
committed
// If function and file are omitted, default to standard naming
Dries Buytaert
committed
// conventions.
if (!isset($info['template']) && !isset($info['function'])) {
$result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
Dries Buytaert
committed
}
Dries Buytaert
committed
if (isset($cache[$hook]['includes'])) {
$result[$hook]['includes'] = $cache[$hook]['includes'];
}
Dries Buytaert
committed
// If the theme implementation defines a file, then also use the path
// that it defined. Otherwise use the default path. This allows
// system.module to declare theme functions on behalf of core .include
// files.
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;
}
Dries Buytaert
committed
// If the default keys are not set, use the default values registered
// by the module.
if (isset($cache[$hook])) {
$result[$hook] += array_intersect_key($cache[$hook], $hook_defaults);
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 . '/templates/' . $info['template'];
Gábor Hojtsy
committed
}
Dries Buytaert
committed
if ($type == 'module') {
// Add two render engines for modules.
// @todo Remove and make twig the default engine.
$render_engines = array(
'.twig' => 'twig',
'.tpl.php' => 'phptemplate'
);
// Find the best engine for this template.
foreach ($render_engines as $extension => $engine) {
// Render the output using the template file.
$template_file = $result[$hook]['template'] . $extension;
if (isset($info['path'])) {
$template_file = $info['path'] . '/' . $template_file;
}
if (file_exists($template_file)) {
$result[$hook]['template_file'] = $template_file;
$result[$hook]['engine'] = $engine;
break;
}
}
}
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
Dries Buytaert
committed
// implemented as templates. See theme().
Angie Byron
committed
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 = $result + $cache;
Dries Buytaert
committed
}
Jennifer Hodgdon
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
Dries Buytaert
committed
// implemented as templates. See theme().
Angie Byron
committed
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
}
/**
Jennifer Hodgdon
committed
* Builds 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.
Angie Byron
committed
* @param $theme_engine
Dries Buytaert
committed
* 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
Angie Byron
committed
// serve as the basic registry. Since the list of enabled modules is the same
// regardless of the theme used, this is cached in its own entry to save
// building it for every theme.
if ($cached = cache()->get('theme_registry:build:modules')) {
Angie Byron
committed
$cache = $cached->data;
}
else {
foreach (module_implements('theme') as $module) {
_theme_process_registry($cache, $module, 'module', $module, drupal_get_path('module', $module));
}
// Only cache this registry if all modules are loaded.
if (module_load_all(NULL)) {
cache()->set("theme_registry:build:modules", $cache, CacheBackendInterface::CACHE_PERMANENT, array('theme_registry' => TRUE));
Angie Byron
committed
}
Dries Buytaert
committed
}
// 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;
}
Jennifer Hodgdon
committed
* Returns 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.
Dries Buytaert
committed
*
* An associative array of the currently available themes. The keys are the
Jennifer Hodgdon
committed
* themes' machine names and the values are objects having the following
* properties:
Jennifer Hodgdon
committed
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
* - filename: The filepath and name of the .info file.
* - name: The machine 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). Not set if no stylesheets are defined in the
* .info file.
* - scripts: An associative array of JavaScripts, using the filename as key
* and the complete filepath as value. Not set if no scripts are defined in
* the .info file.
* - prefix: The base theme engine prefix.
* - engine: The machine name of the theme engine.
* - base_theme: If this is a sub-theme, the machine name of the base theme
* defined in the .info file. Otherwise, the element is not set.
* - base_themes: If this is a sub-theme, an associative array of the
* base-theme ancestors of this theme, starting with this theme's base
* theme, then the base theme's own base theme, etc. Each entry has an
* array key equal to the theme's machine name, and a value equal to the
* human-readable theme name; if a theme with matching machine name does
* not exist in the system, the value will instead be NULL (and since the
* system would not know whether that theme itself has a base theme, that
* will end the array of base themes). This is not set if the theme is not
* a sub-theme.
* - sub_themes: An associative array of themes on the system that are
* either direct sub-themes (that is, they declare this theme to be
* their base theme), direct sub-themes of sub-themes, etc. The keys are
* the themes' machine names, and the values are the themes' human-readable
* names. This element is not set if there are no themes on the system that
* declare this theme as their base theme.
Jennifer Hodgdon
committed
*/
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')) {
try {
$themes = system_list('theme');
}
Angie Byron
committed
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.
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) {
Dries Buytaert
committed
$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;
Jennifer Hodgdon
committed
* Finds all the base themes for the specified theme.
Jennifer Hodgdon
committed
* Themes can inherit templates and function implementations from earlier
* themes.
*
* @param $themes
* An array of available themes.
* @param $key
* The name of the theme whose base we are looking for.
* @param $used_keys
Jennifer Hodgdon
committed
* (optional) A recursion parameter preventing endless loops. Defaults to
* NULL.
*
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
* @return
* Returns an array of all of the theme's ancestors; the first element's value
* will be NULL if an error occurred.
*/
function drupal_find_base_themes($themes, $key, $used_keys = array()) {
$base_key = $themes[$key]->info['base theme'];
// Does the base theme exist?
if (!isset($themes[$base_key])) {
return array($base_key => NULL);
}
$current_base_theme = array($base_key => $themes[$base_key]->info['name']);
// Is the base theme itself a child of another theme?
if (isset($themes[$base_key]->info['base theme'])) {
// Do we already know the base themes of this theme?
if (isset($themes[$base_key]->base_themes)) {
return $themes[$base_key]->base_themes + $current_base_theme;
}
// Prevent loops.
if (!empty($used_keys[$base_key])) {
return array($base_key => NULL);
}
$used_keys[$base_key] = TRUE;
return drupal_find_base_themes($themes, $base_key, $used_keys) + $current_base_theme;
}
// If we get here, then this is our parent theme.
return $current_base_theme;
}
Dries Buytaert
committed
* Generates themed output.
*
* All requests for themed output must go through this function. It examines
* the request and routes it to the appropriate
* @link themeable theme function or template @endlink, by checking the theme
* registry.
Dries Buytaert
committed
*
Jennifer Hodgdon
committed
* Most commonly, the first argument to this function is the name of the theme
* hook. For instance, to theme a taxonomy term, the theme hook name is
* 'taxonomy_term'. Modules register theme hooks within a hook_theme()
* implementation and provide a default implementation via a function named
* theme_HOOK() (e.g., theme_taxonomy_term()) or via a template file named
* according to the value of the 'template' key registered with the theme hook
* (see hook_theme() for details). Default templates are implemented with the
* PHPTemplate rendering engine and are named the same as the theme hook, with
* underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
* default template is 'taxonomy-term.tpl.php'.
*
* Themes may also register new theme hooks within a hook_theme()
* implementation, but it is more common for themes to override default
* implementations provided by modules than to register entirely new theme
* hooks. Themes can override a default implementation by implementing a
* function named THEME_HOOK() (for example, the 'bartik' theme overrides the
* default implementation of the 'menu_tree' theme hook by implementing a
* bartik_menu_tree() function), or by adding a template file within its folder
* structure that follows the template naming structure used by the theme's
* rendering engine (for example, since the Bartik theme uses the PHPTemplate
* rendering engine, it overrides the default implementation of the 'page' theme
* hook by containing a 'page.tpl.php' file within its folder structure).
Dries Buytaert
committed
*
* 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):
Jennifer Hodgdon
committed
* - template_preprocess(&$variables, $hook): Creates a default set of
* variables for all theme hooks with template implementations.
Jennifer Hodgdon
committed
* - template_preprocess_HOOK(&$variables): Should be implemented by the module
* that registers the theme hook, to set up default variables.
Dries Buytaert
committed
* - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
* implementing modules.
* - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
Jennifer Hodgdon
committed
* all implementing modules, so that modules that didn't define the theme
* hook can alter the variables.
Dries Buytaert
committed
* - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
Jennifer Hodgdon
committed
* set necessary variables for all theme hooks with template implementations.
Dries Buytaert
committed
* - 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
Jennifer Hodgdon
committed
* variables for all theme hooks with template implementations.
Dries Buytaert
committed
* - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
* variables specific to the particular theme hook.
Jennifer Hodgdon
committed
* - template_process(&$variables, $hook): Creates an additional set of default
* variables for all theme hooks with template implementations. The variables
* created in this function are derived from ones created by
* template_preprocess(), but potentially altered by the other preprocess
* functions listed above. For example, any preprocess function can add to or
* modify the $variables['attributes_array'] variable, and after all of them
* have finished executing, template_process() flattens it into a
* $variables['attributes'] string for convenient use by templates.
* - template_process_HOOK(&$variables): Should be implemented by the module
* that registers the theme hook, if it needs to perform additional variable
* processing after all preprocess functions have finished.
Dries Buytaert
committed
* - 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.
Jennifer Hodgdon
committed
* - ENGINE_engine_process(&$variables, $hook): Allows the theme engine to
* process variables for all theme hooks with template implementations.
* - ENGINE_engine_process_HOOK(&$variables): Allows the theme engine to process
* the variables specific to the theme hook.
Dries Buytaert
committed
* - THEME_process(&$variables, $hook): Allows the theme to process the
Jennifer Hodgdon
committed
* variables for all theme hooks with template implementations.
Dries Buytaert
committed
* - 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
Angie Byron
committed
* and process functions (the ones ending in _HOOK) are called from the
Dries Buytaert
committed
* 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.
Angie Byron
committed
*
Angie Byron
committed
* There are two special variables that these preprocess and process functions
Dries Buytaert
committed
* 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.
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
Jennifer Hodgdon
committed
* 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
Angie Byron
committed
* 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
Dries Buytaert
committed
* may also be an array, in which case the first theme hook that has an
Angie Byron
committed
* implementation is used. This allows for the code that calls theme() to
* explicitly specify the fallback order in a situation where using the '__'
Dries Buytaert
committed
* convention is not desired or is 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.
Dries Buytaert
committed
* Alternatively, this can be a renderable array, in which case, its
* properties are mapped to variables expected by the theme hook
* implementations.
Dries Buytaert
committed
*
Dries Buytaert
committed
* An HTML string representing the themed output.
*
* @see themeable
Jennifer Hodgdon
committed
* @see hook_theme()
* @see template_preprocess()
* @see template_process()
Dries Buytaert
committed
function theme($hook, $variables = array()) {
Dries Buytaert
committed
// 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.'));
}
$hooks = theme_get_registry(FALSE);
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;
}
// Save the original theme hook, so it can be supplied to theme variable
// preprocess callbacks.
$original_hook = $hook;
Dries Buytaert
committed
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])) {
Dries Buytaert
committed
// Only log a message when not trying theme suggestions ($hook being an
// array).
if (!isset($candidate)) {
watchdog('theme', 'Theme hook %hook not found.', array('%hook' => $hook), WATCHDOG_WARNING);
Dries Buytaert
committed
}
Angie Byron
committed
return '';
}