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.
*/
Dries Buytaert
committed
use Drupal\Component\Utility\String;
Dries Buytaert
committed
use Drupal\Component\Utility\UrlHelper;
use Drupal\Core\Config\Config;
use Drupal\Core\Language\Language;
catch
committed
use Drupal\Core\Extension\Extension;
use Drupal\Core\Extension\ExtensionNameLengthException;
use Drupal\Core\Template\Attribute;
use Drupal\Core\Template\RenderWrapper;
use Drupal\Core\Theme\ThemeSettings;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Render\Element;
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.
*
catch
committed
* @param string|\Drupal\Core\Extension\Extension $theme
Angie Byron
committed
* Either the name of a theme or a full theme object.
*
catch
committed
* @return bool
Dries Buytaert
committed
* Boolean TRUE if the theme is enabled or is the site administration theme;
* FALSE otherwise.
Angie Byron
committed
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Drupal::service('access_check.theme')->checkAccess().
*
* @see \Drupal\Core\Theme\ThemeAccessCheck::checkAccess().
Dries Buytaert
committed
*/
function drupal_theme_access($theme) {
catch
committed
if ($theme instanceof Extension) {
$theme = $theme->name;
Angie Byron
committed
}
Alex Pott
committed
return \Drupal::service('access_check.theme')->checkAccess($theme);
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;
}
$themes = list_themes();
// @todo Let the theme.negotiator listen to the kernel request event.
// Determine the active theme for the theme negotiator service. This includes
// the default theme as well as really specific ones like the ajax base theme.
$request = \Drupal::request();
$theme = \Drupal::service('theme.negotiator')->determineActiveTheme($request) ?: 'stark';
// 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));
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
*
catch
committed
* @param \Drupal\Core\Extension\Extension $theme
* The theme extension object.
* @param \Drupal\Core\Extension\Extension[] $base_theme
Dries Buytaert
committed
* 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.
*/
function _drupal_theme_initialize($theme, $base_theme = array()) {
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);
Dries Buytaert
committed
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
catch
committed
// And now add the stylesheets properly.
$css = array();
Gábor Hojtsy
committed
foreach ($final_stylesheets as $media => $stylesheets) {
foreach ($stylesheets as $stylesheet) {
catch
committed
$css['#attached']['css'][$stylesheet] = array(
'group' => CSS_AGGREGATE_THEME,
'every_page' => TRUE,
'media' => $media
);
Gábor Hojtsy
committed
}
}
catch
committed
drupal_render($css);
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.
$js = array();
Gábor Hojtsy
committed
foreach ($final_scripts as $script) {
$js['#attached']['js'][] = array(
'data' => $script,
'group' => JS_THEME,
'every_page' => TRUE,
);
Gábor Hojtsy
committed
}
drupal_render($js);
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;
// Always include Twig as the default theme engine.
Dries Buytaert
committed
include_once DRUPAL_ROOT . '/core/themes/engines/twig/twig.engine';
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) {
$theme_registry = \Drupal::service('theme.registry');
if ($complete) {
return $theme_registry->get();
Dries Buytaert
committed
}
else {
return $theme_registry->getRuntime();
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::service('theme.registry')->reset();
Dries Buytaert
committed
}
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
*
Angie Byron
committed
* @return array
* An associative array of the currently available themes.
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Drupal::service('theme_handler')->listInfo().
*
* @see \Drupal\Core\Extension\ThemeHandler::listInfo().
*/
function list_themes($refresh = FALSE) {
/** @var \Drupal\Core\Extension\ThemeHandler $theme_handler */
$theme_handler = \Drupal::service('theme_handler');
$theme_handler->reset();
Dries Buytaert
committed
system_list_reset();
return $theme_handler->listInfo();
Dries Buytaert
committed
* Generates themed output.
*
* All requests for themed output must go through this function (however,
* calling the _theme() function directly is very strongly discouraged - see
* next paragraph). 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
*
* Avoid calling this function directly. It is preferable to replace direct
* calls to the _theme() function with calls to drupal_render() by passing a
* render array with a #theme key to drupal_render(), which in turn calls
* _theme().
*
* @section sec_theme_hooks Theme Hooks
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
* Twig rendering engine and are named the same as the theme hook, with
Jennifer Hodgdon
committed
* underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
Angie Byron
committed
* default template is 'taxonomy-term.html.twig'.
Jennifer Hodgdon
committed
*
* @subsection sub_overriding_theme_hooks Overriding Theme Hooks
Jennifer Hodgdon
committed
* 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 Twig rendering
* engine, it overrides the default implementation of the 'page' theme hook by
* containing a 'page.html.twig' file within its folder structure).
Dries Buytaert
committed
*
* @subsection sub_preprocess_templates Preprocessing for Template Files
* If the implementation is a template file, several functions are called before
* the template file is invoked to modify the $variables array. These make up
* the "preprocessing" 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 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
* 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.
*
* @subsection sub_preprocess_theme_funcs Preprocessing for Theme Functions
Dries Buytaert
committed
* If the implementation is a function, only the theme-hook-specific preprocess
* 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 functions for them would incur
* a noticeable performance penalty.
Angie Byron
committed
*
* @subsection sub_alternate_suggestions Suggesting Alternate Hooks
* Alternate hooks can be suggested by implementing the hook-specific
* hook_theme_suggestions_HOOK_alter() or the generic
* hook_theme_suggestions_alter(). These alter hooks are used to manipulate an
* array of suggested alternate theme hooks to use, in reverse order of
* priority. _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 altering the suggestions via the suggestion alter hooks.
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
Jennifer Hodgdon
committed
* 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
Angie Byron
committed
* 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
* implementation is used. This allows for the code that calls _theme() to
Angie Byron
committed
* 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 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.
Dries Buytaert
committed
*
* @return string|false
* An HTML string representing the themed output or FALSE if the passed $hook
* is not implemented.
*
* @see drupal_render()
* @see themeable
Jennifer Hodgdon
committed
* @see hook_theme()
* @see template_preprocess()
function _theme($hook, $variables = array()) {
static $default_attributes;
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 \Drupal\Core\Theme\Registry::get().
if (!\Drupal::moduleHandler()->isLoaded() && !defined('MAINTENANCE_MODE')) {
throw new Exception(t('_theme() may not be called until all modules are loaded.'));
Dries Buytaert
committed
}
/** @var \Drupal\Core\Utility\ThemeRegistry $theme_registry */
$theme_registry = \Drupal::service('theme.registry')->getRuntime();
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 ($theme_registry->has($candidate)) {
Dries Buytaert
committed
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.
if (!$theme_registry->has($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 ($theme_registry->has($hook)) {
Angie Byron
committed
break;
}
}
if (!$theme_registry->has($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
}
// There is no theme implementation for the hook passed. Return FALSE so
// the function calling _theme() can differentiate between a hook that
// exists and renders an empty string and a hook that is not implemented.
return FALSE;
Angie Byron
committed
}
}
$info = $theme_registry->get($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'];
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) {
if (isset($element["#$name"]) || array_key_exists("#$name", $element)) {
Dries Buytaert
committed
$variables[$name] = $element["#$name"];
}
Angie Byron
committed
}
}
else {
$variables[$info['render element']] = $element;
// Give a hint to render engines to prevent infinite recursion.
$variables[$info['render element']]['#render_children'] = TRUE;
}
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
}
// Supply original caller info.
$variables += array(
'theme_hook_original' => $original_hook,
);
Angie Byron
committed
// Set base hook for later use. For example if '#theme' => 'node__article'
// is called, we run hook_theme_suggestions_node_alter() rather than
// hook_theme_suggestions_node__article_alter(), and also pass in the base
// hook as the last parameter to the suggestions alter hooks.
if (isset($info['base hook'])) {
$base_theme_hook = $info['base hook'];
}
else {
$base_theme_hook = $hook;
}
// Invoke hook_theme_suggestions_HOOK().
$suggestions = Drupal::moduleHandler()->invokeAll('theme_suggestions_' . $base_theme_hook, array($variables));
// If _theme() was invoked with a direct theme suggestion like
// '#theme' => 'node__article', add it to the suggestions array before
// invoking suggestion alter hooks.
if (isset($info['base hook'])) {
$suggestions[] = $hook;
}
// Invoke hook_theme_suggestions_alter() and
// hook_theme_suggestions_HOOK_alter().
$hooks = array(
'theme_suggestions',
'theme_suggestions_' . $base_theme_hook,
);
\Drupal::moduleHandler()->alter($hooks, $suggestions, $variables, $base_theme_hook);
// Check if each suggestion exists in the theme registry, and if so,
// use it instead of the hook that _theme() was called with. For example, a
// function may call _theme('node', ...), but a module can add
// 'node__article' as a suggestion via hook_theme_suggestions_HOOK_alter(),
// enabling a theme to have an alternate template file for article nodes.
foreach (array_reverse($suggestions) as $suggestion) {
if ($theme_registry->has($suggestion)) {
$info = $theme_registry->get($suggestion);
break;
}
}
catch
committed
// Include a file if the theme function or variable preprocessor is held
// elsewhere.
if (!empty($info['includes'])) {
foreach ($info['includes'] as $include_file) {
include_once DRUPAL_ROOT . '/' . $include_file;
}
}
// Invoke the variable preprocessors, if any.
Angie Byron
committed
if (isset($info['base hook'])) {
$base_hook = $info['base hook'];
$base_hook_info = $theme_registry->get($base_hook);
// Include files required by the base hook, since its variable preprocessors
// might reside there.
if (!empty($base_hook_info['includes'])) {
foreach ($base_hook_info['includes'] as $include_file) {
include_once DRUPAL_ROOT . '/' . $include_file;
}
}
// Replace the preprocess functions with those from the base hook.
if (isset($base_hook_info['preprocess functions'])) {
// Set a variable for the 'theme_hook_suggestion'. This is used to
// maintain backwards compatibility with template engines.
$theme_hook_suggestion = $hook;
$info['preprocess functions'] = $base_hook_info['preprocess functions'];
Angie Byron
committed
}
}
if (isset($info['preprocess functions'])) {
foreach ($info['preprocess functions'] as $preprocessor_function) {
if (function_exists($preprocessor_function)) {
$preprocessor_function($variables, $hook, $info);
Angie Byron
committed
}
Dries Buytaert
committed
}
}
Angie Byron
committed
Dries Buytaert
committed
// Generate the output using either a function or a template.
Dries Buytaert
committed
$output = '';
Dries Buytaert
committed
if (isset($info['function'])) {
if (function_exists($info['function'])) {
Dries Buytaert
committed
$output = $info['function']($variables);
Dries Buytaert
committed
else {
$render_function = 'twig_render_template';
$extension = '.html.twig';
Dries Buytaert
committed
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
Angie Byron
committed
// they don't already exist. We don't want the overhead of running
// template_preprocess() twice, 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.
Dries Buytaert
committed
if (!isset($variables['directory'])) {
$default_template_variables = array();
Alex Pott
committed
template_preprocess($default_template_variables, $hook, $info);
Dries Buytaert
committed
$variables += $default_template_variables;
}
if (!isset($default_attributes)) {
$default_attributes = new Attribute();
}
foreach (array('attributes', 'title_attributes', 'content_attributes') as $key) {
if (isset($variables[$key]) && !($variables[$key] instanceof Attribute)) {
if ($variables[$key]) {
$variables[$key] = new Attribute($variables[$key]);
}
else {
// Create empty attributes.
$variables[$key] = clone $default_attributes;
}
}
}
Dries Buytaert
committed
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
}
// Add the theme suggestions to the variables array just before rendering
// the template for backwards compatibility with template engines.
$variables['theme_hook_suggestions'] = $suggestions;
// For backwards compatibility, pass 'theme_hook_suggestion' on to the
// template engine. This is only set when calling a direct suggestion like
// '#theme' => 'menu_tree__shortcut_default' when the template exists in the
// current theme.
if (isset($theme_hook_suggestion)) {
$variables['theme_hook_suggestion'] = $theme_hook_suggestion;
}
Dries Buytaert
committed
$output = $render_function($template_file, $variables);
Dries Buytaert
committed
Dries Buytaert
committed
// restore path_to_theme()
$theme_path = $temp;
Alex Pott
committed
return (string) $output;
Dries Buytaert
committed
}
Jennifer Hodgdon
committed
* Returns 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
/**
Jennifer Hodgdon
committed
* Allows themes and/or theme engines to 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.
*
Angie Byron
committed
* @return $implementations
Dries Buytaert
committed
* The functions found, suitable for returning from hook_theme;
*/
function drupal_find_theme_functions($cache, $prefixes) {
Angie Byron
committed
$implementations = array();
Dries Buytaert
committed
$functions = get_defined_functions();
foreach ($cache as $hook => $info) {
foreach ($prefixes as $prefix) {
Angie Byron
committed
// 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
Dries Buytaert
committed
// the same base hook. To keep things simple, deep hierarchy of
Angie Byron
committed
// 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.
Angie Byron
committed
$pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
Angie Byron
committed
if (!isset($info['base hook']) && !empty($pattern)) {
Angie Byron
committed
$matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
Dries Buytaert
committed
if ($matches) {
foreach ($matches as $match) {
Dries Buytaert
committed
$new_hook = substr($match, strlen($prefix) + 1);
$arg_name = isset($info['variables']) ? 'variables' : 'render element';
Angie Byron
committed
$implementations[$new_hook] = array(
Dries Buytaert
committed
'function' => $match,
$arg_name => $info[$arg_name],
Angie Byron
committed
'base hook' => $hook,
Dries Buytaert
committed
);
}
}
}
Angie Byron
committed
// 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)) {
Angie Byron
committed
$implementations[$hook] = array(
'function' => $prefix . '_' . $hook,
Dries Buytaert
committed
);
}
}
}
Angie Byron
committed
return $implementations;
Dries Buytaert
committed
}
/**
Jennifer Hodgdon
committed
* Allows themes and/or theme engines to easily discover overridden templates.
Dries Buytaert
committed
*
* @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) {
Angie Byron
committed
$implementations = array();
Dries Buytaert
committed
// 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();
Gábor Hojtsy
committed
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]);
}
Gábor Hojtsy
committed
}
}
global $theme;
$subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
Gábor Hojtsy
committed
// Escape the periods in the extension.
$regex = '/' . str_replace('.', '\.', $extension) . '$/';
Angie Byron
committed
// Get a listing of all template files in the path to search.
Angie Byron
committed
$files = file_scan_directory($path, $regex, array('key' => 'filename'));
Angie Byron
committed
// 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.
Dries Buytaert
committed
foreach ($files as $template => $file) {
// Ignore sub-theme templates for the current theme.
if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
Gábor Hojtsy
committed
continue;
}
Angie Byron
committed
// Remove the extension from the filename.
$template = str_replace($extension, '', $template);
// Transform - in filenames to _ to match function naming scheme
// for the purposes of searching.
$hook = strtr($template, '-', '_');
if (isset($cache[$hook])) {
Angie Byron
committed
$implementations[$hook] = array(
'template' => $template,
'path' => dirname($file->uri),
Dries Buytaert
committed
);
}
// Match templates based on the 'template' filename.
foreach ($cache as $hook => $info) {
if (isset($info['template'])) {
$template_candidates = array($info['template'], str_replace($info['theme path'] . '/templates/', '', $info['template']));
if (in_array($template, $template_candidates)) {
$implementations[$hook] = array(
'template' => $template,
'path' => dirname($file->uri),
);
}
}
}
Dries Buytaert
committed
}
Angie Byron
committed
// Find templates that implement possible "suggestion" variants of registered
Dries Buytaert
committed
// theme hooks and add those as new registered theme hooks. See
Angie Byron
committed
// drupal_find_theme_functions() for more information about suggestions and
// the use of 'pattern' and 'base hook'.
Dries Buytaert
committed
$patterns = array_keys($files);
foreach ($cache as $hook => $info) {
Angie Byron
committed
$pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
Angie Byron
committed
if (!isset($info['base hook']) && !empty($pattern)) {
// Transform _ in pattern to - to match file naming scheme
// for the purposes of searching.
Angie Byron
committed
$pattern = strtr($pattern, '_', '-');
$matches = preg_grep('/^' . $pattern . '/', $patterns);
Dries Buytaert
committed
if ($matches) {
foreach ($matches as $match) {
Dries Buytaert
committed
$file = $match;
Angie Byron
committed
// Remove the extension from the filename.
$file = str_replace($extension, '', $file);
Jennifer Hodgdon
committed
// Put the underscores back in for the hook name and register this
// pattern.
$arg_name = isset($info['variables']) ? 'variables' : 'render element';
Angie Byron
committed
$implementations[strtr($file, '-', '_')] = array(
'template' => $file,
'path' => dirname($files[$match]->uri),
$arg_name => $info[$arg_name],
Angie Byron
committed
'base hook' => $hook,
Dries Buytaert
committed
);
}
}
}
}
Angie Byron
committed
return $implementations;
Dries Buytaert
committed
}
Jennifer Hodgdon
committed
* Retrieves a setting for the current theme or for a given theme.
Dries Buytaert
committed
* The final setting is obtained from the last value found in the following
* sources:
* - the default theme-specific settings defined in any base theme's .info.yml
* file
* - the default theme-specific settings defined in the theme's .info.yml file
Dries Buytaert
committed
* - 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.
Dries Buytaert
committed
* The name of the setting to be retrieved.
Dries Buytaert
committed
* @param $theme
Dries Buytaert
committed
* 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.
*/
Dries Buytaert
committed
function theme_get_setting($setting_name, $theme = NULL) {
$cache = &drupal_static(__FUNCTION__, array());
Dries Buytaert
committed
// If no key is given, use the current theme if we can determine it.
if (!isset($theme)) {
Dries Buytaert
committed
$theme = !empty($GLOBALS['theme_key']) ? $GLOBALS['theme_key'] : '';
Dries Buytaert
committed
}
Dries Buytaert
committed
if (empty($cache[$theme])) {
// Create a theme settings object.
$cache[$theme] = new ThemeSettings($theme);
Dries Buytaert
committed
// Get the values for the theme-specific settings from the .info.yml files
// of the theme and all its base themes.
Dries Buytaert
committed
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;
Dries Buytaert
committed
else {
$theme_keys = array($theme);
}
foreach ($theme_keys as $theme_key) {
if (!empty($themes[$theme_key]->info['settings'])) {
$cache[$theme]->mergeData($themes[$theme_key]->info['settings']);
Dries Buytaert
committed
}
// Get the global settings from configuration.
$cache[$theme]->mergeData(\Drupal::config('system.theme.global')->get());
Dries Buytaert
committed
if ($theme) {
// Get the saved theme-specific settings from the configuration system.
$cache[$theme]->mergeData(\Drupal::config($theme . '.settings')->get());
Dries Buytaert
committed
// If the theme does not support a particular feature, override the global
// setting and set the value to NULL.
//$supports = $cache[$theme]->get('supports');
if (!empty($theme_object->info['features'])) {
foreach (_system_default_theme_features() as $feature) {
if (!in_array($feature, $theme_object->info['features'])) {
$cache[$theme]->set('features.' . $feature, NULL);
}
}
}
Dries Buytaert
committed
// Generate the path to the logo image.
if ($cache[$theme]->get('features.logo')) {
$logo_path = $cache[$theme]->get('logo.path');
if ($cache[$theme]->get('logo.use_default')) {
$cache[$theme]->set('logo.url', file_create_url(dirname($theme_object->filename) . '/logo.png'));
elseif ($logo_path) {
$cache[$theme]->set('logo.url', file_create_url($logo_path));
Dries Buytaert
committed
// Generate the path to the favicon.
if ($cache[$theme]->get('features.favicon')) {
$favicon_path = $cache[$theme]->get('favicon.path');
if ($cache[$theme]->get('favicon.use_default')) {
if (file_exists($favicon = dirname($theme_object->filename) . '/favicon.ico')) {
$cache[$theme]->set('favicon.url', file_create_url($favicon));
Dries Buytaert
committed
}
else {
$cache[$theme]->set('favicon.url', file_create_url('core/misc/favicon.ico'));
Dries Buytaert
committed
}
}
elseif ($favicon_path) {
$cache[$theme]->set('favicon.url', file_create_url($favicon_path));
Dries Buytaert
committed
}
else {
$cache[$theme]->set('features.favicon', FALSE);
Dries Buytaert
committed
}
Dries Buytaert
committed
}
return $cache[$theme]->get($setting_name);
}
/**
* Converts theme settings to configuration.
*
* @see system_theme_settings_submit()
*
* @param array $theme_settings
* An array of theme settings from system setting form or a Drupal 7 variable.
* @param Config $config
* The configuration object to update.
*
* @return
* The Config object with updated data.