1090 lines
48 KiB
PHP
1090 lines
48 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @defgroup themeable Theme system overview
|
|
* @{
|
|
* Functions and templates for the user interface that themes can override.
|
|
*
|
|
* Drupal's theme system allows a theme to have nearly complete control over
|
|
* the appearance of the site, which includes both the markup and the CSS used
|
|
* to style the markup. For this system to work, modules, instead of writing
|
|
* HTML markup directly, need to return "render arrays", which are structured
|
|
* hierarchical arrays that include the data to be rendered into HTML (or XML or
|
|
* another output format), and options that affect the markup. Render arrays
|
|
* are ultimately rendered into HTML or other output formats by recursive calls
|
|
* to drupal_render(), traversing the depth of the render array hierarchy. At
|
|
* each level, the theme system is invoked to do the actual rendering. See the
|
|
* documentation of drupal_render() and the
|
|
* @link theme_render Theme system and Render API topic @endlink for more
|
|
* information about render arrays and rendering.
|
|
*
|
|
* @section sec_twig_theme Twig Templating Engine
|
|
* Drupal 8 uses the templating engine Twig. Twig offers developers a fast,
|
|
* secure, and flexible method for building templates for Drupal 8 sites. Twig
|
|
* also offers substantial usability improvements over PHPTemplate, and does
|
|
* not require front-end developers to know PHP to build and manipulate Drupal
|
|
* 8 themes.
|
|
*
|
|
* For further information on theming in Drupal 8 see
|
|
* https://www.drupal.org/theme-guide/8
|
|
*
|
|
* For further Twig documentation see
|
|
* http://twig.sensiolabs.org/doc/templates.html
|
|
*
|
|
* @section sec_theme_hooks Theme Hooks
|
|
* The theme system is invoked in drupal_render() by calling the internal
|
|
* _theme() function, which operates on the concept of "theme hooks". Theme
|
|
* hooks define how a particular type of data should be rendered. They are
|
|
* registered by modules by implenting hook_theme(), which specifies the name of
|
|
* the hook, the input "variables" used to provide data and options, and other
|
|
* information. Modules implementing hook_theme() also need to provide a default
|
|
* implementation for each of their theme hooks, normally in a Twig file, and
|
|
* they may also provide preprocessing functions. For example, the core Search
|
|
* module defines a theme hook for a search result item in search_theme():
|
|
* @code
|
|
* return array(
|
|
* 'search_result' => array(
|
|
* 'variables' => array(
|
|
* 'result' => NULL,
|
|
* 'plugin_id' => NULL,
|
|
* ),
|
|
* 'file' => 'search.pages.inc',
|
|
* ),
|
|
* );
|
|
* @endcode
|
|
* Given this definition, the template file with the default implementation is
|
|
* search-result.html.twig, which can be found in the
|
|
* core/modules/search/templates directory, and the variables for rendering are
|
|
* the search result and the plugin ID. In addition, there is a function
|
|
* template_preprocess_search_result(), located in file search.pages.inc, which
|
|
* preprocesses the information from the input variables so that it can be
|
|
* rendered by the Twig template; the processed variables that the Twig template
|
|
* receives are documented in the header of the default Twig template file.
|
|
*
|
|
* hook_theme() implementations can also specify that a theme hook
|
|
* implementation is a theme function, but that is uncommon. It is only used for
|
|
* special cases, for performance reasons, because rendering using theme
|
|
* functions is somewhat faster than theme templates.
|
|
*
|
|
* @section sec_overriding_theme_hooks Overriding Theme Hooks
|
|
* Themes may 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 creating a template file with the same name as the
|
|
* default implementation; for example, to override the display of search
|
|
* results, a theme would add a file called search-result.html.twig to its
|
|
* templates directory. A good starting point for doing this is normally to
|
|
* copy the default implementation template, and then modifying it as desired.
|
|
*
|
|
* In the uncommon case that a theme hook uses a theme function instead of a
|
|
* template file, a module would provide a default implementation function
|
|
* called theme_HOOK, where HOOK is the name of the theme hook (for example,
|
|
* theme_search_result() would be the name of the function for search result
|
|
* theming). In this case, a theme can override the default implentation by
|
|
* defining a function called THEME_HOOK() in its THEME.theme file, where THEME
|
|
* is the machine name of the theme (for example, 'bartik' is the machine name
|
|
* of the core Bartik theme, and it would define a function called
|
|
* bartik_search_result() in the bartik.theme file, if the search_result hook
|
|
* implementation was a function instead of a template). Normally, copying the
|
|
* default function is again a good starting point for overriding its behavior.
|
|
*
|
|
* @section sec_preprocess_templates Preprocessing for Template Files
|
|
* If the theme implementation is a template file, several functions are called
|
|
* before the template file is invoked to modify the variables that are passed
|
|
* to the template. 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). Modules,
|
|
* themes, and theme engines can provide these functions to modify how the
|
|
* data is preprocessed, before it is passed to the theme template:
|
|
* - template_preprocess(&$variables, $hook): Creates a default set of variables
|
|
* for all theme hooks with template implementations. Provided by Drupal Core.
|
|
* - template_preprocess_HOOK(&$variables): Should be implemented by the module
|
|
* that registers the theme hook, to set up default variables.
|
|
* - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
|
|
* implementing modules.
|
|
* - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
|
|
* all implementing modules, so that modules that didn't define the theme hook
|
|
* can alter the variables.
|
|
* - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
|
|
* set necessary variables for all theme hooks with template implementations.
|
|
* - ENGINE_engine_preprocess_HOOK(&$variables): Allows the theme engine to set
|
|
* necessary variables for the particular theme hook.
|
|
* - THEME_preprocess(&$variables, $hook): Allows the theme to set necessary
|
|
* variables for all theme hooks with template implementations.
|
|
* - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
|
|
* variables specific to the particular theme hook.
|
|
*
|
|
* @section sec_preprocess_functions Preprocessing for Theme Functions
|
|
* If the theming 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.
|
|
*
|
|
* @section sec_suggestions Theme hook suggestions
|
|
* In some cases, instead of calling the base theme hook implementation (either
|
|
* the default provided by the module that defined the hook, or the override
|
|
* provided by the theme), the theme system will instead look for "suggestions"
|
|
* of other hook names to look for. Suggestions can be specified in several
|
|
* ways:
|
|
* - In a render array, the '#theme' property (which gives the name of the hook
|
|
* to use) can be an array of theme hook names instead of a single hook name.
|
|
* In this case, the render system will look first for the highest-priority
|
|
* hook name, and if no implementation is found, look for the second, and so
|
|
* on. Note that the highest-priority suggestion is at the end of the array.
|
|
* - In a render array, the '#theme' property can be set to the name of a hook
|
|
* with a '__SUGGESTION' suffix. For example, in search results theming, the
|
|
* hook 'item_list__search_results' is given. In this case, the render system
|
|
* will look for theme templates called item-list--search-results.html.twig,
|
|
* which would only be used for rendering item lists containing search
|
|
* results, and if this template is not found, it will fall back to using the
|
|
* base item-list.html.twig template. This type of suggestion can also be
|
|
* combined with providing an array of theme hook names as described above.
|
|
* - A module can implement hook_theme_suggestions_HOOK(). This allows the
|
|
* module that defines the theme template to dynamically return an array
|
|
* containing specific theme hook names (presumably with '__' suffixes as
|
|
* defined above) to use as suggestions. For example, the Search module
|
|
* does this in search_theme_suggestions_search_result() to suggest
|
|
* search_result__PLUGIN as the theme hook for search result items, where
|
|
* PLUGIN is the machine name of the particular search plugin type that was
|
|
* used for the search (such as node_search or user_search).
|
|
*
|
|
* @section sec_alternate_suggestions Altering theme hook suggestions
|
|
* Modules can also alter the theme suggestions provided using the mechanisms
|
|
* of the previous section. There are two hooks for this: the
|
|
* theme-hook-specific hook_theme_suggestions_HOOK_alter() and the generic
|
|
* hook_theme_suggestions_alter(). These hooks get the current list of
|
|
* suggestions as input, and can change this array (adding suggestions and
|
|
* removing them).
|
|
*
|
|
* @section assets Assets
|
|
*
|
|
* We can distinguish between three types of assets:
|
|
* 1. unconditional page-level assets (loaded on all pages where the theme is in
|
|
* use): these are defined in the theme's *.info.yml file.
|
|
* 2. conditional page-level assets (loaded on all pages where the theme is in
|
|
* use and a certain condition is met): these are attached in
|
|
* hook_page_attachments_alter(), e.g.:
|
|
* @code
|
|
* function THEME_page_attachments_alter(array &$page) {
|
|
* if ($some_condition) {
|
|
* $page['#attached']['library'][] = 'mytheme/something';
|
|
* }
|
|
* }
|
|
* @endcode
|
|
* 3. template-specific assets (loaded on all pages where a specific template is
|
|
* in use): these can be added by in preprocessing functions, using @code
|
|
* $variables['#attached'] @endcode, e.g.:
|
|
* @code
|
|
* function THEME_preprocess_menu_local_action(array &$variables) {
|
|
* // We require Modernizr's touch test for button styling.
|
|
* $variables['#attached']['library'][] = 'core/modernizr';
|
|
* }
|
|
* @endcode
|
|
*
|
|
* @see hooks
|
|
* @see callbacks
|
|
* @see theme_render
|
|
*
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @defgroup theme_render Render API overview
|
|
* @{
|
|
* Overview of the Theme system and Render API.
|
|
*
|
|
* The main purpose of Drupal's Theme system is to give themes complete control
|
|
* over the appearance of the site, which includes the markup returned from HTTP
|
|
* requests and the CSS files used to style that markup. In order to ensure that
|
|
* a theme can completely customize the markup, module developers should avoid
|
|
* directly writing HTML markup for pages, blocks, and other user-visible output
|
|
* in their modules, and instead return structured "render arrays" (see
|
|
* @ref arrays below). Doing this also increases usability, by ensuring that the
|
|
* markup used for similar functionality on different areas of the site is the
|
|
* same, which gives users fewer user interface patterns to learn.
|
|
*
|
|
* For further information on the Theme and Render APIs, see:
|
|
* - https://drupal.org/documentation/theme
|
|
* - https://drupal.org/node/722174
|
|
* - https://drupal.org/node/933976
|
|
* - https://drupal.org/node/930760
|
|
*
|
|
* @todo Check these links. Some are for Drupal 7, and might need updates for
|
|
* Drupal 8.
|
|
*
|
|
* @section arrays Render arrays
|
|
* The core structure of the Render API is the render array, which is a
|
|
* hierarchical associative array containing data to be rendered and properties
|
|
* describing how the data should be rendered. A render array that is returned
|
|
* by a function to specify markup to be sent to the web browser or other
|
|
* services will eventually be rendered by a call to drupal_render(), which will
|
|
* recurse through the render array hierarchy if appropriate, making calls into
|
|
* the theme system to do the actual rendering. If a function or method actually
|
|
* needs to return rendered output rather than a render array, the best practice
|
|
* would be to create a render array, render it by calling drupal_render(), and
|
|
* return that result, rather than writing the markup directly. See the
|
|
* documentation of drupal_render() for more details of the rendering process.
|
|
*
|
|
* Each level in the hierarchy of a render array (including the outermost array)
|
|
* has one or more array elements. Array elements whose names start with '#' are
|
|
* known as "properties", and the array elements with other names are "children"
|
|
* (constituting the next level of the hierarchy); the names of children are
|
|
* flexible, while property names are specific to the Render API and the
|
|
* particular type of data being rendered. A special case of render arrays is a
|
|
* form array, which specifies the form elements for an HTML form; see the
|
|
* @link form_api Form generation topic @endlink for more information on forms.
|
|
*
|
|
* Render arrays (at each level in the hierarchy) will usually have one of the
|
|
* following three properties defined:
|
|
* - #type: Specifies that the array contains data and options for a particular
|
|
* type of "render element" (examples: 'form', for an HTML form; 'textfield',
|
|
* 'submit', and other HTML form element types; 'table', for a table with
|
|
* rows, columns, and headers). See @ref elements below for more on render
|
|
* element types.
|
|
* - #theme: Specifies that the array contains data to be themed by a particular
|
|
* theme hook. Modules define theme hooks by implementing hook_theme(), which
|
|
* specifies the input "variables" used to provide data and options; if a
|
|
* hook_theme() implementation specifies variable 'foo', then in a render
|
|
* array, you would provide this data using property '#foo'. Modules
|
|
* implementing hook_theme() also need to provide a default implementation for
|
|
* each of their theme hooks, normally in a Twig file. For more information
|
|
* and to discover available theme hooks, see the documentation of
|
|
* hook_theme() and the
|
|
* @link themeable Default theme implementations topic. @endlink
|
|
* - #markup: Specifies that the array provides HTML markup directly. Unless the
|
|
* markup is very simple, such as an explanation in a paragraph tag, it is
|
|
* normally preferable to use #theme or #type instead, so that the theme can
|
|
* customize the markup.
|
|
*
|
|
* JavaScript and CSS attributes are specified in the render array using the
|
|
* #attached property (see @ref sec_attached).
|
|
*
|
|
* @section elements Render elements
|
|
* Render elements are defined by Drupal core and modules. The primary way to
|
|
* define a render element is to create a render element plugin. There are
|
|
* two types of render element plugins:
|
|
* - Generic elements: Generic render element plugins implement
|
|
* \Drupal\Core\Render\Element\ElementInterface, are annotated with
|
|
* \Drupal\Core\Render\Annotation\RenderElement annotation, go in plugin
|
|
* namespace Element, and generally extend the
|
|
* \Drupal\Core\Render\Element\RenderElement base class.
|
|
* - Form input elements: Render elements representing form input elements
|
|
* implement \Drupal\Core\Render\Element\FormElementInterface, are annotated
|
|
* with \Drupal\Core\Render\Annotation\FormElement annotation, go in plugin
|
|
* namespace Element, and generally extend the
|
|
* \Drupal\Core\Render\Element\FormElement base class.
|
|
* See the @link plugin_api Plugin API topic @endlink for general information
|
|
* on plugins, and look for classes with the RenderElement or FormElement
|
|
* annotation to discover what render elements are available.
|
|
*
|
|
* Modules can also currently define render elements by implementing
|
|
* hook_element_info(), although defining a plugin is preferred.
|
|
* properties. Look through implementations of hook_element_info() to discover
|
|
* elements defined this way.
|
|
*
|
|
* @section sec_attached Attaching libraries in render arrays
|
|
*
|
|
* The #attached property allows loading of CSS, JavaScript, libraries or custom
|
|
* types. Specify an array of type => value pairs, where the type (most often
|
|
* 'css', 'js', or 'library') determines the loading technique and the value
|
|
* provides the options specified to the loader function. Example:
|
|
* @code
|
|
* $form['#attached']['css'] = array(
|
|
* drupal_get_path('module', 'ajax_example') . '/ajax_example.css',
|
|
* );
|
|
*
|
|
* $form['#attached']['js'] = array(
|
|
* drupal_get_path('module', 'ajax_example') . '/ajax_example.js',
|
|
* );
|
|
* @endcode
|
|
*
|
|
* See drupal_process_attached() for additional information.
|
|
*
|
|
* @section render_pipeline The Render Pipeline (or: how Drupal renders pages)
|
|
*
|
|
* First, you need to know the general routing concepts: please read
|
|
* @ref sec_controller first.
|
|
*
|
|
* Any route that returns the "main content" as a render array automatically has
|
|
* the ability to be requested in multiple ways: it can be rendered in a certain
|
|
* format (HTML, JSON …) and/or in a certain decorated manner (e.g. with blocks
|
|
* around the main content).
|
|
*
|
|
* After the controller returned a render array, the @code VIEW @endcode event
|
|
* (\Symfony\Component\HttpKernel\KernelEvents::VIEW) will be triggered, because
|
|
* the controller result is not a Response, but a render array.
|
|
*
|
|
* \Drupal\Core\EventSubscriber\MainContentViewSubscriber is subscribed to the
|
|
* @code VIEW @endcode event. It checks whether the controller result is an
|
|
* array, and if so, guarantees to generate a Response.
|
|
*
|
|
* Next, it checks whether the negotiated request format is supported. Any
|
|
* format for which a main content renderer service exists (an implementation of
|
|
* \Drupal\Core\Render\MainContent\MainContentRendererInterface) is supported.
|
|
*
|
|
* If the negotiated request format is not supported, a 406 JSON response is
|
|
* generated, which lists the supported formats in a machine-readable way(as per
|
|
* RFC 2616, section 10.4.7).
|
|
*
|
|
* Otherwise, when the negotiated request format is supported, the corresponding
|
|
* main content renderer service is initialized. A response is generated by
|
|
* calling \Drupal\Core\Render\MainContent\MainContentRendererInterface::renderResponse()
|
|
* on the service. That's it!
|
|
*
|
|
* Each main content renderer service can choose how to implement its
|
|
* renderResponse() method. It may of course choose to add protected helper
|
|
* methods to provide more structure, if it's a complex main content renderer.
|
|
*
|
|
* The above is the general flow. But let's take a look at the HTML main content
|
|
* renderer (\Drupal\Core\Render\MainContent\HtmlRenderer), because that will be
|
|
* used most often.
|
|
*
|
|
* \Drupal\Core\Render\MainContent\HtmlRenderer::renderResponse() first calls a
|
|
* helper method, @code prepare() @endcode, which takes the main content render
|
|
* array and returns a #type 'page' render array. A #type 'page' render array
|
|
* represents the final <body> for the HTML document (page.html.twig). The
|
|
* remaining task for @code renderResponse() @endcode is to wrap the #type
|
|
* 'page' render array in a #type 'html' render array, which then represents the
|
|
* entire HTML document (html.html.twig).
|
|
* Hence the steps are:
|
|
* 1. \Drupal\Core\Render\MainContent\HtmlRenderer::prepare() takes the main
|
|
* content render array; if it already is #type 'page', then most of the work
|
|
* it must do is already done. In the other case, we need to build that #type
|
|
* 'page' render array still. The RenderEvents::SELECT_PAGE_DISPLAY_VARIANT
|
|
* event is dispatched, to select a page display variant. By default,
|
|
* \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant is used, which
|
|
* doesn't apply any decorations. But, when Block module is enabled,
|
|
* \Drupal\block\Plugin\DisplayVariant\BlockPageVariant is used, which allows
|
|
* the site builder to place blocks in any of the page regions, and hence
|
|
* "decorate" the main content.
|
|
* 2. \Drupal\Core\Render\MainContent\HtmlRenderer::prepare() now is guaranteed
|
|
* to be working on a #type 'page' render array. hook_page_attachments() and
|
|
* hook_page_attachments_alter() are invoked.
|
|
* 3. \Drupal\Core\Render\MainContent\HtmlRenderer::renderResponse() uses the
|
|
* #type 'page' render array returned by the previous step and wraps it in
|
|
* #type 'html'. hook_page_top() and hook_page_bottom() are invoked.
|
|
* 4. drupal_render() is called on the #type 'html' render array, which uses
|
|
* the html.html.twig template and the return value is a HTML document as a
|
|
* string.
|
|
* 5. This string of HTML is returned as the Response.
|
|
*
|
|
* For HTML pages to be rendered in limited environments, such as when you are
|
|
* installing or updating Drupal, or when you put it in maintenance mode, or
|
|
* when an error occurs, a simpler HTML page renderer is used for rendering
|
|
* these bare pages: \Drupal\Core\Render\BareHtmlPageRenderer
|
|
*
|
|
*
|
|
* @see themeable
|
|
*
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup hooks
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Allow themes to alter the theme-specific settings form.
|
|
*
|
|
* With this hook, themes can alter the theme-specific settings form in any way
|
|
* allowable by Drupal's Form API, such as adding form elements, changing
|
|
* default values and removing form elements. See the Form API documentation on
|
|
* api.drupal.org for detailed information.
|
|
*
|
|
* Note that the base theme's form alterations will be run before any sub-theme
|
|
* alterations.
|
|
*
|
|
* @param $form
|
|
* Nested array of form elements that comprise the form.
|
|
* @param $form_state
|
|
* The current state of the form.
|
|
*/
|
|
function hook_form_system_theme_settings_alter(&$form, \Drupal\Core\Form\FormStateInterface $form_state) {
|
|
// Add a checkbox to toggle the breadcrumb trail.
|
|
$form['toggle_breadcrumb'] = array(
|
|
'#type' => 'checkbox',
|
|
'#title' => t('Display the breadcrumb'),
|
|
'#default_value' => theme_get_setting('features.breadcrumb'),
|
|
'#description' => t('Show a trail of links from the homepage to the current page.'),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Preprocess theme variables for templates.
|
|
*
|
|
* This hook allows modules to preprocess theme variables for theme templates.
|
|
* It is called for all theme hooks implemented as templates, but not for theme
|
|
* hooks implemented as functions. hook_preprocess_HOOK() can be used to
|
|
* preprocess variables for a specific theme hook, whether implemented as a
|
|
* template or function.
|
|
*
|
|
* For more detailed information, see _theme().
|
|
*
|
|
* @param $variables
|
|
* The variables array (modify in place).
|
|
* @param $hook
|
|
* The name of the theme hook.
|
|
*/
|
|
function hook_preprocess(&$variables, $hook) {
|
|
static $hooks;
|
|
|
|
// Add contextual links to the variables, if the user has permission.
|
|
|
|
if (!\Drupal::currentUser()->hasPermission('access contextual links')) {
|
|
return;
|
|
}
|
|
|
|
if (!isset($hooks)) {
|
|
$hooks = theme_get_registry();
|
|
}
|
|
|
|
// Determine the primary theme function argument.
|
|
if (isset($hooks[$hook]['variables'])) {
|
|
$keys = array_keys($hooks[$hook]['variables']);
|
|
$key = $keys[0];
|
|
}
|
|
else {
|
|
$key = $hooks[$hook]['render element'];
|
|
}
|
|
|
|
if (isset($variables[$key])) {
|
|
$element = $variables[$key];
|
|
}
|
|
|
|
if (isset($element) && is_array($element) && !empty($element['#contextual_links'])) {
|
|
$variables['title_suffix']['contextual_links'] = contextual_links_view($element);
|
|
if (!empty($variables['title_suffix']['contextual_links'])) {
|
|
$variables['attributes']['class'][] = 'contextual-links-region';
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Preprocess theme variables for a specific theme hook.
|
|
*
|
|
* This hook allows modules to preprocess theme variables for a specific theme
|
|
* hook. It should only be used if a module needs to override or add to the
|
|
* theme preprocessing for a theme hook it didn't define.
|
|
*
|
|
* For more detailed information, see _theme().
|
|
*
|
|
* @param $variables
|
|
* The variables array (modify in place).
|
|
*/
|
|
function hook_preprocess_HOOK(&$variables) {
|
|
// This example is from rdf_preprocess_image(). It adds an RDF attribute
|
|
// to the image hook's variables.
|
|
$variables['attributes']['typeof'] = array('foaf:Image');
|
|
}
|
|
|
|
/**
|
|
* Provides alternate named suggestions for a specific theme hook.
|
|
*
|
|
* This hook allows the module implementing hook_theme() for a theme hook to
|
|
* provide alternative theme function or template name suggestions. This hook is
|
|
* only invoked for the first module implementing hook_theme() for a theme hook.
|
|
*
|
|
* HOOK is the least-specific version of the hook being called. For example, if
|
|
* '#theme' => 'node__article' is called, then node_theme_suggestions_node()
|
|
* will be invoked, not node_theme_suggestions_node__article(). The specific
|
|
* hook called (in this case 'node__article') is available in
|
|
* $variables['theme_hook_original'].
|
|
*
|
|
* @todo Add @code sample.
|
|
*
|
|
* @param array $variables
|
|
* An array of variables passed to the theme hook. Note that this hook is
|
|
* invoked before any preprocessing.
|
|
*
|
|
* @return array
|
|
* An array of theme suggestions.
|
|
*
|
|
* @see hook_theme_suggestions_HOOK_alter()
|
|
*/
|
|
function hook_theme_suggestions_HOOK(array $variables) {
|
|
$suggestions = array();
|
|
|
|
$suggestions[] = 'node__' . $variables['elements']['#langcode'];
|
|
|
|
return $suggestions;
|
|
}
|
|
|
|
/**
|
|
* Alters named suggestions for all theme hooks.
|
|
*
|
|
* This hook is invoked for all theme hooks, if you are targeting a specific
|
|
* theme hook it's best to use hook_theme_suggestions_HOOK_alter().
|
|
*
|
|
* The call order is as follows: all existing suggestion alter functions are
|
|
* called for module A, then all for module B, etc., followed by all for any
|
|
* base theme(s), and finally for the active theme. The order is
|
|
* determined by system weight, then by extension (module or theme) name.
|
|
*
|
|
* Within each module or theme, suggestion alter hooks are called in the
|
|
* following order: first, hook_theme_suggestions_alter(); second,
|
|
* hook_theme_suggestions_HOOK_alter(). So, for each module or theme, the more
|
|
* general hooks are called first followed by the more specific.
|
|
*
|
|
* In the following example, we provide an alternative template suggestion to
|
|
* node and taxonomy term templates based on the user being logged in.
|
|
* @code
|
|
* function MYMODULE_theme_suggestions_alter(array &$suggestions, array $variables, $hook) {
|
|
* if (\Drupal::currentUser()->isAuthenticated() && in_array($hook, array('node', 'taxonomy_term'))) {
|
|
* $suggestions[] = $hook . '__' . 'logged_in';
|
|
* }
|
|
* }
|
|
*
|
|
* @endcode
|
|
*
|
|
* @param array $suggestions
|
|
* An array of alternate, more specific names for template files or theme
|
|
* functions.
|
|
* @param array $variables
|
|
* An array of variables passed to the theme hook. Note that this hook is
|
|
* invoked before any variable preprocessing.
|
|
* @param string $hook
|
|
* The base hook name. For example, if '#theme' => 'node__article' is called,
|
|
* then $hook will be 'node', not 'node__article'. The specific hook called
|
|
* (in this case 'node__article') is available in
|
|
* $variables['theme_hook_original'].
|
|
*
|
|
* @return array
|
|
* An array of theme suggestions.
|
|
*
|
|
* @see hook_theme_suggestions_HOOK_alter()
|
|
*/
|
|
function hook_theme_suggestions_alter(array &$suggestions, array $variables, $hook) {
|
|
// Add an interface-language specific suggestion to all theme hooks.
|
|
$suggestions[] = $hook . '__' . \Drupal::languageManager()->getCurrentLanguage()->getId();
|
|
}
|
|
|
|
/**
|
|
* Alters named suggestions for a specific theme hook.
|
|
*
|
|
* This hook allows any module or theme to provide altenative theme function or
|
|
* template name suggestions and reorder or remove suggestions provided by
|
|
* hook_theme_suggestions_HOOK() or by earlier invocations of this hook.
|
|
*
|
|
* HOOK is the least-specific version of the hook being called. For example, if
|
|
* '#theme' => 'node__article' is called, then node_theme_suggestions_node()
|
|
* will be invoked, not node_theme_suggestions_node__article(). The specific
|
|
* hook called (in this case 'node__article') is available in
|
|
* $variables['theme_hook_original'].
|
|
*
|
|
* @todo Add @code sample.
|
|
*
|
|
* @param array $suggestions
|
|
* An array of theme suggestions.
|
|
* @param array $variables
|
|
* An array of variables passed to the theme hook. Note that this hook is
|
|
* invoked before any preprocessing.
|
|
*
|
|
* @see hook_theme_suggestions_alter()
|
|
* @see hook_theme_suggestions_HOOK()
|
|
*/
|
|
function hook_theme_suggestions_HOOK_alter(array &$suggestions, array $variables) {
|
|
if (empty($variables['header'])) {
|
|
$suggestions[] = 'hookname__' . 'no_header';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Respond to themes being installed.
|
|
*
|
|
* @param array $theme_list
|
|
* Array containing the names of the themes being installed.
|
|
*
|
|
* @see \Drupal\Core\Extension\ThemeHandler::install()
|
|
*/
|
|
function hook_themes_installed($theme_list) {
|
|
foreach ($theme_list as $theme) {
|
|
block_theme_initialize($theme);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Respond to themes being uninstalled.
|
|
*
|
|
* @param array $theme_list
|
|
* Array containing the names of the themes being uninstalled.
|
|
*
|
|
* @see \Drupal\Core\Extension\ThemeHandler::uninstall()
|
|
*/
|
|
function hook_themes_uninstalled(array $themes) {
|
|
// Remove some state entries depending on the theme.
|
|
foreach ($themes as $theme) {
|
|
\Drupal::state()->delete('example.' . $theme);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Declare a template file extension to be used with a theme engine.
|
|
*
|
|
* This hook is used in a theme engine implementation in the format of
|
|
* ENGINE_extension().
|
|
*
|
|
* @return string
|
|
* The file extension the theme engine will recognize.
|
|
*/
|
|
function hook_extension() {
|
|
// Extension for template base names in Twig.
|
|
return '.html.twig';
|
|
}
|
|
|
|
/**
|
|
* Render a template using the theme engine.
|
|
*
|
|
* @param string $template_file
|
|
* The path (relative to the Drupal root directory) to the template to be
|
|
* rendered including its extension in the format 'path/to/TEMPLATE_NAME.EXT'.
|
|
* @param array $variables
|
|
* A keyed array of variables that are available for composing the output. The
|
|
* theme engine is responsible for passing all the variables to the template.
|
|
* Depending on the code in the template, all or just a subset of the
|
|
* variables might be used in the template.
|
|
*
|
|
* @return string
|
|
* The output generated from the template. In most cases this will be a string
|
|
* containing HTML markup.
|
|
*/
|
|
function hook_render_template($template_file, $variables) {
|
|
$twig_service = \Drupal::service('twig');
|
|
|
|
return $twig_service->loadTemplate($template_file)->render($variables);
|
|
}
|
|
|
|
/**
|
|
* Allows modules to declare their own Form API element types and specify their
|
|
* default values.
|
|
*
|
|
* This hook allows modules to declare their own form element types and to
|
|
* specify their default values. The values returned by this hook will be
|
|
* merged with the elements returned by form constructor implementations and so
|
|
* can return defaults for any Form APIs keys in addition to those explicitly
|
|
* documented by \Drupal\Core\Render\ElementInfoManagerInterface::getInfo().
|
|
*
|
|
* @return array
|
|
* An associative array with structure identical to that of the return value
|
|
* of \Drupal\Core\Render\ElementInfoManagerInterface::getInfo().
|
|
*
|
|
* @deprecated Use an annotated class instead, see
|
|
* \Drupal\Core\Render\Element\ElementInterface.
|
|
*
|
|
* @see hook_element_info_alter()
|
|
*/
|
|
function hook_element_info() {
|
|
$types['filter_format'] = array(
|
|
'#input' => TRUE,
|
|
);
|
|
return $types;
|
|
}
|
|
|
|
/**
|
|
* Alter the element type information returned from modules.
|
|
*
|
|
* A module may implement this hook in order to alter the element type defaults
|
|
* defined by a module.
|
|
*
|
|
* @param array $types
|
|
* An associative array with structure identical to that of the return value
|
|
* of \Drupal\Core\Render\ElementInfoManagerInterface::getInfo().
|
|
*
|
|
* @see hook_element_info()
|
|
*/
|
|
function hook_element_info_alter(array &$types) {
|
|
// Decrease the default size of textfields.
|
|
if (isset($types['textfield']['#size'])) {
|
|
$types['textfield']['#size'] = 40;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Perform necessary alterations to the JavaScript before it is presented on
|
|
* the page.
|
|
*
|
|
* @param $javascript
|
|
* An array of all JavaScript being presented on the page.
|
|
*
|
|
* @see _drupal_add_js()
|
|
* @see drupal_get_js()
|
|
* @see drupal_js_defaults()
|
|
*/
|
|
function hook_js_alter(&$javascript) {
|
|
// Swap out jQuery to use an updated version of the library.
|
|
$javascript['core/assets/vendor/jquery/jquery.js']['data'] = drupal_get_path('module', 'jquery_update') . '/jquery.js';
|
|
}
|
|
|
|
/**
|
|
* Alters the JavaScript/CSS library registry.
|
|
*
|
|
* Allows certain, contributed modules to update libraries to newer versions
|
|
* while ensuring backwards compatibility. In general, such manipulations should
|
|
* only be done by designated modules, since most modules that integrate with a
|
|
* certain library also depend on the API of a certain library version.
|
|
*
|
|
* @param $libraries
|
|
* The JavaScript/CSS libraries provided by $module. Keyed by internal library
|
|
* name and passed by reference.
|
|
* @param $module
|
|
* The name of the module that registered the libraries.
|
|
*/
|
|
function hook_library_info_alter(&$libraries, $module) {
|
|
// Update Farbtastic to version 2.0.
|
|
if ($module == 'core' && isset($libraries['jquery.farbtastic'])) {
|
|
// Verify existing version is older than the one we are updating to.
|
|
if (version_compare($libraries['jquery.farbtastic']['version'], '2.0', '<')) {
|
|
// Update the existing Farbtastic to version 2.0.
|
|
$libraries['jquery.farbtastic']['version'] = '2.0';
|
|
// To accurately replace library files, the order of files and the options
|
|
// of each file have to be retained; e.g., like this:
|
|
$old_path = 'assets/vendor/farbtastic';
|
|
// Since the replaced library files are no longer located in a directory
|
|
// relative to the original extension, specify an absolute path (relative
|
|
// to DRUPAL_ROOT / base_path()) to the new location.
|
|
$new_path = '/' . drupal_get_path('module', 'farbtastic_update') . '/js';
|
|
$new_js = array();
|
|
$replacements = array(
|
|
$old_path . '/farbtastic.js' => $new_path . '/farbtastic-2.0.js',
|
|
);
|
|
foreach ($libraries['jquery.farbtastic']['js'] as $source => $options) {
|
|
if (isset($replacements[$source])) {
|
|
$new_js[$replacements[$source]] = $options;
|
|
}
|
|
else {
|
|
$new_js[$source] = $options;
|
|
}
|
|
}
|
|
$libraries['jquery.farbtastic']['js'] = $new_js;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Alters a JavaScript/CSS library before it is attached.
|
|
*
|
|
* Allows modules and themes to dynamically attach further assets to a library
|
|
* when it is added to the page; e.g., to add JavaScript settings.
|
|
*
|
|
* This hook is only invoked once per library and page.
|
|
*
|
|
* @param array $library
|
|
* The JavaScript/CSS library that is being added.
|
|
* @param string $name
|
|
* The name of the library.
|
|
*
|
|
* @see _drupal_add_library()
|
|
*/
|
|
function hook_library_alter(array &$library, $name) {
|
|
if ($name == 'core/jquery.ui.datepicker') {
|
|
// Note: If the added assets do not depend on additional request-specific
|
|
// data supplied here, consider to statically register it directly via
|
|
// hook_library_info_alter() already.
|
|
$library['dependencies'][] = 'locale/drupal.locale.datepicker';
|
|
|
|
$language_interface = \Drupal::languageManager()->getCurrentLanguage();
|
|
$settings['jquery']['ui']['datepicker'] = array(
|
|
'isRTL' => $language_interface->getDirection() == LanguageInterface::DIRECTION_RTL,
|
|
'firstDay' => \Drupal::config('system.date')->get('first_day'),
|
|
);
|
|
$library['js'][] = array(
|
|
'type' => 'setting',
|
|
'data' => $settings,
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Alter CSS files before they are output on the page.
|
|
*
|
|
* @param $css
|
|
* An array of all CSS items (files and inline CSS) being requested on the page.
|
|
*
|
|
* @see _drupal_add_css()
|
|
* @see drupal_get_css()
|
|
*/
|
|
function hook_css_alter(&$css) {
|
|
// Remove defaults.css file.
|
|
unset($css[drupal_get_path('module', 'system') . '/defaults.css']);
|
|
}
|
|
|
|
/**
|
|
* Add attachments (typically assets) to a page before it is rendered.
|
|
*
|
|
* Use this hook when you want to conditionally add attachments to a page.
|
|
*
|
|
* If you want to alter the attachments added by other modules or if your module
|
|
* depends on the elements of other modules, use hook_page_attachments_alter()
|
|
* instead, which runs after this hook.
|
|
*
|
|
* @param array &$page
|
|
* An empty renderable array representing the page.
|
|
*
|
|
* @see hook_page_attachments_alter()
|
|
*/
|
|
function hook_page_attachments(array &$page) {
|
|
// Unconditionally attach an asset to the page.
|
|
$page['#attached']['library'][] = 'core/domready';
|
|
|
|
// Conditionally attach an asset to the page.
|
|
if (!\Drupal::currentUser()->hasPermission('may pet kittens')) {
|
|
$page['#attached']['library'][] = 'core/jquery';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Alter attachments (typically assets) to a page before it is rendered.
|
|
*
|
|
* Use this hook when you want to remove or alter attachments on the page, or
|
|
* add attachments to the page that depend on another module's attachments (this
|
|
* hook runs after hook_page_attachments().
|
|
*
|
|
* If you want to alter the attachments added by other modules or if your module
|
|
* depends on the elements of other modules, use hook_page_attachments_alter()
|
|
* instead, which runs after this hook.
|
|
*
|
|
* @param array &$page
|
|
* An empty renderable array representing the page.
|
|
*
|
|
* @see hook_page_attachments_alter()
|
|
*/
|
|
function hook_page_attachments_alter(array &$page) {
|
|
// Conditionally remove an asset.
|
|
if (in_array('core/jquery', $page['#attached']['library'])) {
|
|
$index = array_search('core/jquery', $page['#attached']['library']);
|
|
unset($page['#attached']['library'][$index]);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a renderable array to the top of the page.
|
|
*
|
|
* @param array $page_top
|
|
* A renderable array representing the top of the page.
|
|
*/
|
|
function hook_page_top(array &$page_top) {
|
|
$page_top['mymodule'] = ['#markup' => 'This is the top.'];
|
|
}
|
|
|
|
/**
|
|
* Add a renderable array to the bottom of the page.
|
|
*
|
|
* @param array $page_top
|
|
* A renderable array representing the bottom of the page.
|
|
*/
|
|
function hook_page_bottom(array &$page) {
|
|
$page_bottom['mymodule'] = ['#markup' => 'This is the bottom.'];
|
|
}
|
|
|
|
/**
|
|
* Register a module or theme's theme implementations.
|
|
*
|
|
* The implementations declared by this hook have several purposes:
|
|
* - They can specify how a particular render array is to be rendered as HTML.
|
|
* This is usually the case if the theme function is assigned to the render
|
|
* array's #theme property.
|
|
* - They can return HTML for default calls to _theme().
|
|
* - They can return HTML for calls to _theme() for a theme suggestion.
|
|
*
|
|
* @param array $existing
|
|
* An array of existing implementations that may be used for override
|
|
* purposes. This is primarily useful for themes that may wish to examine
|
|
* existing implementations to extract data (such as arguments) so that
|
|
* it may properly register its own, higher priority implementations.
|
|
* @param $type
|
|
* Whether a theme, module, etc. is being processed. This is primarily useful
|
|
* so that themes tell if they are the actual theme being called or a parent
|
|
* theme. May be one of:
|
|
* - 'module': A module is being checked for theme implementations.
|
|
* - 'base_theme_engine': A theme engine is being checked for a theme that is
|
|
* a parent of the actual theme being used.
|
|
* - 'theme_engine': A theme engine is being checked for the actual theme
|
|
* being used.
|
|
* - 'base_theme': A base theme is being checked for theme implementations.
|
|
* - 'theme': The actual theme in use is being checked.
|
|
* @param $theme
|
|
* The actual name of theme, module, etc. that is being being processed.
|
|
* @param $path
|
|
* The directory path of the theme or module, so that it doesn't need to be
|
|
* looked up.
|
|
*
|
|
* @return array
|
|
* An associative array of information about theme implementations. The keys
|
|
* on the outer array are known as "theme hooks". For simple theme
|
|
* implementations for regular calls to _theme(), the theme hook is the first
|
|
* argument. For theme suggestions, instead of the array key being the base
|
|
* theme hook, the key is a theme suggestion name with the format
|
|
* 'base_hook_name__sub_hook_name'. For render elements, the key is the
|
|
* machine name of the render element. The array values are themselves arrays
|
|
* containing information about the theme hook and its implementation. Each
|
|
* information array must contain either a 'variables' element (for _theme()
|
|
* calls) or a 'render element' element (for render elements), but not both.
|
|
* The following elements may be part of each information array:
|
|
* - variables: Used for _theme() call items only: an array of variables,
|
|
* where the array keys are the names of the variables, and the array
|
|
* values are the default values if they are not passed into _theme().
|
|
* Template implementations receive each array key as a variable in the
|
|
* template file (so they must be legal PHP/Twig variable names). Function
|
|
* implementations are passed the variables in a single $variables function
|
|
* argument.
|
|
* - render element: Used for render element items only: the name of the
|
|
* renderable element or element tree to pass to the theme function. This
|
|
* name is used as the name of the variable that holds the renderable
|
|
* element or tree in preprocess and process functions.
|
|
* - file: The file the implementation resides in. This file will be included
|
|
* prior to the theme being rendered, to make sure that the function or
|
|
* preprocess function (as needed) is actually loaded; this makes it
|
|
* possible to split theme functions out into separate files quite easily.
|
|
* - path: Override the path of the file to be used. Ordinarily the module or
|
|
* theme path will be used, but if the file will not be in the default
|
|
* path, include it here. This path should be relative to the Drupal root
|
|
* directory.
|
|
* - template: If specified, the theme implementation is a template file, and
|
|
* this is the template name. Do not add 'html.twig' on the end of the
|
|
* template name. The extension will be added automatically by the default
|
|
* rendering engine (which is Twig.) If 'path' is specified, 'template'
|
|
* should also be specified. If neither 'template' nor 'function' are
|
|
* specified, a default template name will be assumed. For example, if a
|
|
* module registers the 'search_result' theme hook, 'search-result' will be
|
|
* assigned as its template name.
|
|
* - function: If specified, this will be the function name to invoke for
|
|
* this implementation. If neither 'template' nor 'function' are specified,
|
|
* a default template name will be assumed. See above for more details.
|
|
* - base hook: Used for _theme() suggestions only: the base theme hook name.
|
|
* Instead of this suggestion's implementation being used directly, the base
|
|
* hook will be invoked with this implementation as its first suggestion.
|
|
* The base hook's files will be included and the base hook's preprocess
|
|
* functions will be called in place of any suggestion's preprocess
|
|
* functions. If an implementation of hook_theme_suggestions_HOOK() (where
|
|
* HOOK is the base hook) changes the suggestion order, a different
|
|
* suggestion may be used in place of this suggestion. If after
|
|
* hook_theme_suggestions_HOOK() this suggestion remains the first
|
|
* suggestion, then this suggestion's function or template will be used to
|
|
* generate the output for _theme().
|
|
* - pattern: A regular expression pattern to be used to allow this theme
|
|
* implementation to have a dynamic name. The convention is to use __ to
|
|
* differentiate the dynamic portion of the theme. For example, to allow
|
|
* forums to be themed individually, the pattern might be: 'forum__'. Then,
|
|
* when the forum is themed, call:
|
|
* @code
|
|
* _theme(array('forum__' . $tid, 'forum'), $forum)
|
|
* @endcode
|
|
* - preprocess functions: A list of functions used to preprocess this data.
|
|
* Ordinarily this won't be used; it's automatically filled in. By default,
|
|
* for a module this will be filled in as template_preprocess_HOOK. For
|
|
* a theme this will be filled in as twig_preprocess and
|
|
* twig_preprocess_HOOK as well as themename_preprocess and
|
|
* themename_preprocess_HOOK.
|
|
* - override preprocess functions: Set to TRUE when a theme does NOT want
|
|
* the standard preprocess functions to run. This can be used to give a
|
|
* theme FULL control over how variables are set. For example, if a theme
|
|
* wants total control over how certain variables in the page.html.twig are
|
|
* set, this can be set to true. Please keep in mind that when this is used
|
|
* by a theme, that theme becomes responsible for making sure necessary
|
|
* variables are set.
|
|
* - type: (automatically derived) Where the theme hook is defined:
|
|
* 'module', 'theme_engine', or 'theme'.
|
|
* - theme path: (automatically derived) The directory path of the theme or
|
|
* module, so that it doesn't need to be looked up.
|
|
*
|
|
* @see hook_theme_registry_alter()
|
|
*/
|
|
function hook_theme($existing, $type, $theme, $path) {
|
|
return array(
|
|
'forum_display' => array(
|
|
'variables' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL),
|
|
),
|
|
'forum_list' => array(
|
|
'variables' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL),
|
|
),
|
|
'forum_icon' => array(
|
|
'variables' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0),
|
|
),
|
|
'status_report' => array(
|
|
'render element' => 'requirements',
|
|
'file' => 'system.admin.inc',
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Alter the theme registry information returned from hook_theme().
|
|
*
|
|
* The theme registry stores information about all available theme hooks,
|
|
* including which callback functions those hooks will call when triggered,
|
|
* what template files are exposed by these hooks, and so on.
|
|
*
|
|
* Note that this hook is only executed as the theme cache is re-built.
|
|
* Changes here will not be visible until the next cache clear.
|
|
*
|
|
* The $theme_registry array is keyed by theme hook name, and contains the
|
|
* information returned from hook_theme(), as well as additional properties
|
|
* added by \Drupal\Core\Theme\Registry::processExtension().
|
|
*
|
|
* For example:
|
|
* @code
|
|
* $theme_registry['user'] = array(
|
|
* 'variables' => array(
|
|
* 'account' => NULL,
|
|
* ),
|
|
* 'template' => 'core/modules/user/user',
|
|
* 'file' => 'core/modules/user/user.pages.inc',
|
|
* 'type' => 'module',
|
|
* 'theme path' => 'core/modules/user',
|
|
* 'preprocess functions' => array(
|
|
* 0 => 'template_preprocess',
|
|
* 1 => 'template_preprocess_user_profile',
|
|
* ),
|
|
* );
|
|
* @endcode
|
|
*
|
|
* @param $theme_registry
|
|
* The entire cache of theme registry information, post-processing.
|
|
*
|
|
* @see hook_theme()
|
|
* @see \Drupal\Core\Theme\Registry::processExtension()
|
|
*/
|
|
function hook_theme_registry_alter(&$theme_registry) {
|
|
// Kill the next/previous forum topic navigation links.
|
|
foreach ($theme_registry['forum_topic_navigation']['preprocess functions'] as $key => $value) {
|
|
if ($value == 'template_preprocess_forum_topic_navigation') {
|
|
unset($theme_registry['forum_topic_navigation']['preprocess functions'][$key]);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Alter the default, hook-independent variables for all templates.
|
|
*
|
|
* Allows modules to provide additional default template variables or manipulate
|
|
* existing. This hook is invoked from template_preprocess() after basic default
|
|
* template variables have been set up and before the next template preprocess
|
|
* function is invoked.
|
|
*
|
|
* Note that the default template variables are statically cached within a
|
|
* request. When adding a template variable that depends on other context, it is
|
|
* your responsibility to appropriately reset the static cache in
|
|
* template_preprocess() when needed:
|
|
* @code
|
|
* drupal_static_reset('template_preprocess');
|
|
* @endcode
|
|
*
|
|
* See user_template_preprocess_default_variables_alter() for an example.
|
|
*
|
|
* @param array $variables
|
|
* An associative array of default template variables, as set up by
|
|
* _template_preprocess_default_variables(). Passed by reference.
|
|
*
|
|
* @see template_preprocess()
|
|
* @see _template_preprocess_default_variables()
|
|
*/
|
|
function hook_template_preprocess_default_variables_alter(&$variables) {
|
|
$variables['is_admin'] = \Drupal::currentUser()->hasPermission('access administration pages');
|
|
}
|
|
|
|
/**
|
|
* @} End of "addtogroup hooks".
|
|
*/
|