theme.inc 99.3 KB
Newer Older
Dries's avatar
 
Dries committed
1
<?php
2

3
/**
Dries's avatar
 
Dries committed
4
 * @file
5
 * The theme system, which controls the output of Drupal.
Dries's avatar
 
Dries committed
6 7 8 9
 *
 * The theme system allows for nearly all output of the Drupal system to be
 * customized by user themes.
 */
Dries's avatar
 
Dries committed
10

11
use Drupal\Component\Utility\String;
12
use Drupal\Component\Utility\Url;
13
use Drupal\Core\Config\Config;
14
use Drupal\Core\Language\Language;
15
use Drupal\Core\Extension\Extension;
16
use Drupal\Core\Extension\ExtensionNameLengthException;
17
use Drupal\Core\Template\Attribute;
18
use Drupal\Core\Template\RenderWrapper;
19
use Drupal\Core\Theme\ThemeSettings;
20
use Drupal\Component\Utility\NestedArray;
21
use Drupal\Core\Render\Element;
22

23
/**
24
 * @defgroup content_flags Content markers
25 26 27 28
 * @{
 * Markers used by theme_mark() and node_mark() to designate content.
 * @see theme_mark(), node_mark()
 */
29 30 31 32

/**
 * Mark content as read.
 */
33
const MARK_READ = 0;
34 35 36 37

/**
 * Mark content as being new.
 */
38
const MARK_NEW = 1;
39 40 41 42

/**
 * Mark content as being updated.
 */
43
const MARK_UPDATED = 2;
44

45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
/**
 * A responsive table class; hide table cell on narrow devices.
 *
 * Indicates that a column has medium priority and thus can be hidden on narrow
 * width devices and shown on medium+ width devices (i.e. tablets and desktops).
 */
const RESPONSIVE_PRIORITY_MEDIUM = 'priority-medium';

/**
 * A responsive table class; only show table cell on wide devices.
 *
 * Indicates that a column has low priority and thus can be hidden on narrow
 * and medium viewports and shown on wide devices (i.e. desktops).
 */
const RESPONSIVE_PRIORITY_LOW = 'priority-low';

61
/**
62
 * @} End of "defgroup content_flags".
63 64
 */

65 66 67
/**
 * Determines if a theme is available to use.
 *
68
 * @param string|\Drupal\Core\Extension\Extension $theme
69 70
 *   Either the name of a theme or a full theme object.
 *
71
 * @return bool
72 73
 *   Boolean TRUE if the theme is enabled or is the site administration theme;
 *   FALSE otherwise.
74
 *
75 76 77 78
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('access_check.theme')->checkAccess().
 *
 * @see \Drupal\Core\Theme\ThemeAccessCheck::checkAccess().
79 80
 */
function drupal_theme_access($theme) {
81
  if ($theme instanceof Extension) {
82
    $theme = $theme->name;
83
  }
84
  return \Drupal::service('access_check.theme')->checkAccess($theme);
85 86
}

Dries's avatar
 
Dries committed
87
/**
88
 * Initializes the theme system by loading the theme.
Dries's avatar
 
Dries committed
89
 */
90
function drupal_theme_initialize() {
91
  global $theme, $user, $theme_key;
92 93 94 95 96

  // If $theme is already set, assume the others are set, too, and do nothing
  if (isset($theme)) {
    return;
  }
Dries's avatar
 
Dries committed
97

98
  $themes = list_themes();
Dries's avatar
 
Dries committed
99

100 101 102 103 104
  // @todo Let the theme.negotiator listen to the kernel request event.
  // Determine the active theme for the theme negotiator service. This includes
  // the default theme as well as really specific ones like the ajax base theme.
  $request = \Drupal::request();
  $theme = \Drupal::service('theme.negotiator')->determineActiveTheme($request) ?: 'stark';
Dries's avatar
 
Dries committed
105 106 107 108

  // Store the identifier for retrieving theme settings with.
  $theme_key = $theme;

109 110 111 112
  // Find all our ancestor themes and put them in an array.
  $base_theme = array();
  $ancestor = $theme;
  while ($ancestor && isset($themes[$ancestor]->base_theme)) {
113
    $ancestor = $themes[$ancestor]->base_theme;
114
    $base_theme[] = $themes[$ancestor];
115
  }
116
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
117 118 119
}

/**
120 121 122
 * Initializes the theme system given already loaded information.
 *
 * This function is useful to initialize a theme when no database is present.
123
 *
124 125 126
 * @param \Drupal\Core\Extension\Extension $theme
 *   The theme extension object.
 * @param \Drupal\Core\Extension\Extension[] $base_theme
127 128 129 130 131 132
 *    An optional array of objects that represent the 'base theme' if the
 *    theme is meant to be derivative of another theme. It requires
 *    the same information as the $theme object. It should be in
 *    'oldest first' order, meaning the top level of the chain will
 *    be first.
 */
