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.
*/
Alex Pott
committed
use Drupal\Component\Serialization\Json;
use Drupal\Component\Utility\SafeMarkup;
Dries Buytaert
committed
use Drupal\Component\Utility\String;
use Drupal\Component\Utility\UrlHelper;
Angie Byron
committed
use Drupal\Component\Utility\Xss;
use Drupal\Core\Config\Config;
Alex Pott
committed
use Drupal\Core\Config\StorageException;
catch
committed
use Drupal\Core\Extension\Extension;
use Drupal\Core\Extension\ExtensionNameLengthException;
catch
committed
use Drupal\Core\Page\FeedLinkElement;
use Drupal\Core\Page\LinkElement;
use Drupal\Core\Page\MetaElement;
use Drupal\Core\Template\Attribute;
use Drupal\Core\Theme\ThemeSettings;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Render\Element;
use Symfony\Component\HttpFoundation\Request;
Angie Byron
committed
Dries Buytaert
committed
/**
* @defgroup content_flags Content markers
Dries Buytaert
committed
* @{
* Markers used by mark.html.twig and node_mark() to designate content.
*
* @see mark.html.twig
* @see node_mark()
Dries Buytaert
committed
*/
/**
* 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
catch
committed
* Boolean TRUE if the theme is installed or is the site administration theme;
Dries Buytaert
committed
* 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->getName();
Angie Byron
committed
}
Alex Pott
committed
return \Drupal::service('access_check.theme')->checkAccess($theme);
Angie Byron
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) {
$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();
Angie Byron
committed
* Generates themed output (internal use only).
Dries Buytaert
committed
*
Angie Byron
committed
* _theme() is an internal function. Do not call this function directly as it
* will prevent the following items from working correctly:
* - Render caching.
* - JavaScript and CSS asset attachment.
* - Pre / post render hooks.
* - Defaults provided by hook_element_info(), including attached assets.
* Instead, build a render array with a #theme key, and either return the
* array (where possible) or call drupal_render() to convert it to HTML.
Dries Buytaert
committed
*
Angie Byron
committed
* All requests for themed output must go through this function, which is
* invoked as part of the @link theme_render drupal_render() process @endlink.
* The appropriate theme function is indicated by the #theme property
* of a renderable array. _theme() examines the request and routes it to the
* appropriate @link themeable theme function or template @endlink, by checking
* the theme registry.
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;
$module_handler = \Drupal::moduleHandler();
$active_theme = \Drupal::theme()->getActiveTheme();
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 (!$module_handler->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)) {
Angie Byron
committed
\Drupal::logger('theme')->warning('Theme hook %hook not found.', array('%hook' => $hook));
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
// 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 = $module_handler->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,
);
$module_handler->alter($hooks, $suggestions, $variables, $base_theme_hook);
\Drupal::theme()->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'])) {
$output = SafeMarkup::set($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.
$theme_engine = $active_theme->getEngine();
Dries Buytaert
committed
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
Alex Pott
committed
return (string) $output;
Dries Buytaert
committed
}
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->getName()] = $theme_info->getPath();
}
}
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
}
}
$theme = \Drupal::theme()->getActiveTheme()->getName();
$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)) {
$theme = \Drupal::theme()->getActiveTheme()->getName();
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.
$themes = list_themes();
if ($theme && isset($themes[$theme])) {
Dries Buytaert
committed
$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);
}
Alex Pott
committed
// Read hard-coded default settings from the theme info files.
Dries Buytaert
committed
foreach ($theme_keys as $theme_key) {
if (!empty($themes[$theme_key]->info['settings'])) {
$cache[$theme]->merge($themes[$theme_key]->info['settings']);
Dries Buytaert
committed
}
// Get the global settings from configuration.
$cache[$theme]->merge(\Drupal::config('system.theme.global')->get());
Dries Buytaert
committed
if ($theme && isset($themes[$theme])) {
Alex Pott
committed
// Retrieve configured theme-specific settings, if any.
try {
if ($theme_settings = \Drupal::config($theme . '.settings')->get()) {
$cache[$theme]->merge($theme_settings);
}
}
catch (StorageException $e) {
}
Dries Buytaert
committed
// 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 (_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($theme_object->getPath() . '/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 = $theme_object->getPath() . '/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
}
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
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.
*/
function theme_settings_convert_to_config(array $theme_settings, Config $config) {
foreach ($theme_settings as $key => $value) {
if ($key == 'default_logo') {
$config->set('logo.use_default', $value);
}
else if ($key == 'logo_path') {
$config->set('logo.path', $value);
}
else if ($key == 'default_favicon') {
$config->set('favicon.use_default', $value);
}
else if ($key == 'favicon_path') {
$config->set('favicon.path', $value);
}
else if ($key == 'favicon_mimetype') {
$config->set('favicon.mimetype', $value);
}
else if (substr($key, 0, 7) == 'toggle_') {
$config->set('features.' . drupal_substr($key, 7), $value);
}
else if (!in_array($key, array('theme', 'logo_upload'))) {
$config->set($key, $value);
}
}
return $config;
Dries Buytaert
committed
/**
* @addtogroup themeable
Dries Buytaert
committed
/**
* Prepares variables for time templates.
*
* Default template: time.html.twig.
Dries Buytaert
committed
*
* @param array $variables
Dries Buytaert
committed
* An associative array possibly containing:
Dries Buytaert
committed
* - attributes['timestamp']:
* - timestamp:
* - text:
function template_preprocess_time(&$variables) {
// Format the 'datetime' attribute based on the timestamp.
// @see http://www.w3.org/TR/html5-author/the-time-element.html#attr-time-datetime
if (!isset($variables['attributes']['datetime']) && isset($variables['timestamp'])) {
$variables['attributes']['datetime'] = format_date($variables['timestamp'], 'html_datetime', '', 'UTC');
}
// If no text was provided, try to auto-generate it.
if (!isset($variables['text'])) {
// Format and use a human-readable version of the timestamp, if any.
if (isset($variables['timestamp'])) {
$variables['text'] = format_date($variables['timestamp']);
$variables['html'] = FALSE;
}
// Otherwise, use the literal datetime attribute.
elseif (isset($variables['attributes']['datetime'])) {
$variables['text'] = $variables['attributes']['datetime'];
$variables['html'] = FALSE;
}
}
}
Angie Byron
committed
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
/**
* Prepares variables for datetime form element templates.
*
* The datetime form element serves as a wrapper around the date element type,
* which creates a date and a time component for a date.
*
* Default template: datetime-form.html.twig.
*
* @param array $variables
* An associative array containing:
* - element: An associative array containing the properties of the element.
* Properties used: #title, #value, #options, #description, #required,
* #attributes.
*
* @see form_process_datetime()
*/
function template_preprocess_datetime_form(&$variables) {
$element = $variables['element'];
$variables['attributes'] = array();
if (isset($element['#id'])) {
$variables['attributes']['id'] = $element['#id'];
}
if (!empty($element['#attributes']['class'])) {
$variables['attributes']['class'] = (array) $element['#attributes']['class'];
}
$variables['content'] = $element;
}
/**
* Prepares variables for datetime form wrapper templates.
*
* Default template: datetime-wrapper.html.twig.
*
* @param array $variables
* An associative array containing:
* - element: An associative array containing the properties of the element.
* Properties used: #title, #children, #required, #attributes.
*/
function template_preprocess_datetime_wrapper(&$variables) {
$element = $variables['element'];
if (!empty($element['#title'])) {
$variables['title'] = $element['#title'];
}
if (!empty($element['#description'])) {
$variables['description'] = $element['#description'];
}
Alex Pott
committed
$variables['required'] = FALSE;
Angie Byron
committed
// For required datetime fields a 'form-required' class is appended to the
// label attributes.
if (!empty($element['#required'])) {
Alex Pott
committed
$variables['required'] = TRUE;
Angie Byron
committed
}
$variables['content'] = $element['#children'];
}
* Prepares variables for status message templates.
* Default template: status-messages.html.twig.
Angie Byron
committed
*
* @param array $variables
Dries Buytaert
committed
* An associative array containing:
* - display: (optional) May have a value of 'status' or 'error' when only
* displaying messages of that specific type.
function template_preprocess_status_messages(&$variables) {
$variables['message_list'] = drupal_get_messages($variables['display']);
$variables['status_headings'] = array(
Angie Byron
committed
'status' => t('Status message'),
'error' => t('Error message'),
'warning' => t('Warning message'),
);
* Prepares variables for links templates.
* Default template: links.html.twig.
*
* @param array $variables
Dries Buytaert
committed
* An associative array containing:
* - links: An associative array of links to be themed. The key for each link
Dries Buytaert
committed
* is used as its CSS class. Each link should be itself an array, with the
* following elements:
* - title: The link text.
Jennifer Hodgdon
committed
* - route_name: (optional) The name of the route to link to. If omitted
* (and if 'href' is omitted as well), the 'title' is shown as
* a plain text item in the links list.
* - route_parameters: (optional) An array of route parameters for the link.
* - href: (optional) The link URL. It is preferred to use 'route_name' and
* 'route parameters' for internal links. Use 'href' for links to external
* URLs. If omitted (and if 'route_name' is omitted as well), the 'title'
* is shown as a plain text item in the links list.
* - html: (optional) Whether or not 'title' is HTML. If set, the title
Angie Byron
committed
* will not be passed through
* \Drupal\Component\Utility\String::checkPlain().
Jennifer Hodgdon
committed
* - attributes: (optional) Attributes for the anchor, or for the <span>
* tag used in its place if no 'href' is supplied. If element 'class' is
* included, it must be an array of one or more class names.
Jennifer Hodgdon
committed
* If the 'href' element is supplied, the entire link array is passed to
* l() as its $options parameter.
* - attributes: A keyed array of attributes for the UL containing the
* list of links.
* - set_active_class: (optional) Whether each link should compare the
* route_name + route_parameters or href (path), language and query options
* to the current URL, to determine whether the link is "active". If so, an
* "active" class will be applied to the list item containing the link, as
* well as the link itself. It is important to use this sparingly since it
* is usually unnecessary and requires extra processing.
* For anonymous users, the "active" class will be calculated on the server,
* because most sites serve each anonymous user the same cached page anyway.
* For authenticated users, the "active" class will be calculated on the
* client (through JavaScript), only data- attributes are added to list
* items and contained links, to prevent breaking the render cache. The
* JavaScript is added in system_page_build().
Jennifer Hodgdon
committed
* - heading: (optional) A heading to precede the links. May be an
* associative array or a string. If it's an array, it can have the
* following elements:
* - text: The heading text.
* - level: The heading level (e.g. 'h2', 'h3').
Alex Pott
committed
* - attributes: (optional) An array of the CSS attributes for the heading.
Dries Buytaert
committed
* When using a string it will be used as the text of the heading and the
* level will default to 'h2'. Headings should be used on navigation menus
* and any list of links that consistently appears on multiple pages. To
* make the heading invisible use the 'visually-hidden' CSS class. Do not
* use 'display:none', which removes it from screen readers and assistive
* technology. Headings allow screen reader and keyboard only users to
* navigate to or skip the links. See
* http://juicystudio.com/article/screen-readers-display-none.php and
* http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
* Unfortunately links templates duplicate the "active" class handling of l()
* and LinkGenerator::generate() because it needs to be able to set the "active"
* class not on the links themselves ("a" tags), but on the list items ("li"
* tags) that contain the links. This is necessary for CSS to be able to style
* list items differently when the link is active, since CSS does not yet allow
* one to style list items only if it contains a certain element with a certain
* class. I.e. we cannot yet convert this jQuery selector to a CSS selector:
* jQuery('li:has("a.active")')
*
* @see l()
* @see \Drupal\Core\Utility\LinkGenerator::generate()
* @see system_page_build()
function template_preprocess_links(&$variables) {
Dries Buytaert
committed
$links = $variables['links'];
$heading = &$variables['heading'];
Dries Buytaert
committed
catch
committed
if (!empty($links)) {
// Prepend the heading to the list, if any.
if (!empty($heading)) {
catch
committed
// Convert a string heading into an array, using a H2 tag by default.
if (is_string($heading)) {
catch
committed
$heading = array('text' => $heading);
}
catch
committed
// Merge in default array properties into $heading.
$heading += array(
'level' => 'h2',
'attributes' => array(),
);
// Convert the attributes array into an Attribute object.
$heading['attributes'] = new Attribute($heading['attributes']);
$heading['text'] = String::checkPlain($heading['text']);
}
$variables['links'] = array();
Dries Buytaert
committed
foreach ($links as $key => $link) {
$item = array();
Alex Pott
committed
$link += array(
'href' => NULL,
'route_name' => NULL,
'route_parameters' => NULL,
Alex Pott
committed
'ajax' => NULL,
Alex Pott
committed
);
$li_attributes = array('class' => array());
catch
committed
// Use the array key as class name.
$li_attributes['class'][] = drupal_html_class($key);
catch
committed
$keys = array('title', 'href', 'route_name', 'route_parameters');
Alex Pott
committed
$link_element = array(
'#type' => 'link',
'#title' => $link['title'],
catch
committed
'#options' => array_diff_key($link, array_combine($keys, $keys)),
Alex Pott
committed
'#href' => $link['href'],
'#route_name' => $link['route_name'],
'#route_parameters' => $link['route_parameters'],
Alex Pott
committed
'#ajax' => $link['ajax'],