Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Hooks and documentation related to the theme and render system.
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * @defgroup themeable Theme system overview
Chris@0:  * @{
Chris@0:  * Functions and templates for the user interface that themes can override.
Chris@0:  *
Chris@0:  * Drupal's theme system allows a theme to have nearly complete control over
Chris@0:  * the appearance of the site, which includes both the markup and the CSS used
Chris@0:  * to style the markup. For this system to work, modules, instead of writing
Chris@0:  * HTML markup directly, need to return "render arrays", which are structured
Chris@0:  * hierarchical arrays that include the data to be rendered into HTML (or XML or
Chris@0:  * another output format), and options that affect the markup. Render arrays
Chris@0:  * are ultimately rendered into HTML or other output formats by recursive calls
Chris@0:  * to drupal_render(), traversing the depth of the render array hierarchy. At
Chris@0:  * each level, the theme system is invoked to do the actual rendering. See the
Chris@0:  * documentation of drupal_render() and the
Chris@0:  * @link theme_render Theme system and Render API topic @endlink for more
Chris@0:  * information about render arrays and rendering.
Chris@0:  *
Chris@0:  * @section sec_twig_theme Twig Templating Engine
Chris@0:  * Drupal 8 uses the templating engine Twig. Twig offers developers a fast,
Chris@0:  * secure, and flexible method for building templates for Drupal 8 sites. Twig
Chris@0:  * also offers substantial usability improvements over PHPTemplate, and does
Chris@0:  * not require front-end developers to know PHP to build and manipulate Drupal
Chris@0:  * 8 themes.
Chris@0:  *
Chris@0:  * For further information on theming in Drupal 8 see
Chris@0:  * https://www.drupal.org/docs/8/theming
Chris@0:  *
Chris@0:  * For further Twig documentation see
Chris@0:  * http://twig.sensiolabs.org/doc/templates.html
Chris@0:  *
Chris@0:  * @section sec_theme_hooks Theme Hooks
Chris@0:  * The theme system is invoked in \Drupal\Core\Render\Renderer::doRender() by
Chris@0:  * calling the \Drupal\Core\Theme\ThemeManagerInterface::render() function,
Chris@0:  * which operates on the concept of "theme hooks". Theme hooks define how a
Chris@0:  * particular type of data should be rendered. They are registered by modules by
Chris@0:  * implementing hook_theme(), which specifies the name of the hook, the input
Chris@0:  * "variables" used to provide data and options, and other information. Modules
Chris@0:  * implementing hook_theme() also need to provide a default implementation for
Chris@0:  * each of their theme hooks, normally in a Twig file, and they may also provide
Chris@0:  * preprocessing functions. For example, the core Search module defines a theme
Chris@0:  * hook for a search result item in search_theme():
Chris@0:  * @code
Chris@0:  * return array(
Chris@0:  *   'search_result' => array(
Chris@0:  *     'variables' => array(
Chris@0:  *       'result' => NULL,
Chris@0:  *       'plugin_id' => NULL,
Chris@0:  *     ),
Chris@0:  *    'file' => 'search.pages.inc',
Chris@0:  *   ),
Chris@0:  * );
Chris@0:  * @endcode
Chris@0:  * Given this definition, the template file with the default implementation is
Chris@0:  * search-result.html.twig, which can be found in the
Chris@0:  * core/modules/search/templates directory, and the variables for rendering are
Chris@0:  * the search result and the plugin ID. In addition, there is a function
Chris@0:  * template_preprocess_search_result(), located in file search.pages.inc, which
Chris@0:  * preprocesses the information from the input variables so that it can be
Chris@0:  * rendered by the Twig template; the processed variables that the Twig template
Chris@0:  * receives are documented in the header of the default Twig template file.
Chris@0:  *
Chris@0:  * hook_theme() implementations can also specify that a theme hook
Chris@0:  * implementation is a theme function, but that is uncommon and not recommended.
Chris@0:  * Note that while Twig templates will auto-escape variables, theme functions
Chris@0:  * must explicitly escape any variables by using theme_render_and_autoescape().
Chris@0:  * Failure to do so is likely to result in security vulnerabilities. Theme
Chris@0:  * functions are deprecated in Drupal 8.0.x and will be removed before
Chris@0:  * Drupal 9.0.x. Use Twig templates instead.
Chris@0:  *
Chris@0:  * @section sec_overriding_theme_hooks Overriding Theme Hooks
Chris@0:  * Themes may register new theme hooks within a hook_theme() implementation, but
Chris@0:  * it is more common for themes to override default implementations provided by
Chris@0:  * modules than to register entirely new theme hooks. Themes can override a
Chris@0:  * default implementation by creating a template file with the same name as the
Chris@0:  * default implementation; for example, to override the display of search
Chris@0:  * results, a theme would add a file called search-result.html.twig to its
Chris@0:  * templates directory. A good starting point for doing this is normally to
Chris@0:  * copy the default implementation template, and then modifying it as desired.
Chris@0:  *
Chris@0:  * In the uncommon case that a theme hook uses a theme function instead of a
Chris@0:  * template file, a module would provide a default implementation function
Chris@0:  * called theme_HOOK, where HOOK is the name of the theme hook (for example,
Chris@0:  * theme_search_result() would be the name of the function for search result
Chris@0:  * theming). In this case, a theme can override the default implementation by
Chris@0:  * defining a function called THEME_HOOK() in its THEME.theme file, where THEME
Chris@0:  * is the machine name of the theme (for example, 'bartik' is the machine name
Chris@0:  * of the core Bartik theme, and it would define a function called
Chris@0:  * bartik_search_result() in the bartik.theme file, if the search_result hook
Chris@0:  * implementation was a function instead of a template). Normally, copying the
Chris@0:  * default function is again a good starting point for overriding its behavior.
Chris@0:  * Again, note that theme functions (unlike templates) must explicitly escape
Chris@0:  * variables using theme_render_and_autoescape() or risk security
Chris@0:  * vulnerabilities. Theme functions are deprecated in Drupal 8.0.x and will be
Chris@0:  * removed before Drupal 9.0.x. Use Twig templates instead.
Chris@0:  *
Chris@0:  * @section sec_preprocess_templates Preprocessing for Template Files
Chris@0:  * If the theme implementation is a template file, several functions are called
Chris@0:  * before the template file is invoked to modify the variables that are passed
Chris@0:  * to the template. These make up the "preprocessing" phase, and are executed
Chris@0:  * (if they exist), in the following order (note that in the following list,
Chris@0:  * HOOK indicates the hook being called or a less specific hook. For example, if
Chris@0:  * '#theme' => 'node__article' is called, hook is node__article and node. MODULE
Chris@0:  * indicates a module name, THEME indicates a theme name, and ENGINE indicates a
Chris@0:  * theme engine name). Modules, themes, and theme engines can provide these
Chris@0:  * functions to modify how the data is preprocessed, before it is passed to the
Chris@0:  * theme template:
Chris@0:  * - template_preprocess(&$variables, $hook): Creates a default set of variables
Chris@0:  *   for all theme hooks with template implementations. Provided by Drupal Core.
Chris@0:  * - template_preprocess_HOOK(&$variables): Should be implemented by the module
Chris@0:  *   that registers the theme hook, to set up default variables.
Chris@0:  * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
Chris@0:  *   implementing modules.
Chris@0:  * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
Chris@0:  *   all implementing modules, so that modules that didn't define the theme hook
Chris@0:  *   can alter the variables.
Chris@0:  * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
Chris@0:  *   set necessary variables for all theme hooks with template implementations.
Chris@0:  * - ENGINE_engine_preprocess_HOOK(&$variables): Allows the theme engine to set
Chris@0:  *   necessary variables for the particular theme hook.
Chris@0:  * - THEME_preprocess(&$variables, $hook): Allows the theme to set necessary
Chris@0:  *   variables for all theme hooks with template implementations.
Chris@0:  * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
Chris@0:  *   variables specific to the particular theme hook.
Chris@0:  *
Chris@0:  * @section sec_preprocess_functions Preprocessing for Theme Functions
Chris@0:  * If the theming implementation is a function, only the theme-hook-specific
Chris@0:  * preprocess functions (the ones ending in _HOOK) are called from the list
Chris@0:  * above. This is because theme hooks with function implementations need to be
Chris@0:  * fast, and calling the non-theme-hook-specific preprocess functions for them
Chris@0:  * would incur a noticeable performance penalty.
Chris@0:  *
Chris@0:  * @section sec_suggestions Theme hook suggestions
Chris@0:  * In some cases, instead of calling the base theme hook implementation (either
Chris@0:  * the default provided by the module that defined the hook, or the override
Chris@0:  * provided by the theme), the theme system will instead look for "suggestions"
Chris@0:  * of other hook names to look for. Suggestions can be specified in several
Chris@0:  * ways:
Chris@0:  * - In a render array, the '#theme' property (which gives the name of the hook
Chris@0:  *   to use) can be an array of theme hook names instead of a single hook name.
Chris@0:  *   In this case, the render system will look first for the highest-priority
Chris@0:  *   hook name, and if no implementation is found, look for the second, and so
Chris@0:  *   on. Note that the highest-priority suggestion is at the end of the array.
Chris@0:  * - In a render array, the '#theme' property can be set to the name of a hook
Chris@0:  *   with a '__SUGGESTION' suffix. For example, in search results theming, the
Chris@0:  *   hook 'item_list__search_results' is given. In this case, the render system
Chris@0:  *   will look for theme templates called item-list--search-results.html.twig,
Chris@0:  *   which would only be used for rendering item lists containing search
Chris@0:  *   results, and if this template is not found, it will fall back to using the
Chris@0:  *   base item-list.html.twig template. This type of suggestion can also be
Chris@0:  *   combined with providing an array of theme hook names as described above.
Chris@0:  * - A module can implement hook_theme_suggestions_HOOK(). This allows the
Chris@0:  *   module that defines the theme template to dynamically return an array
Chris@0:  *   containing specific theme hook names (presumably with '__' suffixes as
Chris@0:  *   defined above) to use as suggestions. For example, the Search module
Chris@0:  *   does this in search_theme_suggestions_search_result() to suggest
Chris@0:  *   search_result__PLUGIN as the theme hook for search result items, where
Chris@0:  *   PLUGIN is the machine name of the particular search plugin type that was
Chris@0:  *   used for the search (such as node_search or user_search).
Chris@0:  *
Chris@0:  * For further information on overriding theme hooks see
Chris@0:  * https://www.drupal.org/node/2186401
Chris@0:  *
Chris@0:  * @section sec_alternate_suggestions Altering theme hook suggestions
Chris@0:  * Modules can also alter the theme suggestions provided using the mechanisms
Chris@0:  * of the previous section. There are two hooks for this: the
Chris@0:  * theme-hook-specific hook_theme_suggestions_HOOK_alter() and the generic
Chris@0:  * hook_theme_suggestions_alter(). These hooks get the current list of
Chris@0:  * suggestions as input, and can change this array (adding suggestions and
Chris@0:  * removing them).
Chris@0:  *
Chris@0:  * @section assets Assets
Chris@0:  * We can distinguish between three types of assets:
Chris@0:  * - Unconditional page-level assets (loaded on all pages where the theme is in
Chris@0:  *   use): these are defined in the theme's *.info.yml file.
Chris@0:  * - Conditional page-level assets (loaded on all pages where the theme is in
Chris@0:  *   use and a certain condition is met): these are attached in
Chris@0:  *   hook_page_attachments_alter(), e.g.:
Chris@0:  *   @code
Chris@0:  *   function THEME_page_attachments_alter(array &$page) {
Chris@0:  *     if ($some_condition) {
Chris@0:  *       $page['#attached']['library'][] = 'mytheme/something';
Chris@0:  *     }
Chris@0:  *   }
Chris@0:  *   @endcode
Chris@0:  * - Template-specific assets (loaded on all pages where a specific template is
Chris@0:  *   in use): these can be added by in preprocessing functions, using @code
Chris@0:  *   $variables['#attached'] @endcode, e.g.:
Chris@0:  *   @code
Chris@0:  *   function THEME_preprocess_menu_local_action(array &$variables) {
Chris@0:  *     // We require Modernizr's touch test for button styling.
Chris@0:  *     $variables['#attached']['library'][] = 'core/modernizr';
Chris@0:  *   }
Chris@0:  *   @endcode
Chris@0:  *
Chris@0:  * @see hooks
Chris@0:  * @see callbacks
Chris@0:  * @see theme_render
Chris@0:  *
Chris@0:  * @}
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * @defgroup theme_render Render API overview
Chris@0:  * @{
Chris@0:  * Overview of the Theme system and Render API.
Chris@0:  *
Chris@0:  * The main purpose of Drupal's Theme system is to give themes complete control
Chris@0:  * over the appearance of the site, which includes the markup returned from HTTP
Chris@0:  * requests and the CSS files used to style that markup. In order to ensure that
Chris@0:  * a theme can completely customize the markup, module developers should avoid
Chris@0:  * directly writing HTML markup for pages, blocks, and other user-visible output
Chris@0:  * in their modules, and instead return structured "render arrays" (see
Chris@0:  * @ref arrays below). Doing this also increases usability, by ensuring that the
Chris@0:  * markup used for similar functionality on different areas of the site is the
Chris@0:  * same, which gives users fewer user interface patterns to learn.
Chris@0:  *
Chris@0:  * For further information on the Theme and Render APIs, see:
Chris@0:  * - https://www.drupal.org/docs/8/theming
Chris@0:  * - https://www.drupal.org/developing/api/8/render
Chris@0:  * - @link themeable Theme system overview @endlink.
Chris@0:  *
Chris@0:  * @section arrays Render arrays
Chris@0:  * The core structure of the Render API is the render array, which is a
Chris@0:  * hierarchical associative array containing data to be rendered and properties
Chris@0:  * describing how the data should be rendered. A render array that is returned
Chris@0:  * by a function to specify markup to be sent to the web browser or other
Chris@0:  * services will eventually be rendered by a call to drupal_render(), which will
Chris@0:  * recurse through the render array hierarchy if appropriate, making calls into
Chris@0:  * the theme system to do the actual rendering. If a function or method actually
Chris@0:  * needs to return rendered output rather than a render array, the best practice
Chris@0:  * would be to create a render array, render it by calling drupal_render(), and
Chris@0:  * return that result, rather than writing the markup directly. See the
Chris@0:  * documentation of drupal_render() for more details of the rendering process.
Chris@0:  *
Chris@0:  * Each level in the hierarchy of a render array (including the outermost array)
Chris@0:  * has one or more array elements. Array elements whose names start with '#' are
Chris@0:  * known as "properties", and the array elements with other names are "children"
Chris@0:  * (constituting the next level of the hierarchy); the names of children are
Chris@0:  * flexible, while property names are specific to the Render API and the
Chris@0:  * particular type of data being rendered. A special case of render arrays is a
Chris@0:  * form array, which specifies the form elements for an HTML form; see the
Chris@0:  * @link form_api Form generation topic @endlink for more information on forms.
Chris@0:  *
Chris@0:  * Render arrays (at any level of the hierarchy) will usually have one of the
Chris@0:  * following properties defined:
Chris@0:  * - #type: Specifies that the array contains data and options for a particular
Chris@0:  *   type of "render element" (for example, 'form', for an HTML form;
Chris@0:  *   'textfield', 'submit', for HTML form element types; 'table', for a table
Chris@0:  *   with rows, columns, and headers). See @ref elements below for more on
Chris@0:  *   render element types.
Chris@0:  * - #theme: Specifies that the array contains data to be themed by a particular
Chris@0:  *   theme hook. Modules define theme hooks by implementing hook_theme(), which
Chris@0:  *   specifies the input "variables" used to provide data and options; if a
Chris@0:  *   hook_theme() implementation specifies variable 'foo', then in a render
Chris@0:  *   array, you would provide this data using property '#foo'. Modules
Chris@0:  *   implementing hook_theme() also need to provide a default implementation for
Chris@0:  *   each of their theme hooks, normally in a Twig file. For more information
Chris@0:  *   and to discover available theme hooks, see the documentation of
Chris@0:  *   hook_theme() and the
Chris@0:  *   @link themeable Default theme implementations topic. @endlink
Chris@0:  * - #markup: Specifies that the array provides HTML markup directly. Unless
Chris@0:  *   the markup is very simple, such as an explanation in a paragraph tag, it
Chris@0:  *   is normally preferable to use #theme or #type instead, so that the theme
Chris@0:  *   can customize the markup. Note that the value is passed through
Chris@0:  *   \Drupal\Component\Utility\Xss::filterAdmin(), which strips known XSS
Chris@0:  *   vectors while allowing a permissive list of HTML tags that are not XSS
Chris@0:  *   vectors. (For example, <script> and <style> are not allowed.) See
Chris@0:  *   \Drupal\Component\Utility\Xss::$adminTags for the list of allowed tags. If
Chris@0:  *   your markup needs any of the tags not in this whitelist, then you can
Chris@0:  *   implement a theme hook and/or an asset library. Alternatively, you can use
Chris@0:  *   the key #allowed_tags to alter which tags are filtered.
Chris@0:  * - #plain_text: Specifies that the array provides text that needs to be
Chris@0:  *   escaped. This value takes precedence over #markup.
Chris@0:  * - #allowed_tags: If #markup is supplied, this can be used to change which
Chris@0:  *   tags are allowed in the markup. The value is an array of tags that
Chris@0:  *   Xss::filter() would accept. If #plain_text is set, this value is ignored.
Chris@0:  *
Chris@0:  *   Usage example:
Chris@0:  *   @code
Chris@0:  *   $output['admin_filtered_string'] = [
Chris@0:  *     '#markup' => '<em>This is filtered using the admin tag list</em>',
Chris@0:  *   ];
Chris@0:  *   $output['filtered_string'] = [
Chris@0:  *     '#markup' => '<video><source src="v.webm" type="video/webm"></video>',
Chris@0:  *     '#allowed_tags' => ['video', 'source'],
Chris@0:  *   ];
Chris@0:  *   $output['escaped_string'] = [
Chris@0:  *     '#plain_text' => '<em>This is escaped</em>',
Chris@0:  *   ];
Chris@0:  *   @endcode
Chris@0:  *
Chris@0:  *   @see core.libraries.yml
Chris@0:  *   @see hook_theme()
Chris@0:  *
Chris@0:  * JavaScript and CSS assets are specified in the render array using the
Chris@0:  * #attached property (see @ref sec_attached).
Chris@0:  *
Chris@0:  * @section elements Render elements
Chris@0:  * Render elements are defined by Drupal core and modules. The primary way to
Chris@0:  * define a render element is to create a render element plugin. There are
Chris@0:  * two types of render element plugins:
Chris@0:  * - Generic elements: Generic render element plugins implement
Chris@0:  *   \Drupal\Core\Render\Element\ElementInterface, are annotated with
Chris@0:  *   \Drupal\Core\Render\Annotation\RenderElement annotation, go in plugin
Chris@0:  *   namespace Element, and generally extend the
Chris@0:  *   \Drupal\Core\Render\Element\RenderElement base class.
Chris@0:  * - Form input elements: Render elements representing form input elements
Chris@0:  *   implement \Drupal\Core\Render\Element\FormElementInterface, are annotated
Chris@0:  *   with \Drupal\Core\Render\Annotation\FormElement annotation, go in plugin
Chris@0:  *   namespace Element, and generally extend the
Chris@0:  *   \Drupal\Core\Render\Element\FormElement base class.
Chris@0:  * See the @link plugin_api Plugin API topic @endlink for general information
Chris@0:  * on plugins. You can search for classes with the RenderElement or FormElement
Chris@0:  * annotation to discover what render elements are available. API reference
Chris@0:  * sites (such as https://api.drupal.org) generate lists of all existing
Chris@0:  * elements from these classes. Look for the Elements link in the API Navigation
Chris@0:  * block.
Chris@0:  *
Chris@0:  * Modules can define render elements by defining an element plugin.
Chris@0:  *
Chris@0:  * @section sec_caching Caching
Chris@0:  * The Drupal rendering process has the ability to cache rendered output at any
Chris@0:  * level in a render array hierarchy. This allows expensive calculations to be
Chris@0:  * done infrequently, and speeds up page loading. See the
Chris@0:  * @link cache Cache API topic @endlink for general information about the cache
Chris@0:  * system.
Chris@0:  *
Chris@0:  * In order to make caching possible, the following information needs to be
Chris@0:  * present:
Chris@0:  * - Cache keys: Identifiers for cacheable portions of render arrays. These
Chris@0:  *   should be created and added for portions of a render array that
Chris@0:  *   involve expensive calculations in the rendering process.
Chris@0:  * - Cache contexts: Contexts that may affect rendering, such as user role and
Chris@0:  *   language. When no context is specified, it means that the render array
Chris@0:  *   does not vary by any context.
Chris@0:  * - Cache tags: Tags for data that rendering depends on, such as for
Chris@0:  *   individual nodes or user accounts, so that when these change the cache
Chris@0:  *   can be automatically invalidated. If the data consists of entities, you
Chris@0:  *   can use \Drupal\Core\Entity\EntityInterface::getCacheTags() to generate
Chris@0:  *   appropriate tags; configuration objects have a similar method.
Chris@0:  * - Cache max-age: The maximum duration for which a render array may be cached.
Chris@0:  *   Defaults to \Drupal\Core\Cache\Cache::PERMANENT (permanently cacheable).
Chris@0:  *
Chris@0:  * Cache information is provided in the #cache property in a render array. In
Chris@0:  * this property, always supply the cache contexts, tags, and max-age if a
Chris@0:  * render array varies by context, depends on some modifiable data, or depends
Chris@0:  * on information that's only valid for a limited time, respectively. Cache keys
Chris@0:  * should only be set on the portions of a render array that should be cached.
Chris@0:  * Contexts are automatically replaced with the value for the current request
Chris@0:  * (e.g. the current language) and combined with the keys to form a cache ID.
Chris@0:  * The cache contexts, tags, and max-age will be propagated up the render array
Chris@0:  * hierarchy to determine cacheability for containing render array sections.
Chris@0:  *
Chris@0:  * Here's an example of what a #cache property might contain:
Chris@0:  * @code
Chris@0:  *   '#cache' => [
Chris@0:  *     'keys' => ['entity_view', 'node', $node->id()],
Chris@0:  *     'contexts' => ['languages'],
Chris@0:  *     'tags' => $node->getCacheTags(),
Chris@0:  *     'max-age' => Cache::PERMANENT,
Chris@0:  *   ],
Chris@0:  * @endcode
Chris@0:  *
Chris@0:  * At the response level, you'll see X-Drupal-Cache-Contexts and
Chris@0:  * X-Drupal-Cache-Tags headers.
Chris@0:  *
Chris@0:  * See https://www.drupal.org/developing/api/8/render/arrays/cacheability for
Chris@0:  * details.
Chris@0:  *
Chris@0:  * @section sec_attached Attaching libraries in render arrays
Chris@0:  * Libraries, JavaScript settings, feeds, HTML <head> tags and HTML <head> links
Chris@0:  * are attached to elements using the #attached property. The #attached property
Chris@0:  * is an associative array, where the keys are the attachment types and the
Chris@0:  * values are the attached data.
Chris@0:  *
Chris@0:  * The #attached property can also be used to specify HTTP headers and the
Chris@0:  * response status code.
Chris@0:  *
Chris@0:  * The #attached property allows loading of asset libraries (which may contain
Chris@0:  * CSS assets, JavaScript assets, and JavaScript setting assets), JavaScript
Chris@0:  * settings, feeds, HTML <head> tags and HTML <head> links. Specify an array of
Chris@0:  * type => value pairs, where the type (most often 'library' — for libraries, or
Chris@0:  * 'drupalSettings' — for JavaScript settings) to attach these response-level
Chris@0:  * values. Example:
Chris@0:  * @code
Chris@0:  * $build['#attached']['library'][] = 'core/jquery';
Chris@0:  * $build['#attached']['drupalSettings']['foo'] = 'bar';
Chris@0:  * $build['#attached']['feed'][] = [$url, $this->t('Feed title')];
Chris@0:  * @endcode
Chris@0:  *
Chris@0:  * See \Drupal\Core\Render\AttachmentsResponseProcessorInterface for additional
Chris@0:  * information.
Chris@0:  *
Chris@0:  * See \Drupal\Core\Asset\LibraryDiscoveryParser::parseLibraryInfo() for more
Chris@0:  * information on how to define libraries.
Chris@0:  *
Chris@0:  * @section sec_placeholders Placeholders in render arrays
Chris@0:  * Render arrays have a placeholder mechanism, which can be used to add data
Chris@0:  * into the render array late in the rendering process. This works in a similar
Chris@0:  * manner to \Drupal\Component\Render\FormattableMarkup::placeholderFormat(),
Chris@0:  * with the text that ends up in the #markup property of the element at the
Chris@0:  * end of the rendering process getting substitutions from placeholders that
Chris@0:  * are stored in the 'placeholders' element of the #attached property.
Chris@0:  *
Chris@0:  * For example, after the rest of the rendering process was done, if your
Chris@0:  * render array contained:
Chris@0:  * @code
Chris@0:  * $build['my_element'] = [
Chris@0:  *   '#attached' => ['placeholders' => ['@foo' => 'replacement']],
Chris@0:  *   '#markup' => ['Something about @foo'],
Chris@0:  * ];
Chris@0:  * @endcode
Chris@0:  * then #markup would end up containing 'Something about replacement'.
Chris@0:  *
Chris@0:  * Note that each placeholder value can itself be a render array, which will be
Chris@0:  * rendered, and any cache tags generated during rendering will be added to the
Chris@0:  * cache tags for the markup.
Chris@0:  *
Chris@0:  * @section render_pipeline The render pipeline
Chris@0:  * The term "render pipeline" refers to the process Drupal uses to take
Chris@0:  * information provided by modules and render it into a response. See
Chris@0:  * https://www.drupal.org/developing/api/8/render for more details on this
Chris@0:  * process. For background on routing concepts, see
Chris@0:  * @link routing Routing API. @endlink
Chris@0:  *
Chris@0:  * There are in fact multiple render pipelines:
Chris@0:  * - Drupal always uses the Symfony render pipeline. See
Chris@0:  *   http://symfony.com/doc/2.7/components/http_kernel/introduction.html
Chris@0:  * - Within the Symfony render pipeline, there is a Drupal render pipeline,
Chris@0:  *   which handles controllers that return render arrays. (Symfony's render
Chris@0:  *   pipeline only knows how to deal with Response objects; this pipeline
Chris@0:  *   converts render arrays into Response objects.) These render arrays are
Chris@0:  *   considered the main content, and can be rendered into multiple formats:
Chris@0:  *   HTML, Ajax, dialog, and modal. Modules can add support for more formats, by
Chris@0:  *   implementing a main content renderer, which is a service tagged with
Chris@0:  *   'render.main_content_renderer'.
Chris@0:  * - Finally, within the HTML main content renderer, there is another pipeline,
Chris@0:  *   to allow for rendering the page containing the main content in multiple
Chris@0:  *   ways: no decoration at all (just a page showing the main content) or blocks
Chris@0:  *   (a page with regions, with blocks positioned in regions around the main
Chris@0:  *   content). Modules can provide additional options, by implementing a page
Chris@0:  *   variant, which is a plugin annotated with
Chris@0:  *   \Drupal\Core\Display\Annotation\PageDisplayVariant.
Chris@0:  *
Chris@0:  * Routes whose controllers return a \Symfony\Component\HttpFoundation\Response
Chris@0:  * object are fully handled by the Symfony render pipeline.
Chris@0:  *
Chris@0:  * Routes whose controllers return the "main content" as a render array can be
Chris@0:  * requested in multiple formats (HTML, JSON, etc.) and/or in a "decorated"
Chris@0:  * manner, as described above.
Chris@0:  *
Chris@0:  * @see themeable
Chris@0:  * @see \Symfony\Component\HttpKernel\KernelEvents::VIEW
Chris@0:  * @see \Drupal\Core\EventSubscriber\MainContentViewSubscriber
Chris@0:  * @see \Drupal\Core\Render\MainContent\MainContentRendererInterface
Chris@0:  * @see \Drupal\Core\Render\MainContent\HtmlRenderer
Chris@0:  * @see \Drupal\Core\Render\RenderEvents::SELECT_PAGE_DISPLAY_VARIANT
Chris@0:  * @see \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
Chris@0:  * @see \Drupal\block\Plugin\DisplayVariant\BlockPageVariant
Chris@0:  * @see \Drupal\Core\Render\BareHtmlPageRenderer
Chris@0:  *
Chris@0:  * @}
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * @defgroup listing_page_element Page header for Elements page
Chris@0:  * @{
Chris@0:  * Introduction to form and render elements
Chris@0:  *
Chris@0:  * Render elements are referenced in render arrays. Render arrays contain data
Chris@0:  * to be rendered, along with meta-data and attributes that specify how to
Chris@0:  * render the data into markup; see the
Chris@0:  * @link theme_render Render API topic @endlink for an overview of render
Chris@0:  * arrays and render elements. Form arrays are a subset of render arrays,
Chris@0:  * representing HTML forms; form elements are a subset of render elements,
Chris@0:  * representing HTML elements for forms. See the
Chris@0:  * @link form_api Form API topic @endlink for an overview of forms, form
Chris@0:  * processing, and form arrays.
Chris@0:  *
Chris@0:  * Each form and render element type corresponds to an element plugin class;
Chris@0:  * each of them either extends \Drupal\Core\Render\Element\RenderElement
Chris@0:  * (render elements) or \Drupal\Core\Render\Element\FormElement (form
Chris@0:  * elements). Usage and properties are documented on the individual classes,
Chris@0:  * and the two base classes list common properties shared by all render
Chris@0:  * elements and the form element subset, respectively.
Chris@0:  *
Chris@0:  * @see theme_render
Chris@0:  * @see form_api
Chris@0:  * @see \Drupal\Core\Render\Element\RenderElement
Chris@0:  * @see \Drupal\Core\Render\Element\FormElement
Chris@0:  *
Chris@0:  * @}
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * @addtogroup hooks
Chris@0:  * @{
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Allow themes to alter the theme-specific settings form.
Chris@0:  *
Chris@0:  * With this hook, themes can alter the theme-specific settings form in any way
Chris@0:  * allowable by Drupal's Form API, such as adding form elements, changing
Chris@0:  * default values and removing form elements. See the Form API documentation on
Chris@0:  * api.drupal.org for detailed information.
Chris@0:  *
Chris@0:  * Note that the base theme's form alterations will be run before any sub-theme
Chris@0:  * alterations.
Chris@0:  *
Chris@0:  * @param $form
Chris@0:  *   Nested array of form elements that comprise the form.
Chris@0:  * @param $form_state
Chris@0:  *   The current state of the form.
Chris@0:  */
Chris@0: function hook_form_system_theme_settings_alter(&$form, \Drupal\Core\Form\FormStateInterface $form_state) {
Chris@0:   // Add a checkbox to toggle the breadcrumb trail.
Chris@0:   $form['toggle_breadcrumb'] = [
Chris@0:     '#type' => 'checkbox',
Chris@0:     '#title' => t('Display the breadcrumb'),
Chris@0:     '#default_value' => theme_get_setting('features.breadcrumb'),
Chris@0:     '#description'   => t('Show a trail of links from the homepage to the current page.'),
Chris@0:   ];
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Preprocess theme variables for templates.
Chris@0:  *
Chris@0:  * This hook allows modules to preprocess theme variables for theme templates.
Chris@0:  * It is called for all theme hooks implemented as templates, but not for theme
Chris@0:  * hooks implemented as functions. hook_preprocess_HOOK() can be used to
Chris@0:  * preprocess variables for a specific theme hook, whether implemented as a
Chris@0:  * template or function.
Chris@0:  *
Chris@0:  * For more detailed information, see the
Chris@0:  * @link themeable Theme system overview topic @endlink.
Chris@0:  *
Chris@0:  * @param $variables
Chris@0:  *   The variables array (modify in place).
Chris@0:  * @param $hook
Chris@0:  *   The name of the theme hook.
Chris@0:  */
Chris@0: function hook_preprocess(&$variables, $hook) {
Chris@0:   static $hooks;
Chris@0: 
Chris@0:   // Add contextual links to the variables, if the user has permission.
Chris@0: 
Chris@0:   if (!\Drupal::currentUser()->hasPermission('access contextual links')) {
Chris@0:     return;
Chris@0:   }
Chris@0: 
Chris@0:   if (!isset($hooks)) {
Chris@0:     $hooks = theme_get_registry();
Chris@0:   }
Chris@0: 
Chris@0:   // Determine the primary theme function argument.
Chris@0:   if (isset($hooks[$hook]['variables'])) {
Chris@0:     $keys = array_keys($hooks[$hook]['variables']);
Chris@0:     $key = $keys[0];
Chris@0:   }
Chris@0:   else {
Chris@0:     $key = $hooks[$hook]['render element'];
Chris@0:   }
Chris@0: 
Chris@0:   if (isset($variables[$key])) {
Chris@0:     $element = $variables[$key];
Chris@0:   }
Chris@0: 
Chris@0:   if (isset($element) && is_array($element) && !empty($element['#contextual_links'])) {
Chris@0:     $variables['title_suffix']['contextual_links'] = contextual_links_view($element);
Chris@0:     if (!empty($variables['title_suffix']['contextual_links'])) {
Chris@0:       $variables['attributes']['class'][] = 'contextual-links-region';
Chris@0:     }
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Preprocess theme variables for a specific theme hook.
Chris@0:  *
Chris@0:  * This hook allows modules to preprocess theme variables for a specific theme
Chris@0:  * hook. It should only be used if a module needs to override or add to the
Chris@0:  * theme preprocessing for a theme hook it didn't define.
Chris@0:  *
Chris@0:  * For more detailed information, see the
Chris@0:  * @link themeable Theme system overview topic @endlink.
Chris@0:  *
Chris@0:  * @param $variables
Chris@0:  *   The variables array (modify in place).
Chris@0:  */
Chris@0: function hook_preprocess_HOOK(&$variables) {
Chris@0:   // This example is from rdf_preprocess_image(). It adds an RDF attribute
Chris@0:   // to the image hook's variables.
Chris@0:   $variables['attributes']['typeof'] = ['foaf:Image'];
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Provides alternate named suggestions for a specific theme hook.
Chris@0:  *
Chris@0:  * This hook allows modules to provide alternative theme function or template
Chris@0:  * name suggestions.
Chris@0:  *
Chris@0:  * HOOK is the least-specific version of the hook being called. For example, if
Chris@0:  * '#theme' => 'node__article' is called, then hook_theme_suggestions_node()
Chris@0:  * will be invoked, not hook_theme_suggestions_node__article(). The specific
Chris@0:  * hook called (in this case 'node__article') is available in
Chris@0:  * $variables['theme_hook_original'].
Chris@0:  *
Chris@12:  * Implementations of this hook must be placed in *.module or *.theme files, or
Chris@12:  * must otherwise make sure that the hook implementation is available at
Chris@12:  * any given time.
Chris@12:  *
Chris@0:  * @todo Add @code sample.
Chris@0:  *
Chris@0:  * @param array $variables
Chris@0:  *   An array of variables passed to the theme hook. Note that this hook is
Chris@0:  *   invoked before any preprocessing.
Chris@0:  *
Chris@0:  * @return array
Chris@0:  *   An array of theme suggestions.
Chris@0:  *
Chris@0:  * @see hook_theme_suggestions_HOOK_alter()
Chris@0:  */
Chris@0: function hook_theme_suggestions_HOOK(array $variables) {
Chris@0:   $suggestions = [];
Chris@0: 
Chris@0:   $suggestions[] = 'hookname__' . $variables['elements']['#langcode'];
Chris@0: 
Chris@0:   return $suggestions;
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alters named suggestions for all theme hooks.
Chris@0:  *
Chris@0:  * This hook is invoked for all theme hooks, if you are targeting a specific
Chris@0:  * theme hook it's best to use hook_theme_suggestions_HOOK_alter().
Chris@0:  *
Chris@0:  * The call order is as follows: all existing suggestion alter functions are
Chris@0:  * called for module A, then all for module B, etc., followed by all for any
Chris@0:  * base theme(s), and finally for the active theme. The order is
Chris@0:  * determined by system weight, then by extension (module or theme) name.
Chris@0:  *
Chris@0:  * Within each module or theme, suggestion alter hooks are called in the
Chris@0:  * following order: first, hook_theme_suggestions_alter(); second,
Chris@0:  * hook_theme_suggestions_HOOK_alter(). So, for each module or theme, the more
Chris@0:  * general hooks are called first followed by the more specific.
Chris@0:  *
Chris@0:  * In the following example, we provide an alternative template suggestion to
Chris@0:  * node and taxonomy term templates based on the user being logged in.
Chris@0:  * @code
Chris@0:  * function MYMODULE_theme_suggestions_alter(array &$suggestions, array $variables, $hook) {
Chris@0:  *   if (\Drupal::currentUser()->isAuthenticated() && in_array($hook, array('node', 'taxonomy_term'))) {
Chris@0:  *     $suggestions[] = $hook . '__' . 'logged_in';
Chris@0:  *   }
Chris@0:  * }
Chris@0:  *
Chris@0:  * @endcode
Chris@0:  *
Chris@0:  * @param array $suggestions
Chris@0:  *   An array of alternate, more specific names for template files or theme
Chris@0:  *   functions.
Chris@0:  * @param array $variables
Chris@0:  *   An array of variables passed to the theme hook. Note that this hook is
Chris@0:  *   invoked before any variable preprocessing.
Chris@0:  * @param string $hook
Chris@0:  *   The base hook name. For example, if '#theme' => 'node__article' is called,
Chris@0:  *   then $hook will be 'node', not 'node__article'. The specific hook called
Chris@0:  *   (in this case 'node__article') is available in
Chris@0:  *   $variables['theme_hook_original'].
Chris@0:  *
Chris@0:  * @return array
Chris@0:  *   An array of theme suggestions.
Chris@0:  *
Chris@0:  * @see hook_theme_suggestions_HOOK_alter()
Chris@0:  */
Chris@0: function hook_theme_suggestions_alter(array &$suggestions, array $variables, $hook) {
Chris@0:   // Add an interface-language specific suggestion to all theme hooks.
Chris@0:   $suggestions[] = $hook . '__' . \Drupal::languageManager()->getCurrentLanguage()->getId();
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alters named suggestions for a specific theme hook.
Chris@0:  *
Chris@0:  * This hook allows any module or theme to provide alternative theme function or
Chris@0:  * template name suggestions and reorder or remove suggestions provided by
Chris@0:  * hook_theme_suggestions_HOOK() or by earlier invocations of this hook.
Chris@0:  *
Chris@0:  * HOOK is the least-specific version of the hook being called. For example, if
Chris@0:  * '#theme' => 'node__article' is called, then node_theme_suggestions_node()
Chris@0:  * will be invoked, not node_theme_suggestions_node__article(). The specific
Chris@0:  * hook called (in this case 'node__article') is available in
Chris@0:  * $variables['theme_hook_original'].
Chris@0:  *
Chris@12:  * Implementations of this hook must be placed in *.module or *.theme files, or
Chris@12:  * must otherwise make sure that the hook implementation is available at
Chris@12:  * any given time.
Chris@12:  *
Chris@0:  * @todo Add @code sample.
Chris@0:  *
Chris@0:  * @param array $suggestions
Chris@0:  *   An array of theme suggestions.
Chris@0:  * @param array $variables
Chris@0:  *   An array of variables passed to the theme hook. Note that this hook is
Chris@0:  *   invoked before any preprocessing.
Chris@0:  *
Chris@0:  * @see hook_theme_suggestions_alter()
Chris@0:  * @see hook_theme_suggestions_HOOK()
Chris@0:  */
Chris@0: function hook_theme_suggestions_HOOK_alter(array &$suggestions, array $variables) {
Chris@0:   if (empty($variables['header'])) {
Chris@18:     $suggestions[] = 'hookname__no_header';
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Respond to themes being installed.
Chris@0:  *
Chris@0:  * @param array $theme_list
Chris@0:  *   Array containing the names of the themes being installed.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Extension\ThemeHandler::install()
Chris@0:  */
Chris@0: function hook_themes_installed($theme_list) {
Chris@0:   foreach ($theme_list as $theme) {
Chris@0:     block_theme_initialize($theme);
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Respond to themes being uninstalled.
Chris@0:  *
Chris@0:  * @param array $themes
Chris@0:  *   Array containing the names of the themes being uninstalled.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Extension\ThemeHandler::uninstall()
Chris@0:  */
Chris@0: function hook_themes_uninstalled(array $themes) {
Chris@0:   // Remove some state entries depending on the theme.
Chris@0:   foreach ($themes as $theme) {
Chris@0:     \Drupal::state()->delete('example.' . $theme);
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Declare a template file extension to be used with a theme engine.
Chris@0:  *
Chris@0:  * This hook is used in a theme engine implementation in the format of
Chris@0:  * ENGINE_extension().
Chris@0:  *
Chris@0:  * @return string
Chris@0:  *   The file extension the theme engine will recognize.
Chris@0:  */
Chris@0: function hook_extension() {
Chris@0:   // Extension for template base names in Twig.
Chris@0:   return '.html.twig';
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Render a template using the theme engine.
Chris@0:  *
Chris@16:  * It is the theme engine's responsibility to escape variables. The only
Chris@16:  * exception is if a variable implements
Chris@16:  * \Drupal\Component\Render\MarkupInterface. Drupal is inherently unsafe if
Chris@16:  * other variables are not escaped. The helper function
Chris@16:  * theme_render_and_autoescape() may be used for this.
Chris@16:  *
Chris@0:  * @param string $template_file
Chris@0:  *   The path (relative to the Drupal root directory) to the template to be
Chris@0:  *   rendered including its extension in the format 'path/to/TEMPLATE_NAME.EXT'.
Chris@0:  * @param array $variables
Chris@0:  *   A keyed array of variables that are available for composing the output. The
Chris@0:  *   theme engine is responsible for passing all the variables to the template.
Chris@0:  *   Depending on the code in the template, all or just a subset of the
Chris@0:  *   variables might be used in the template.
Chris@0:  *
Chris@0:  * @return string
Chris@0:  *   The output generated from the template. In most cases this will be a string
Chris@0:  *   containing HTML markup.
Chris@0:  */
Chris@0: function hook_render_template($template_file, $variables) {
Chris@0:   $twig_service = \Drupal::service('twig');
Chris@0: 
Chris@0:   return $twig_service->loadTemplate($template_file)->render($variables);
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alter the element type information returned from modules.
Chris@0:  *
Chris@0:  * A module may implement this hook in order to alter the element type defaults
Chris@0:  * defined by a module.
Chris@0:  *
Chris@0:  * @param array $info
Chris@0:  *   An associative array with structure identical to that of the return value
Chris@0:  *   of \Drupal\Core\Render\ElementInfoManagerInterface::getInfo().
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Render\ElementInfoManager
Chris@0:  * @see \Drupal\Core\Render\Element\ElementInterface
Chris@0:  */
Chris@0: function hook_element_info_alter(array &$info) {
Chris@0:   // Decrease the default size of textfields.
Chris@0:   if (isset($info['textfield']['#size'])) {
Chris@0:     $info['textfield']['#size'] = 40;
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Perform necessary alterations to the JavaScript before it is presented on
Chris@0:  * the page.
Chris@0:  *
Chris@0:  * @param $javascript
Chris@0:  *   An array of all JavaScript being presented on the page.
Chris@0:  * @param \Drupal\Core\Asset\AttachedAssetsInterface $assets
Chris@0:  *   The assets attached to the current response.
Chris@0:  *
Chris@0:  * @see drupal_js_defaults()
Chris@0:  * @see \Drupal\Core\Asset\AssetResolver
Chris@0:  */
Chris@0: function hook_js_alter(&$javascript, \Drupal\Core\Asset\AttachedAssetsInterface $assets) {
Chris@0:   // Swap out jQuery to use an updated version of the library.
Chris@0:   $javascript['core/assets/vendor/jquery/jquery.min.js']['data'] = drupal_get_path('module', 'jquery_update') . '/jquery.js';
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Add dynamic library definitions.
Chris@0:  *
Chris@0:  * Modules may implement this hook to add dynamic library definitions. Static
Chris@0:  * libraries, which do not depend on any runtime information, should be declared
Chris@0:  * in a modulename.libraries.yml file instead.
Chris@0:  *
Chris@0:  * @return array[]
Chris@0:  *   An array of library definitions to register, keyed by library ID. The
Chris@0:  *   library ID will be prefixed with the module name automatically.
Chris@0:  *
Chris@0:  * @see core.libraries.yml
Chris@0:  * @see hook_library_info_alter()
Chris@0:  */
Chris@0: function hook_library_info_build() {
Chris@0:   $libraries = [];
Chris@0:   // Add a library whose information changes depending on certain conditions.
Chris@0:   $libraries['mymodule.zombie'] = [
Chris@0:     'dependencies' => [
Chris@0:       'core/backbone',
Chris@0:     ],
Chris@0:   ];
Chris@0:   if (Drupal::moduleHandler()->moduleExists('minifyzombies')) {
Chris@0:     $libraries['mymodule.zombie'] += [
Chris@0:       'js' => [
Chris@0:         'mymodule.zombie.min.js' => [],
Chris@0:       ],
Chris@0:       'css' => [
Chris@0:         'base' => [
Chris@0:           'mymodule.zombie.min.css' => [],
Chris@0:         ],
Chris@0:       ],
Chris@0:     ];
Chris@0:   }
Chris@0:   else {
Chris@0:     $libraries['mymodule.zombie'] += [
Chris@0:       'js' => [
Chris@0:         'mymodule.zombie.js' => [],
Chris@0:       ],
Chris@0:       'css' => [
Chris@0:         'base' => [
Chris@0:           'mymodule.zombie.css' => [],
Chris@0:         ],
Chris@0:       ],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   // Add a library only if a certain condition is met. If code wants to
Chris@0:   // integrate with this library it is safe to (try to) load it unconditionally
Chris@0:   // without reproducing this check. If the library definition does not exist
Chris@0:   // the library (of course) not be loaded but no notices or errors will be
Chris@0:   // triggered.
Chris@0:   if (Drupal::moduleHandler()->moduleExists('vampirize')) {
Chris@0:     $libraries['mymodule.vampire'] = [
Chris@0:       'js' => [
Chris@0:         'js/vampire.js' => [],
Chris@0:       ],
Chris@0:       'css' => [
Chris@0:         'base' => [
Chris@0:           'css/vampire.css',
Chris@0:         ],
Chris@0:       ],
Chris@0:       'dependencies' => [
Chris@0:         'core/jquery',
Chris@0:       ],
Chris@0:     ];
Chris@0:   }
Chris@0:   return $libraries;
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Modify the JavaScript settings (drupalSettings).
Chris@0:  *
Chris@0:  * @param array &$settings
Chris@0:  *   An array of all JavaScript settings (drupalSettings) being presented on the
Chris@0:  *   page.
Chris@0:  * @param \Drupal\Core\Asset\AttachedAssetsInterface $assets
Chris@0:  *   The assets attached to the current response.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Asset\AssetResolver
Chris@0:  *
Chris@0:  * The results of this hook are cached, however modules may use
Chris@0:  * hook_js_settings_alter() to dynamically alter settings.
Chris@0:  */
Chris@0: function hook_js_settings_build(array &$settings, \Drupal\Core\Asset\AttachedAssetsInterface $assets) {
Chris@0:   // Manipulate settings.
Chris@0:   if (isset($settings['dialog'])) {
Chris@0:     $settings['dialog']['autoResize'] = FALSE;
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Perform necessary alterations to the JavaScript settings (drupalSettings).
Chris@0:  *
Chris@0:  * @param array &$settings
Chris@0:  *   An array of all JavaScript settings (drupalSettings) being presented on the
Chris@0:  *   page.
Chris@0:  * @param \Drupal\Core\Asset\AttachedAssetsInterface $assets
Chris@0:  *   The assets attached to the current response.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Asset\AssetResolver
Chris@0:  */
Chris@0: function hook_js_settings_alter(array &$settings, \Drupal\Core\Asset\AttachedAssetsInterface $assets) {
Chris@0:   // Add settings.
Chris@0:   $settings['user']['uid'] = \Drupal::currentUser();
Chris@0: 
Chris@0:   // Manipulate settings.
Chris@0:   if (isset($settings['dialog'])) {
Chris@0:     $settings['dialog']['autoResize'] = FALSE;
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alter libraries provided by an extension.
Chris@0:  *
Chris@0:  * Allows modules and themes to change libraries' definitions; mostly used to
Chris@0:  * update a library to a newer version, while ensuring backward compatibility.
Chris@0:  * In general, such manipulations should only be done to extend the library's
Chris@0:  * functionality in a backward-compatible way, to avoid breaking other modules
Chris@0:  * and themes that may be using the library.
Chris@0:  *
Chris@0:  * @param array $libraries
Chris@0:  *   An associative array of libraries registered by $extension. Keyed by
Chris@0:  *   internal library name and passed by reference.
Chris@0:  * @param string $extension
Chris@0:  *   Can either be 'core' or the machine name of the extension that registered
Chris@0:  *   the libraries.
Chris@0:  *
Chris@0:  * @see \Drupal\Core\Asset\LibraryDiscoveryParser::parseLibraryInfo()
Chris@0:  */
Chris@0: function hook_library_info_alter(&$libraries, $extension) {
Chris@0:   // Update Farbtastic to version 2.0.
Chris@0:   if ($extension == 'core' && isset($libraries['jquery.farbtastic'])) {
Chris@0:     // Verify existing version is older than the one we are updating to.
Chris@0:     if (version_compare($libraries['jquery.farbtastic']['version'], '2.0', '<')) {
Chris@0:       // Update the existing Farbtastic to version 2.0.
Chris@0:       $libraries['jquery.farbtastic']['version'] = '2.0';
Chris@0:       // To accurately replace library files, the order of files and the options
Chris@0:       // of each file have to be retained; e.g., like this:
Chris@0:       $old_path = 'assets/vendor/farbtastic';
Chris@0:       // Since the replaced library files are no longer located in a directory
Chris@0:       // relative to the original extension, specify an absolute path (relative
Chris@0:       // to DRUPAL_ROOT / base_path()) to the new location.
Chris@0:       $new_path = '/' . drupal_get_path('module', 'farbtastic_update') . '/js';
Chris@0:       $new_js = [];
Chris@0:       $replacements = [
Chris@0:         $old_path . '/farbtastic.js' => $new_path . '/farbtastic-2.0.js',
Chris@0:       ];
Chris@0:       foreach ($libraries['jquery.farbtastic']['js'] as $source => $options) {
Chris@0:         if (isset($replacements[$source])) {
Chris@0:           $new_js[$replacements[$source]] = $options;
Chris@0:         }
Chris@0:         else {
Chris@0:           $new_js[$source] = $options;
Chris@0:         }
Chris@0:       }
Chris@0:       $libraries['jquery.farbtastic']['js'] = $new_js;
Chris@0:     }
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alter CSS files before they are output on the page.
Chris@0:  *
Chris@0:  * @param $css
Chris@0:  *   An array of all CSS items (files and inline CSS) being requested on the page.
Chris@0:  * @param \Drupal\Core\Asset\AttachedAssetsInterface $assets
Chris@0:  *   The assets attached to the current response.
Chris@0:  *
Chris@0:  * @see Drupal\Core\Asset\LibraryResolverInterface::getCssAssets()
Chris@0:  */
Chris@0: function hook_css_alter(&$css, \Drupal\Core\Asset\AttachedAssetsInterface $assets) {
Chris@0:   // Remove defaults.css file.
Chris@0:   unset($css[drupal_get_path('module', 'system') . '/defaults.css']);
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Add attachments (typically assets) to a page before it is rendered.
Chris@0:  *
Chris@0:  * Use this hook when you want to conditionally add attachments to a page.
Chris@0:  *
Chris@0:  * If you want to alter the attachments added by other modules or if your module
Chris@0:  * depends on the elements of other modules, use hook_page_attachments_alter()
Chris@0:  * instead, which runs after this hook.
Chris@0:  *
Chris@0:  * If you try to add anything but #attached and #cache to the array, an
Chris@0:  * exception is thrown.
Chris@0:  *
Chris@0:  * @param array &$attachments
Chris@0:  *   An array that you can add attachments to.
Chris@0:  *
Chris@0:  * @see hook_page_attachments_alter()
Chris@0:  */
Chris@0: function hook_page_attachments(array &$attachments) {
Chris@0:   // Unconditionally attach an asset to the page.
Chris@0:   $attachments['#attached']['library'][] = 'core/domready';
Chris@0: 
Chris@0:   // Conditionally attach an asset to the page.
Chris@0:   if (!\Drupal::currentUser()->hasPermission('may pet kittens')) {
Chris@0:     $attachments['#attached']['library'][] = 'core/jquery';
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alter attachments (typically assets) to a page before it is rendered.
Chris@0:  *
Chris@0:  * Use this hook when you want to remove or alter attachments on the page, or
Chris@0:  * add attachments to the page that depend on another module's attachments (this
Chris@0:  * hook runs after hook_page_attachments().
Chris@0:  *
Chris@0:  * If you try to add anything but #attached and #cache to the array, an
Chris@0:  * exception is thrown.
Chris@0:  *
Chris@0:  * @param array &$attachments
Chris@0:  *   Array of all attachments provided by hook_page_attachments() implementations.
Chris@0:  *
Chris@0:  * @see hook_page_attachments()
Chris@0:  */
Chris@0: function hook_page_attachments_alter(array &$attachments) {
Chris@0:   // Conditionally remove an asset.
Chris@0:   if (in_array('core/jquery', $attachments['#attached']['library'])) {
Chris@0:     $index = array_search('core/jquery', $attachments['#attached']['library']);
Chris@0:     unset($attachments['#attached']['library'][$index]);
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Add a renderable array to the top of the page.
Chris@0:  *
Chris@0:  * @param array $page_top
Chris@0:  *   A renderable array representing the top of the page.
Chris@0:  */
Chris@0: function hook_page_top(array &$page_top) {
Chris@0:   $page_top['mymodule'] = ['#markup' => 'This is the top.'];
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Add a renderable array to the bottom of the page.
Chris@0:  *
Chris@0:  * @param array $page_bottom
Chris@0:  *   A renderable array representing the bottom of the page.
Chris@0:  */
Chris@0: function hook_page_bottom(array &$page_bottom) {
Chris@0:   $page_bottom['mymodule'] = ['#markup' => 'This is the bottom.'];
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Register a module or theme's theme implementations.
Chris@0:  *
Chris@0:  * The implementations declared by this hook specify how a particular render
Chris@0:  * array is to be rendered as HTML.
Chris@0:  *
Chris@0:  * @param array $existing
Chris@0:  *   An array of existing implementations that may be used for override
Chris@0:  *   purposes. This is primarily useful for themes that may wish to examine
Chris@0:  *   existing implementations to extract data (such as arguments) so that
Chris@0:  *   it may properly register its own, higher priority implementations.
Chris@0:  * @param $type
Chris@0:  *   Whether a theme, module, etc. is being processed. This is primarily useful
Chris@0:  *   so that themes tell if they are the actual theme being called or a parent
Chris@0:  *   theme. May be one of:
Chris@0:  *   - 'module': A module is being checked for theme implementations.
Chris@0:  *   - 'base_theme_engine': A theme engine is being checked for a theme that is
Chris@0:  *     a parent of the actual theme being used.
Chris@0:  *   - 'theme_engine': A theme engine is being checked for the actual theme
Chris@0:  *     being used.
Chris@0:  *   - 'base_theme': A base theme is being checked for theme implementations.
Chris@0:  *   - 'theme': The actual theme in use is being checked.
Chris@0:  * @param $theme
Chris@0:  *   The actual name of theme, module, etc. that is being being processed.
Chris@0:  * @param $path
Chris@0:  *   The directory path of the theme or module, so that it doesn't need to be
Chris@0:  *   looked up.
Chris@0:  *
Chris@0:  * @return array
Chris@0:  *   An associative array of information about theme implementations. The keys
Chris@0:  *   on the outer array are known as "theme hooks". For theme suggestions,
Chris@0:  *   instead of the array key being the base theme hook, the key is a theme
Chris@0:  *   suggestion name with the format 'base_hook_name__sub_hook_name'.
Chris@0:  *   For render elements, the key is the machine name of the render element.
Chris@0:  *   The array values are themselves arrays containing information about the
Chris@0:  *   theme hook and its implementation. Each information array must contain
Chris@0:  *   either a 'variables' element (for using a #theme element) or a
Chris@0:  *   'render element' element (for render elements), but not both.
Chris@0:  *   The following elements may be part of each information array:
Chris@0:  *   - variables: Only used for #theme in render array: an array of variables,
Chris@0:  *     where the array keys are the names of the variables, and the array
Chris@0:  *     values are the default values if they are not given in the render array.
Chris@0:  *     Template implementations receive each array key as a variable in the
Chris@0:  *     template file (so they must be legal PHP/Twig variable names). Function
Chris@0:  *     implementations are passed the variables in a single $variables function
Chris@0:  *     argument. If you are using these variables in a render array, prefix the
Chris@0:  *     variable names defined here with a #.
Chris@0:  *   - render element: Used for render element items only: the name of the
Chris@0:  *     renderable element or element tree to pass to the theme function. This
Chris@0:  *     name is used as the name of the variable that holds the renderable
Chris@0:  *     element or tree in preprocess and process functions.
Chris@0:  *   - file: The file the implementation resides in. This file will be included
Chris@0:  *     prior to the theme being rendered, to make sure that the function or
Chris@0:  *     preprocess function (as needed) is actually loaded.
Chris@0:  *   - path: Override the path of the file to be used. Ordinarily the module or
Chris@0:  *     theme path will be used, but if the file will not be in the default
Chris@0:  *     path, include it here. This path should be relative to the Drupal root
Chris@0:  *     directory.
Chris@0:  *   - template: If specified, the theme implementation is a template file, and
Chris@0:  *     this is the template name. Do not add 'html.twig' on the end of the
Chris@0:  *     template name. The extension will be added automatically by the default
Chris@0:  *     rendering engine (which is Twig.) If 'path' is specified, 'template'
Chris@0:  *     should also be specified. If neither 'template' nor 'function' are
Chris@0:  *     specified, a default template name will be assumed. For example, if a
Chris@0:  *     module registers the 'search_result' theme hook, 'search-result' will be
Chris@0:  *     assigned as its template name.
Chris@0:  *   - function: (deprecated in Drupal 8.0.x, will be removed in Drupal 9.0.x)
Chris@0:  *     If specified, this will be the function name to invoke for this
Chris@0:  *     implementation. If neither 'template' nor 'function' are specified, a
Chris@0:  *     default template name will be assumed. See above for more details.
Chris@0:  *   - base hook: Used for theme suggestions only: the base theme hook name.
Chris@0:  *     Instead of this suggestion's implementation being used directly, the base
Chris@0:  *     hook will be invoked with this implementation as its first suggestion.
Chris@0:  *     The base hook's files will be included and the base hook's preprocess
Chris@0:  *     functions will be called in addition to any suggestion's preprocess
Chris@0:  *     functions. If an implementation of hook_theme_suggestions_HOOK() (where
Chris@0:  *     HOOK is the base hook) changes the suggestion order, a different
Chris@0:  *     suggestion may be used in place of this suggestion. If after
Chris@0:  *     hook_theme_suggestions_HOOK() this suggestion remains the first
Chris@0:  *     suggestion, then this suggestion's function or template will be used to
Chris@0:  *     generate the rendered output.
Chris@0:  *   - pattern: A regular expression pattern to be used to allow this theme
Chris@0:  *     implementation to have a dynamic name. The convention is to use __ to
Chris@0:  *     differentiate the dynamic portion of the theme. For example, to allow
Chris@0:  *     forums to be themed individually, the pattern might be: 'forum__'. Then,
Chris@0:  *     when the forum is rendered, following render array can be used:
Chris@0:  *     @code
Chris@0:  *     $render_array = array(
Chris@0:  *       '#theme' => array('forum__' . $tid, 'forum'),
Chris@0:  *       '#forum' => $forum,
Chris@0:  *     );
Chris@0:  *     @endcode
Chris@0:  *   - preprocess functions: A list of functions used to preprocess this data.
Chris@0:  *     Ordinarily this won't be used; it's automatically filled in. By default,
Chris@0:  *     for a module this will be filled in as template_preprocess_HOOK. For
Chris@0:  *     a theme this will be filled in as twig_preprocess and
Chris@0:  *     twig_preprocess_HOOK as well as themename_preprocess and
Chris@0:  *     themename_preprocess_HOOK.
Chris@0:  *   - override preprocess functions: Set to TRUE when a theme does NOT want
Chris@0:  *     the standard preprocess functions to run. This can be used to give a
Chris@0:  *     theme FULL control over how variables are set. For example, if a theme
Chris@0:  *     wants total control over how certain variables in the page.html.twig are
Chris@0:  *     set, this can be set to true. Please keep in mind that when this is used
Chris@0:  *     by a theme, that theme becomes responsible for making sure necessary
Chris@0:  *     variables are set.
Chris@0:  *   - type: (automatically derived) Where the theme hook is defined:
Chris@0:  *     'module', 'theme_engine', or 'theme'.
Chris@0:  *   - theme path: (automatically derived) The directory path of the theme or
Chris@0:  *     module, so that it doesn't need to be looked up.
Chris@0:  *
Chris@0:  * @see themeable
Chris@0:  * @see hook_theme_registry_alter()
Chris@0:  */
Chris@0: function hook_theme($existing, $type, $theme, $path) {
Chris@0:   return [
Chris@0:     'forum_display' => [
Chris@0:       'variables' => ['forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL],
Chris@0:     ],
Chris@0:     'forum_list' => [
Chris@0:       'variables' => ['forums' => NULL, 'parents' => NULL, 'tid' => NULL],
Chris@0:     ],
Chris@0:     'forum_icon' => [
Chris@0:       'variables' => ['new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0],
Chris@0:     ],
Chris@0:     'status_report' => [
Chris@0:       'render element' => 'requirements',
Chris@0:       'file' => 'system.admin.inc',
Chris@0:     ],
Chris@0:   ];
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alter the theme registry information returned from hook_theme().
Chris@0:  *
Chris@0:  * The theme registry stores information about all available theme hooks,
Chris@0:  * including which callback functions those hooks will call when triggered,
Chris@0:  * what template files are exposed by these hooks, and so on.
Chris@0:  *
Chris@0:  * Note that this hook is only executed as the theme cache is re-built.
Chris@0:  * Changes here will not be visible until the next cache clear.
Chris@0:  *
Chris@0:  * The $theme_registry array is keyed by theme hook name, and contains the
Chris@0:  * information returned from hook_theme(), as well as additional properties
Chris@0:  * added by \Drupal\Core\Theme\Registry::processExtension().
Chris@0:  *
Chris@0:  * For example:
Chris@0:  * @code
Chris@0:  * $theme_registry['block_content_add_list'] = array (
Chris@0:  *   'template' => 'block-content-add-list',
Chris@0:  *   'path' => 'core/themes/seven/templates',
Chris@0:  *   'type' => 'theme_engine',
Chris@0:  *   'theme path' => 'core/themes/seven',
Chris@0:  *   'includes' => array (
Chris@0:  *     0 => 'core/modules/block_content/block_content.pages.inc',
Chris@0:  *   ),
Chris@0:  *   'variables' => array (
Chris@0:  *     'content' => NULL,
Chris@0:  *   ),
Chris@0:  *   'preprocess functions' => array (
Chris@0:  *     0 => 'template_preprocess',
Chris@0:  *     1 => 'template_preprocess_block_content_add_list',
Chris@0:  *     2 => 'contextual_preprocess',
Chris@0:  *     3 => 'seven_preprocess_block_content_add_list',
Chris@0:  *   ),
Chris@0:  * );
Chris@0:  * @endcode
Chris@0:  *
Chris@0:  * @param $theme_registry
Chris@0:  *   The entire cache of theme registry information, post-processing.
Chris@0:  *
Chris@0:  * @see hook_theme()
Chris@0:  * @see \Drupal\Core\Theme\Registry::processExtension()
Chris@0:  */
Chris@0: function hook_theme_registry_alter(&$theme_registry) {
Chris@0:   // Kill the next/previous forum topic navigation links.
Chris@0:   foreach ($theme_registry['forum_topic_navigation']['preprocess functions'] as $key => $value) {
Chris@0:     if ($value == 'template_preprocess_forum_topic_navigation') {
Chris@0:       unset($theme_registry['forum_topic_navigation']['preprocess functions'][$key]);
Chris@0:     }
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Alter the default, hook-independent variables for all templates.
Chris@0:  *
Chris@0:  * Allows modules to provide additional default template variables or manipulate
Chris@0:  * existing. This hook is invoked from template_preprocess() after basic default
Chris@0:  * template variables have been set up and before the next template preprocess
Chris@0:  * function is invoked.
Chris@0:  *
Chris@0:  * Note that the default template variables are statically cached within a
Chris@0:  * request. When adding a template variable that depends on other context, it is
Chris@0:  * your responsibility to appropriately reset the static cache in
Chris@0:  * template_preprocess() when needed:
Chris@0:  * @code
Chris@0:  * drupal_static_reset('template_preprocess');
Chris@0:  * @endcode
Chris@0:  *
Chris@0:  * See user_template_preprocess_default_variables_alter() for an example.
Chris@0:  *
Chris@0:  * @param array $variables
Chris@0:  *   An associative array of default template variables, as set up by
Chris@0:  *   _template_preprocess_default_variables(). Passed by reference.
Chris@0:  *
Chris@0:  * @see template_preprocess()
Chris@0:  * @see _template_preprocess_default_variables()
Chris@0:  */
Chris@0: function hook_template_preprocess_default_variables_alter(&$variables) {
Chris@0:   $variables['is_admin'] = \Drupal::currentUser()->hasPermission('access administration pages');
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * @} End of "addtogroup hooks".
Chris@0:  */