133
function _drupal_theme_initialize($theme, $base_theme = array()) {
134 135 136 137 138 139
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

  $theme_path = dirname($theme->filename);

140 141 142 143
  // Prepare stylesheets from this theme as well as all ancestor themes.
  // We work it this way so that we can have child themes override parent
  // theme stylesheets easily.
  $final_stylesheets = array();
144 145 146 147
  // CSS file basenames to override, pointing to the final, overridden filepath.
  $theme->stylesheets_override = array();
  // CSS file basenames to remove.
  $theme->stylesheets_remove = array();
148 149 150 151 152 153 154 155 156 157

  // Grab stylesheets from base theme
  foreach ($base_theme as $base) {
    if (!empty($base->stylesheets)) {
      foreach ($base->stylesheets as $media => $stylesheets) {
        foreach ($stylesheets as $name => $stylesheet) {
          $final_stylesheets[$media][$name] = $stylesheet;
        }
      }
    }
158 159 160 161 162 163 164 165 166 167 168 169
    $base_theme_path = dirname($base->filename);
    if (!empty($base->info['stylesheets-remove'])) {
      foreach ($base->info['stylesheets-remove'] as $basename) {
        $theme->stylesheets_remove[$basename] = $base_theme_path . '/' . $basename;
      }
    }
    if (!empty($base->info['stylesheets-override'])) {
      foreach ($base->info['stylesheets-override'] as $name) {
        $basename = drupal_basename($name);
        $theme->stylesheets_override[$basename] = $base_theme_path . '/' . $name;
      }
    }
170 171
  }

172 173 174
  // Add stylesheets used by this theme.
  if (!empty($theme->stylesheets)) {
    foreach ($theme->stylesheets as $media => $stylesheets) {
175 176 177 178 179
      foreach ($stylesheets as $name => $stylesheet) {
        $final_stylesheets[$media][$name] = $stylesheet;
      }
    }
  }
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
  if (!empty($theme->info['stylesheets-remove'])) {
    foreach ($theme->info['stylesheets-remove'] as $basename) {
      $theme->stylesheets_remove[$basename] = $theme_path . '/' . $basename;

      if (isset($theme->stylesheets_override[$basename])) {
        unset($theme->stylesheets_override[$basename]);
      }
    }
  }
  if (!empty($theme->info['stylesheets-override'])) {
    foreach ($theme->info['stylesheets-override'] as $name) {
      $basename = drupal_basename($name);
      $theme->stylesheets_override[$basename] = $theme_path . '/' . $name;

      if (isset($theme->stylesheets_remove[$basename])) {
        unset($theme->stylesheets_remove[$basename]);
      }
    }
  }
199

200 201
  // And now add the stylesheets properly.
  $css = array();
202 203
  foreach ($final_stylesheets as $media => $stylesheets) {
    foreach ($stylesheets as $stylesheet) {
204 205 206 207 208
      $css['#attached']['css'][$stylesheet] = array(
        'group' => CSS_AGGREGATE_THEME,
        'every_page' => TRUE,
        'media' => $media
      );
209 210
    }
  }
211
  drupal_render($css);
212 213 214 215 216 217 218 219 220

  // Do basically the same as the above for scripts
  $final_scripts = array();

  // Grab scripts from base theme
  foreach ($base_theme as $base) {
    if (!empty($base->scripts)) {
      foreach ($base->scripts as $name => $script) {
        $final_scripts[$name] = $script;
221
      }
Dries's avatar
 
Dries committed
222 223
    }
  }
224

225 226
  // Add scripts used by this theme.
  if (!empty($theme->scripts)) {
227 228
    foreach ($theme->scripts as $name => $script) {
      $final_scripts[$name] = $script;
229 230 231
    }
  }

232
  // Add scripts used by this theme.
233
  $js = array();
234
  foreach ($final_scripts as $script) {
235 236 237 238 239
    $js['#attached']['js'][] = array(
      'data' => $script,
      'group' => JS_THEME,
      'every_page' => TRUE,
    );
240
  }
241
  drupal_render($js);
242

243 244 245 246 247
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
248
    include_once DRUPAL_ROOT . '/' . $theme->owner;
249 250

    $theme_engine = $theme->engine;
251
    if (function_exists($theme_engine . '_init')) {
252
      foreach ($base_theme as $base) {
253
        call_user_func($theme_engine . '_init', $base);
254
      }
255
      call_user_func($theme_engine . '_init', $theme);
256 257 258 259 260 261 262
    }
  }
  else {
    // include non-engine theme files
    foreach ($base_theme as $base) {
      // Include the theme file or the engine.
      if (!empty($base->owner)) {
263
        include_once DRUPAL_ROOT . '/' . $base->owner;
264 265 266 267
      }
    }
    // and our theme gets one too.
    if (!empty($theme->owner)) {
268
      include_once DRUPAL_ROOT . '/' . $theme->owner;
Dries's avatar
 
Dries committed
269 270
    }
  }
271 272

  // Always include Twig as the default theme engine.
273
  include_once DRUPAL_ROOT . '/core/themes/engines/twig/twig.engine';
Dries's avatar
 
Dries committed
274 275
}

276
/**
277
 * Gets the theme registry.
278
 *
279
 * @param bool $complete
280
 *   Optional boolean to indicate whether to return the complete theme registry
281 282 283 284 285 286 287
 *   array or an instance of the Drupal\Core\Utility\ThemeRegistry class.
 *   If TRUE, the complete theme registry array will be returned. This is useful
 *   if you want to foreach over the whole registry, use array_* functions or
 *   inspect it in a debugger. If FALSE, an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class will be returned, this provides an
 *   ArrayObject which allows it to be accessed with array syntax and isset(),
 *   and should be more lightweight than the full registry. Defaults to TRUE.
288
 *
289
 * @return
290 291
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
292
 */
293
function theme_get_registry($complete = TRUE) {
294
  $theme_registry = \Drupal::service('theme.registry');
295
  if ($complete) {
296
    return $theme_registry->get();
297 298
  }
  else {
299
    return $theme_registry->getRuntime();
300 301 302 303
  }
}

/**
304 305 306 307
 * Forces the system to rebuild the theme registry.
 *
 * This function should be called when modules are added to the system, or when
 * a dynamic system needs to add more theme hooks.
308
 */
309
function drupal_theme_rebuild() {
310
  \Drupal::service('theme.registry')->reset();
311 312
}

Dries's avatar
 
Dries committed
313
/**
314
 * Returns a list of all currently available themes.
Dries's avatar
 
Dries committed
315
 *
316 317
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
318
 *
Dries's avatar
 
Dries committed
319
 * @param $refresh
320
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
321
 *
322
 * @return
323
 *   An associative array of the currently available themes. The keys are the
324
 *   themes' machine names and the values are objects having the following
325
 *   properties:
326
 *   - filename: The filepath and name of the .info.yml file.
327 328
 *   - name: The machine name of the theme.
 *   - status: 1 for enabled, 0 for disabled themes.
329
 *   - info: The contents of the .info.yml file.
330 331 332 333
 *   - stylesheets: A two dimensional array, using the first key for the
 *     media attribute (e.g. 'all'), the second for the name of the file
 *     (e.g. style.css). The value is a complete filepath (e.g.
 *     themes/bartik/style.css). Not set if no stylesheets are defined in the
334
 *     .info.yml file.
335 336
 *   - scripts: An associative array of JavaScripts, using the filename as key
 *     and the complete filepath as value. Not set if no scripts are defined in
337
 *     the .info.yml file.
338 339 340
 *   - prefix: The base theme engine prefix.
 *   - engine: The machine name of the theme engine.
 *   - base_theme: If this is a sub-theme, the machine name of the base theme
341
 *     defined in the .info.yml file. Otherwise, the element is not set.
342 343 344 345 346 347 348 349 350 351 352 353 354 355
 *   - base_themes: If this is a sub-theme, an associative array of the
 *     base-theme ancestors of this theme, starting with this theme's base
 *     theme, then the base theme's own base theme, etc. Each entry has an
 *     array key equal to the theme's machine name, and a value equal to the
 *     human-readable theme name; if a theme with matching machine name does
 *     not exist in the system, the value will instead be NULL (and since the
 *     system would not know whether that theme itself has a base theme, that
 *     will end the array of base themes). This is not set if the theme is not
 *     a sub-theme.
 *   - sub_themes: An associative array of themes on the system that are
 *     either direct sub-themes (that is, they declare this theme to be
 *     their base theme), direct sub-themes of sub-themes, etc. The keys are
 *     the themes' machine names, and the values are the themes' human-readable
 *     names. This element is not set if there are no themes on the system that
356
 *     declare this theme as their base theme.
357
 *
358 359 360 361
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('theme_handler')->listInfo().
 *
 * @see \Drupal\Core\Extension\ThemeHandler::listInfo().
362
 */
363
function list_themes($refresh = FALSE) {
364 365
  /** @var \Drupal\Core\Extension\ThemeHandler $theme_handler */
  $theme_handler = \Drupal::service('theme_handler');
Dries's avatar
 
Dries committed
366 367

  if ($refresh) {
368
    $theme_handler->reset();
369
    system_list_reset();
Dries's avatar
 
Dries committed
370 371
  }

372
  return $theme_handler->listInfo();
Dries's avatar
 
Dries committed
373 374
}

375
/**
376
 * Finds all the base themes for the specified theme.
377
 *
378 379
 * Themes can inherit templates and function implementations from earlier
 * themes.
380 381 382 383 384
 *
 * @param $themes
 *   An array of available themes.
 * @param $key
 *   The name of the theme whose base we are looking for.
385
 *
386 387 388
 * @return
 *   Returns an array of all of the theme's ancestors; the first element's value
 *   will be NULL if an error occurred.
389
 *
390 391 392 393
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal::service('theme_handler')->getBaseThemes().
 *
 * @see \Drupal\Core\Extension\ThemeHandler::getBaseThemes().
394
 */
395 396
function drupal_find_base_themes($themes, $key) {
  return \Drupal::service('theme_handler')->getBaseThemes($themes, $key);
397 398
}

Dries's avatar
 
Dries committed
399
/**
400 401
 * Generates themed output.
 *
402
 * All requests for themed output must go through this function (however,
403 404
 * calling the _theme() function directly is very strongly discouraged - see
 * next paragraph). It examines the request and routes it to the appropriate
405 406
 * @link themeable theme function or template @endlink, by checking the theme
 * registry.
407
 *
408
 * Avoid calling this function directly. It is preferable to replace direct
409
 * calls to the _theme() function with calls to drupal_render() by passing a
410
 * render array with a #theme key to drupal_render(), which in turn calls
411
 * _theme().
412
 *
413
 * @section sec_theme_hooks Theme Hooks
414 415 416 417 418 419 420
 * Most commonly, the first argument to this function is the name of the theme
 * hook. For instance, to theme a taxonomy term, the theme hook name is
 * 'taxonomy_term'. Modules register theme hooks within a hook_theme()
 * implementation and provide a default implementation via a function named
 * theme_HOOK() (e.g., theme_taxonomy_term()) or via a template file named
 * according to the value of the 'template' key registered with the theme hook
 * (see hook_theme() for details). Default templates are implemented with the
421
 * Twig rendering engine and are named the same as the theme hook, with
422
 * underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
423
 * default template is 'taxonomy-term.html.twig'.
424
 *
425
 * @subsection sub_overriding_theme_hooks Overriding Theme Hooks
426 427 428 429 430 431 432 433
 * Themes may also register new theme hooks within a hook_theme()
 * implementation, but it is more common for themes to override default
 * implementations provided by modules than to register entirely new theme
 * hooks. Themes can override a default implementation by implementing a
 * function named THEME_HOOK() (for example, the 'bartik' theme overrides the
 * default implementation of the 'menu_tree' theme hook by implementing a
 * bartik_menu_tree() function), or by adding a template file within its folder
 * structure that follows the template naming structure used by the theme's
434 435 436
 * rendering engine (for example, since the Bartik theme uses the Twig rendering
 * engine, it overrides the default implementation of the 'page' theme hook by
 * containing a 'page.html.twig' file within its folder structure).
437
 *
438
 * @subsection sub_preprocess_templates Preprocessing for Template Files
439 440 441 442 443 444 445 446
 * If the implementation is a template file, several functions are called before
 * the template file is invoked to modify the $variables array. These make up
 * the "preprocessing" phase, and are executed (if they exist), in the following
 * order (note that in the following list, HOOK indicates the theme hook name,
 * MODULE indicates a module name, THEME indicates a theme name, and ENGINE
 * indicates a theme engine name):
 * - template_preprocess(&$variables, $hook): Creates a default set of variables
 *   for all theme hooks with template implementations.
447 448
 * - template_preprocess_HOOK(&$variables): Should be implemented by the module
 *   that registers the theme hook, to set up default variables.
449 450 451
 * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
 *   implementing modules.
 * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
452 453
 *   all implementing modules, so that modules that didn't define the theme hook
 *   can alter the variables.
454
 * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
455
 *   set necessary variables for all theme hooks with template implementations.
456 457 458
 * - 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
459
 *   variables for all theme hooks with template implementations.
460 461 462
 * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
 *   variables specific to the particular theme hook.
 *
463
 * @subsection sub_preprocess_theme_funcs Preprocessing for Theme Functions
464
 * If the implementation is a function, only the theme-hook-specific preprocess
465 466 467 468
 * 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.
469
 *
470
 * @subsection sub_alternate_suggestions Suggesting Alternate Hooks
471 472 473 474
 * Alternate hooks can be suggested by implementing the hook-specific
 * hook_theme_suggestions_HOOK_alter() or the generic
 * hook_theme_suggestions_alter(). These alter hooks are used to manipulate an
 * array of suggested alternate theme hooks to use, in reverse order of
475 476 477 478
 * priority. _theme() will use the highest priority implementation that exists.
 * If none exists, _theme() will use the implementation for the theme hook it
 * was called with. These suggestions are similar to and are used for similar
 * reasons as calling _theme() with an array as the $hook parameter (see below).
479
 * The difference is whether the suggestions are determined by the code that
480
 * calls _theme() or by altering the suggestions via the suggestion alter hooks.
481
 *
482
 * @param $hook
483 484
 *   The name of the theme hook to call. If the name contains a
 *   double-underscore ('__') and there isn't an implementation for the full
485
 *   name, the part before the '__' is checked. This allows a fallback to a
486
 *   more generic implementation. For example, if _theme('links__node', ...) is
487 488
 *   called, but there is no implementation of that theme hook, then the
 *   'links' implementation is used. This process is iterative, so if
489
 *   _theme('links__contextual__node', ...) is called, _theme() checks for the
490 491 492 493 494 495
 *   following implementations, and uses the first one that exists:
 *   - links__contextual__node
 *   - links__contextual
 *   - links
 *   This allows themes to create specific theme implementations for named
 *   objects and contexts of otherwise generic theme hooks. The $hook parameter
496
 *   may also be an array, in which case the first theme hook that has an
497
 *   implementation is used. This allows for the code that calls _theme() to
498
 *   explicitly specify the fallback order in a situation where using the '__'
499
 *   convention is not desired or is insufficient.
500 501
 * @param $variables
 *   An associative array of variables to merge with defaults from the theme
502 503 504 505
 *   registry, pass to preprocess functions for modification, and finally, pass
 *   to the function or template implementing the theme hook. Alternatively,
 *   this can be a renderable array, in which case, its properties are mapped to
 *   variables expected by the theme hook implementations.
506
 *
507 508 509
 * @return string|false
 *   An HTML string representing the themed output or FALSE if the passed $hook
 *   is not implemented.
510
 *
511
 * @see drupal_render()
512
 * @see themeable
513 514
 * @see hook_theme()
 * @see template_preprocess()
Dries's avatar
 
Dries committed
515
 */
516
function _theme($hook, $variables = array()) {
517
  static $default_attributes;
518 519
  // If called before all modules are loaded, we do not necessarily have a full
  // theme registry to work with, and therefore cannot process the theme
520
  // request properly. See also \Drupal\Core\Theme\Registry::get().
521
  if (!\Drupal::moduleHandler()->isLoaded() && !defined('MAINTENANCE_MODE')) {
522
    throw new Exception(t('_theme() may not be called until all modules are loaded.'));
523 524
  }

525 526
  /** @var \Drupal\Core\Utility\ThemeRegistry $theme_registry */
  $theme_registry = \Drupal::service('theme.registry')->getRuntime();
527

528 529
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
530 531
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
532
      if ($theme_registry->has($candidate)) {
533 534 535 536 537
        break;
      }
    }
    $hook = $candidate;
  }
538 539 540
  // Save the original theme hook, so it can be supplied to theme variable
  // preprocess callbacks.
  $original_hook = $hook;
541

542 543
  // If there's no implementation, check for more generic fallbacks. If there's
  // still no implementation, log an error and return an empty string.
544
  if (!$theme_registry->has($hook)) {
545 546 547 548
    // Iteratively strip everything after the last '__' delimiter, until an
    // implementation is found.
    while ($pos = strrpos($hook, '__')) {
      $hook = substr($hook, 0, $pos);
549
      if ($theme_registry->has($hook)) {
550 551 552
        break;
      }
    }
553
    if (!$theme_registry->has($hook)) {
554 555 556
      // Only log a message when not trying theme suggestions ($hook being an
      // array).
      if (!isset($candidate)) {
557
        watchdog('theme', 'Theme hook %hook not found.', array('%hook' => $hook), WATCHDOG_WARNING);
558
      }
559
      // There is no theme implementation for the hook passed. Return FALSE so
560
      // the function calling _theme() can differentiate between a hook that
561 562
      // exists and renders an empty string and a hook that is not implemented.
      return FALSE;
563
    }
564 565
  }

566
  $info = $theme_registry->get($hook);
567 568 569
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
570
  $theme_path = $info['theme path'];
Dries's avatar
 
Dries committed
571

572 573

  // If a renderable array is passed as $variables, then set $variables to
574
  // the arguments expected by the theme function.
575 576 577
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
578 579
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {
580
        if (isset($element["#$name"]) || array_key_exists("#$name", $element)) {
581 582
          $variables[$name] = $element["#$name"];
        }
583 584
      }
    }
585 586
    else {
      $variables[$info['render element']] = $element;
587 588
      // Give a hint to render engines to prevent infinite recursion.
      $variables[$info['render element']]['#render_children'] = TRUE;
589
    }
590
  }
591

592
  // Merge in argument defaults.
593 594 595 596 597
  if (!empty($info['variables'])) {
    $variables += $info['variables'];
  }
  elseif (!empty($info['render element'])) {
    $variables += array($info['render element'] => array());
598
  }
599 600 601 602
  // Supply original caller info.
  $variables += array(
    'theme_hook_original' => $original_hook,
  );
603

604 605 606 607 608 609 610 611 612 613 614 615 616
  // Set base hook for later use. For example if '#theme' => 'node__article'
  // is called, we run hook_theme_suggestions_node_alter() rather than
  // hook_theme_suggestions_node__article_alter(), and also pass in the base
  // hook as the last parameter to the suggestions alter hooks.
  if (isset($info['base hook'])) {
    $base_theme_hook = $info['base hook'];
  }
  else {
    $base_theme_hook = $hook;
  }

  // Invoke hook_theme_suggestions_HOOK().
  $suggestions = Drupal::moduleHandler()->invokeAll('theme_suggestions_' . $base_theme_hook, array($variables));
617
  // If _theme() was invoked with a direct theme suggestion like
618 619 620 621 622
  // '#theme' => 'node__article', add it to the suggestions array before
  // invoking suggestion alter hooks.
  if (isset($info['base hook'])) {
    $suggestions[] = $hook;
  }
623 624 625 626 627 628 629 630

  // Invoke hook_theme_suggestions_alter() and
  // hook_theme_suggestions_HOOK_alter().
  $hooks = array(
    'theme_suggestions',
    'theme_suggestions_' . $base_theme_hook,
  );
  \Drupal::moduleHandler()->alter($hooks, $suggestions, $variables, $base_theme_hook);
631 632

  // Check if each suggestion exists in the theme registry, and if so,
633 634
  // use it instead of the hook that _theme() was called with. For example, a
  // function may call _theme('node', ...), but a module can add
635 636 637
  // 'node__article' as a suggestion via hook_theme_suggestions_HOOK_alter(),
  // enabling a theme to have an alternate template file for article nodes.
  foreach (array_reverse($suggestions) as $suggestion) {
638 639
    if ($theme_registry->has($suggestion)) {
      $info = $theme_registry->get($suggestion);
640 641 642 643
      break;
    }
  }

644 645 646 647 648 649 650 651
  // Include a file if the theme function or variable preprocessor is held
  // elsewhere.
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
    }
  }

652
  // Invoke the variable preprocessors, if any.
653 654
  if (isset($info['base hook'])) {
    $base_hook = $info['base hook'];
655
    $base_hook_info = $theme_registry->get($base_hook);
656
    // Include files required by the base hook, since its variable preprocessors
657 658 659 660 661 662
    // might reside there.
    if (!empty($base_hook_info['includes'])) {
      foreach ($base_hook_info['includes'] as $include_file) {
        include_once DRUPAL_ROOT . '/' . $include_file;
      }
    }
663
    // Replace the preprocess functions with those from the base hook.
664
    if (isset($base_hook_info['preprocess functions'])) {
665 666 667 668
      // Set a variable for the 'theme_hook_suggestion'. This is used to
      // maintain backwards compatibility with template engines.
      $theme_hook_suggestion = $hook;
      $info['preprocess functions'] = $base_hook_info['preprocess functions'];
669 670
    }
  }
671 672 673 674
  if (isset($info['preprocess functions'])) {
    foreach ($info['preprocess functions'] as $preprocessor_function) {
      if (function_exists($preprocessor_function)) {
        $preprocessor_function($variables, $hook, $info);
675
      }
676 677
    }
  }
678

679
  // Generate the output using either a function or a template.
680
  $output = '';
681
  if (isset($info['function'])) {
682
    if (function_exists($info['function'])) {
683
      $output = $info['function']($variables);
Dries's avatar
 
Dries committed
684
    }
Dries's avatar
 
Dries committed
685
  }
686
  else {
687 688
    $render_function = 'twig_render_template';
    $extension = '.html.twig';
689

690
    // The theme engine may use a different extension and a different renderer.
691 692
    global $theme_engine;
    if (isset($theme_engine)) {
693
      if ($info['type'] != 'module') {
694 695
        if (function_exists($theme_engine . '_render_template')) {
          $render_function = $theme_engine . '_render_template';
696
        }
697
        $extension_function = $theme_engine . '_extension';
698 699 700 701 702 703
        if (function_exists($extension_function)) {
          $extension = $extension_function();
        }
      }
    }

704 705 706 707 708
    // In some cases, a template implementation may not have had
    // template_preprocess() run (for example, if the default implementation is
    // a function, but a template overrides that default implementation). In
    // these cases, a template should still be able to expect to have access to
    // the variables provided by template_preprocess(), so we add them here if
709 710 711 712 713
    // they don't already exist. We don't want the overhead of running
    // template_preprocess() twice, so we use the 'directory' variable to
    // determine if it has already run, which while not completely intuitive,
    // is reasonably safe, and allows us to save on the overhead of adding some
    // new variable to track that.
714 715
    if (!isset($variables['directory'])) {
      $default_template_variables = array();
716
      template_preprocess($default_template_variables, $hook, $info);
717 718
      $variables += $default_template_variables;
    }
719 720 721 722 723 724 725 726 727 728 729 730 731 732
    if (!isset($default_attributes)) {
      $default_attributes = new Attribute();
    }
    foreach (array('attributes', 'title_attributes', 'content_attributes') as $key) {
      if (isset($variables[$key]) && !($variables[$key] instanceof Attribute)) {
        if ($variables[$key]) {
          $variables[$key] = new Attribute($variables[$key]);
        }
        else {
          // Create empty attributes.
          $variables[$key] = clone $default_attributes;
        }
      }
    }
733

734 735 736 737
    // Render the output using the template file.
    $template_file = $info['template'] . $extension;
    if (isset($info['path'])) {
      $template_file = $info['path'] . '/' . $template_file;
738
    }
739 740 741 742 743 744 745 746 747 748
    // Add the theme suggestions to the variables array just before rendering
    // the template for backwards compatibility with template engines.
    $variables['theme_hook_suggestions'] = $suggestions;
    // For backwards compatibility, pass 'theme_hook_suggestion' on to the
    // template engine. This is only set when calling a direct suggestion like
    // '#theme' => 'menu_tree__shortcut_default' when the template exists in the
    // current theme.
    if (isset($theme_hook_suggestion)) {
      $variables['theme_hook_suggestion'] = $theme_hook_suggestion;
    }
749
    $output = $render_function($template_file, $variables);
Dries's avatar
 
Dries committed
750
  }
751

752 753
  // restore path_to_theme()
  $theme_path = $temp;
754
  return (string) $output;
755 756
}

Dries's avatar
 
Dries committed
757
/**
758 759 760 761 762 763 764 765
 * Returns the path to the current themed element.
 *
 * It can point to the active theme or the module handling a themed
 * implementation. For example, when invoked within the scope of a theming call
 * it will depend on where the theming function is handled. If implemented from
 * a module, it will point to the module. If implemented from the active theme,
 * it will point to the active theme. When called outside the scope of a
 * theming call, it will always point to the active theme.
Dries's avatar
 
Dries committed
766
 */
Dries's avatar
 
Dries committed
767
function path_to_theme() {
768
  global $theme_path;
Dries's avatar
 
Dries committed
769

770
  if (!isset($theme_path)) {
771
    drupal_theme_initialize();
772 773
  }

774
  return $theme_path;
775 776
}

777
/**
778
 * Allows themes and/or theme engines to discover overridden theme functions.
779 780 781 782 783 784
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $prefixes
 *   An array of prefixes to test, in reverse order of importance.
 *
785
 * @return $implementations
786 787 788
 *   The functions found, suitable for returning from hook_theme;
 */
function drupal_find_theme_functions($cache, $prefixes) {
789
  $implementations = array();
790 791 792 793
  $functions = get_defined_functions();

  foreach ($cache as $hook => $info) {
    foreach ($prefixes as $prefix) {
794 795 796 797 798 799
      // Find theme functions that implement possible "suggestion" variants of
      // registered theme hooks and add those as new registered theme hooks.
      // The 'pattern' key defines a common prefix that all suggestions must
      // start with. The default is the name of the hook followed by '__'. An
      // 'base hook' key is added to each entry made for a found suggestion,
      // so that common functionality can be implemented for all suggestions of
800
      // the same base hook. To keep things simple, deep hierarchy of
801 802 803 804
      // suggestions is not supported: each suggestion's 'base hook' key
      // refers to a base hook, not to another suggestion, and all suggestions
      // are found using the base hook's pattern, not a pattern from an
      // intermediary suggestion.
805
      $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
806
      if (!isset($info['base hook']) && !empty($pattern)) {
807
        $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
808 809
        if ($matches) {
          foreach ($matches as $match) {
810
            $new_hook = substr($match, strlen($prefix) + 1);
811
            $arg_name = isset($info['variables']) ? 'variables' : 'render element';
812
            $implementations[$new_hook] = array(
813
              'function' => $match,
814
              $arg_name => $info[$arg_name],
815
              'base hook' => $hook,
816 817 818 819
            );
          }
        }
      }
820 821 822
      // Find theme functions that implement registered theme hooks and include
      // that in what is returned so that the registry knows that the theme has
      // this implementation.
823
      if (function_exists($prefix . '_' . $hook)) {
824
        $implementations[$hook] = array(
825
          'function' => $prefix . '_' . $hook,
826 827 828 829 830
        );
      }
    }
  }

831
  return $implementations;
832 833 834
}

/**
835
 * Allows themes and/or theme engines to easily discover overridden templates.
836 837 838 839 840 841 842 843 844
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $extension
 *   The extension that these templates will have.
 * @param $path
 *   The path to search.
 */
function drupal_find_theme_templates($cache, $extension, $path) {
845
  $implementations = array();
846

847 848 849 850
  // Collect paths to all sub-themes grouped by base themes. These will be
  // used for filtering. This allows base themes to have sub-themes in its
  // folder hierarchy without affecting the base themes template discovery.
  $theme_paths = array();
851
  foreach (list_themes() as $theme_info) {
852 853 854 855 856 857 858 859 860
    if (!empty($theme_info->base_theme)) {
      $theme_paths[$theme_info->base_theme][$theme_info->name] = dirname($theme_info->filename);
    }
  }
  foreach ($theme_paths as $basetheme => $subthemes) {
    foreach ($subthemes as $subtheme => $subtheme_path) {
      if (isset($theme_paths[$subtheme])) {
        $theme_paths[$basetheme] = array_merge($theme_paths[$basetheme], $theme_paths[$subtheme]);
      }
861 862
    }
  }
863 864
  global $theme;
  $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
865

866
  // Escape the periods in the extension.
867
  $regex = '/' . str_replace('.', '\.', $extension) . '$/';
868
  // Get a listing of all template files in the path to search.
869
  $files = file_scan_directory($path, $regex, array('key' => 'filename'));
870 871 872 873

  // Find templates that implement registered theme hooks and include that in
  // what is returned so that the registry knows that the theme has this
  // implementation.
874
  foreach ($files as $template => $file) {
875
    // Ignore sub-theme templates for the current theme.
876
    if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
877 878
      continue;
    }
879 880
    // Remove the extension from the filename.
    $template = str_replace($extension, '', $template);
881 882 883 884
    // Transform - in filenames to _ to match function naming scheme
    // for the purposes of searching.
    $hook = strtr($template, '-', '_');
    if (isset($cache[$hook])) {
885
      $implementations[$hook] = array(
886
        'template' => $template,
887
        'path' => dirname($file->uri),
888 889
      );
    }
890 891 892 893

    // Match templates based on the 'template' filename.
    foreach ($cache as $hook => $info) {
      if (isset($info['template'])) {
894
        $template_candidates = array($info['template'], str_replace($info['theme path'] . '/templates/', '', $info['template']));
895 896 897 898 899 900 901 902
        if (in_array($template, $template_candidates)) {
          $implementations[$hook] = array(
            'template' => $template,
            'path' => dirname($file->uri),
          );
        }
      }
    }
903 904
  }

905
  // Find templates that implement possible "suggestion" variants of registered
906
  // theme hooks and add those as new registered theme hooks. See
907 908
  // drupal_find_theme_functions() for more information about suggestions and
  // the use of 'pattern' and 'base hook'.
909 910
  $patterns = array_keys($files);
  foreach ($cache as $hook => $info) {
911
    $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
912
    if (!isset($info['base hook']) && !empty($pattern)) {
913 914
      // Transform _ in pattern to - to match file naming scheme
      // for the purposes of searching.
915
      $pattern = strtr($pattern, '_', '-');
916

917
      $matches = preg_grep('/^' . $pattern . '/', $patterns);
918 919
      if ($matches) {
        foreach ($matches as $match) {