theme.inc 99.5 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\ExtensionNameLengthException;
16
use Drupal\Core\Template\Attribute;
17
use Drupal\Core\Template\RenderWrapper;
18
use Drupal\Core\Theme\ThemeSettings;
19
use Drupal\Component\Utility\NestedArray;
20
use Drupal\Core\Render\Element;
21

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

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

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

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

44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59
/**
 * 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';

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

64 65 66
/**
 * Determines if a theme is available to use.
 *
67
 * @param $theme
68 69
 *   Either the name of a theme or a full theme object.
 *
70
 * @return
71 72
 *   Boolean TRUE if the theme is enabled or is the site administration theme;
 *   FALSE otherwise.
73
 *
74 75 76 77
 * @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().
78 79
 */
function drupal_theme_access($theme) {
80
  if (is_object($theme)) {
81
    $theme = $theme->name;
82
  }
83
  return \Drupal::service('access_check.theme')->checkAccess($theme);
84 85
}

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

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

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

99 100 101 102 103
  // @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
104 105 106 107

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

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

/**
119 120 121
 * Initializes the theme system given already loaded information.
 *
 * This function is useful to initialize a theme when no database is present.
122
 *
123 124 125 126 127 128 129 130 131 132 133 134 135
 * @param $theme
 *   An object with the following information:
 *     filename
 *       The .info.yml file for this theme. The 'path' to
 *       the theme will be in this file's directory. (Required)
 *     owner
 *       The path to the .theme file or the .engine file to load for
 *       the theme. (Required)
 *     stylesheet
 *       The primary stylesheet for the theme. (Optional)
 *     engine
 *       The name of theme engine to use. (Optional)
 * @param $base_theme
136 137 138 139 140 141
 *    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.
 */
142
function _drupal_theme_initialize($theme, $base_theme = array()) {
143 144 145 146 147 148
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

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

149 150 151 152
  // 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();
153 154 155 156
  // CSS file basenames to override, pointing to the final, overridden filepath.
  $theme->stylesheets_override = array();
  // CSS file basenames to remove.
  $theme->stylesheets_remove = array();
157 158 159 160 161 162 163 164 165 166

  // 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;
        }
      }
    }
167 168 169 170 171 172 173 174 175 176 177 178
    $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;
      }
    }
179 180
  }

181 182 183
  // Add stylesheets used by this theme.
  if (!empty($theme->stylesheets)) {
    foreach ($theme->stylesheets as $media => $stylesheets) {
184 185 186 187 188
      foreach ($stylesheets as $name => $stylesheet) {
        $final_stylesheets[$media][$name] = $stylesheet;
      }
    }
  }
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
  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]);
      }
    }
  }
208

209 210
  // And now add the stylesheets properly.
  $css = array();
211 212
  foreach ($final_stylesheets as $media => $stylesheets) {
    foreach ($stylesheets as $stylesheet) {
213 214 215 216 217
      $css['#attached']['css'][$stylesheet] = array(
        'group' => CSS_AGGREGATE_THEME,
        'every_page' => TRUE,
        'media' => $media
      );
218 219
    }
  }
220
  drupal_render($css);
221 222 223 224 225 226 227 228 229

  // 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;
230
      }
Dries's avatar
 
Dries committed
231 232
    }
  }
233

234 235
  // Add scripts used by this theme.
  if (!empty($theme->scripts)) {
236 237
    foreach ($theme->scripts as $name => $script) {
      $final_scripts[$name] = $script;
238 239 240
    }
  }

241
  // Add scripts used by this theme.
242
  $js = array();
243
  foreach ($final_scripts as $script) {
244 245 246 247 248
    $js['#attached']['js'][] = array(
      'data' => $script,
      'group' => JS_THEME,
      'every_page' => TRUE,
    );
249
  }
250
  drupal_render($js);
251

252 253 254 255 256
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
257
    include_once DRUPAL_ROOT . '/' . $theme->owner;
258 259

    $theme_engine = $theme->engine;
260
    if (function_exists($theme_engine . '_init')) {
261
      foreach ($base_theme as $base) {
262
        call_user_func($theme_engine . '_init', $base);
263
      }
264
      call_user_func($theme_engine . '_init', $theme);
265 266 267 268 269 270 271
    }
  }
  else {
    // include non-engine theme files
    foreach ($base_theme as $base) {
      // Include the theme file or the engine.
      if (!empty($base->owner)) {
272
        include_once DRUPAL_ROOT . '/' . $base->owner;
273 274 275 276
      }
    }
    // and our theme gets one too.
    if (!empty($theme->owner)) {
277
      include_once DRUPAL_ROOT . '/' . $theme->owner;
Dries's avatar
 
Dries committed
278 279
    }
  }
280 281

  // Always include Twig as the default theme engine.
282
  include_once DRUPAL_ROOT . '/core/themes/engines/twig/twig.engine';
Dries's avatar
 
Dries committed
283 284
}

285
/**
286
 * Gets the theme registry.
287
 *
288
 * @param bool $complete
289
 *   Optional boolean to indicate whether to return the complete theme registry
290 291 292 293 294 295 296
 *   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.
297
 *
298
 * @return
299 300
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
301
 */
302
function theme_get_registry($complete = TRUE) {
303
  $theme_registry = \Drupal::service('theme.registry');
304
  if ($complete) {
305
    return $theme_registry->get();
306 307
  }
  else {
308
    return $theme_registry->getRuntime();
309 310 311 312
  }
}

/**
313 314 315 316
 * 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.
317
 */
318
function drupal_theme_rebuild() {
319
  \Drupal::service('theme.registry')->reset();
320 321
}

Dries's avatar
 
Dries committed
322
/**
323
 * Returns a list of all currently available themes.
Dries's avatar
 
Dries committed
324
 *
325 326
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
327
 *
Dries's avatar
 
Dries committed
328
 * @param $refresh
329
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
330
 *
331
 * @return
332
 *   An associative array of the currently available themes. The keys are the
333
 *   themes' machine names and the values are objects having the following
334
 *   properties:
335
 *   - filename: The filepath and name of the .info.yml file.
336 337
 *   - name: The machine name of the theme.
 *   - status: 1 for enabled, 0 for disabled themes.
338
 *   - info: The contents of the .info.yml file.
339 340 341 342
 *   - 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
343
 *     .info.yml file.
344 345
 *   - 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
346
 *     the .info.yml file.
347 348 349
 *   - 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
350
 *     defined in the .info.yml file. Otherwise, the element is not set.
351 352 353 354 355 356 357 358 359 360 361 362 363 364
 *   - 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
365
 *     declare this theme as their base theme.
366
 *
367 368 369 370
 * @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().
371
 */
372
function list_themes($refresh = FALSE) {
373 374
  /** @var \Drupal\Core\Extension\ThemeHandler $theme_handler */
  $theme_handler = \Drupal::service('theme_handler');
Dries's avatar
 
Dries committed
375 376

  if ($refresh) {
377
    $theme_handler->reset();
378
    system_list_reset();
Dries's avatar
 
Dries committed
379 380
  }

381
  return $theme_handler->listInfo();
Dries's avatar
 
Dries committed
382 383
}

384
/**
385
 * Finds all the base themes for the specified theme.
386
 *
387 388
 * Themes can inherit templates and function implementations from earlier
 * themes.
389 390 391 392 393
 *
 * @param $themes
 *   An array of available themes.
 * @param $key
 *   The name of the theme whose base we are looking for.
394
 *
395 396 397
 * @return
 *   Returns an array of all of the theme's ancestors; the first element's value
 *   will be NULL if an error occurred.
398
 *
399 400 401 402
 * @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().
403
 */
404 405
function drupal_find_base_themes($themes, $key) {
  return \Drupal::service('theme_handler')->getBaseThemes($themes, $key);
406 407
}

Dries's avatar
 
Dries committed
408
/**
409 410
 * Generates themed output.
 *
411
 * All requests for themed output must go through this function (however,
412 413
 * calling the _theme() function directly is very strongly discouraged - see
 * next paragraph). It examines the request and routes it to the appropriate
414 415
 * @link themeable theme function or template @endlink, by checking the theme
 * registry.
416
 *
417
 * Avoid calling this function directly. It is preferable to replace direct
418
 * calls to the _theme() function with calls to drupal_render() by passing a
419
 * render array with a #theme key to drupal_render(), which in turn calls
420
 * _theme().
421
 *
422
 * @section sec_theme_hooks Theme Hooks
423 424 425 426 427 428 429
 * 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
430
 * Twig rendering engine and are named the same as the theme hook, with
431
 * underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
432
 * default template is 'taxonomy-term.html.twig'.
433
 *
434
 * @subsection sub_overriding_theme_hooks Overriding Theme Hooks
435 436 437 438 439 440 441 442
 * 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
443 444 445
 * 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).
446
 *
447
 * @subsection sub_preprocess_templates Preprocessing for Template Files
448 449 450 451 452 453 454 455
 * 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.
456 457
 * - template_preprocess_HOOK(&$variables): Should be implemented by the module
 *   that registers the theme hook, to set up default variables.
458 459 460
 * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
 *   implementing modules.
 * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
461 462
 *   all implementing modules, so that modules that didn't define the theme hook
 *   can alter the variables.
463
 * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
464
 *   set necessary variables for all theme hooks with template implementations.
465 466 467
 * - 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
468
 *   variables for all theme hooks with template implementations.
469 470 471
 * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
 *   variables specific to the particular theme hook.
 *
472
 * @subsection sub_preprocess_theme_funcs Preprocessing for Theme Functions
473
 * If the implementation is a function, only the theme-hook-specific preprocess
474 475 476 477
 * 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.
478
 *
479
 * @subsection sub_alternate_suggestions Suggesting Alternate Hooks
480 481 482 483
 * 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
484 485 486 487
 * 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).
488
 * The difference is whether the suggestions are determined by the code that
489
 * calls _theme() or by altering the suggestions via the suggestion alter hooks.
490
 *
491
 * @param $hook
492 493
 *   The name of the theme hook to call. If the name contains a
 *   double-underscore ('__') and there isn't an implementation for the full
494
 *   name, the part before the '__' is checked. This allows a fallback to a
495
 *   more generic implementation. For example, if _theme('links__node', ...) is
496 497
 *   called, but there is no implementation of that theme hook, then the
 *   'links' implementation is used. This process is iterative, so if
498
 *   _theme('links__contextual__node', ...) is called, _theme() checks for the
499 500 501 502 503 504
 *   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
505
 *   may also be an array, in which case the first theme hook that has an
506
 *   implementation is used. This allows for the code that calls _theme() to
507
 *   explicitly specify the fallback order in a situation where using the '__'
508
 *   convention is not desired or is insufficient.
509 510
 * @param $variables
 *   An associative array of variables to merge with defaults from the theme
511 512 513 514
 *   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.
515
 *
516 517 518
 * @return string|false
 *   An HTML string representing the themed output or FALSE if the passed $hook
 *   is not implemented.
519
 *
520
 * @see drupal_render()
521
 * @see themeable
522 523
 * @see hook_theme()
 * @see template_preprocess()
Dries's avatar
 
Dries committed
524
 */
525
function _theme($hook, $variables = array()) {
526
  static $default_attributes;
527 528
  // 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
529
  // request properly. See also \Drupal\Core\Theme\Registry::get().
530
  if (!\Drupal::moduleHandler()->isLoaded() && !defined('MAINTENANCE_MODE')) {
531
    throw new Exception(t('_theme() may not be called until all modules are loaded.'));
532 533
  }

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

537 538
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
539 540
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
541
      if ($theme_registry->has($candidate)) {
542 543 544 545 546
        break;
      }
    }
    $hook = $candidate;
  }
547 548 549
  // Save the original theme hook, so it can be supplied to theme variable
  // preprocess callbacks.
  $original_hook = $hook;
550

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

575
  $info = $theme_registry->get($hook);
576 577 578
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
579
  $theme_path = $info['theme path'];
Dries's avatar
 
Dries committed
580

581
  // Include a file if the theme function or variable preprocessor is held
582
  // elsewhere.
583 584 585
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
586 587
    }
  }
588 589

  // If a renderable array is passed as $variables, then set $variables to
590
  // the arguments expected by the theme function.
591 592 593
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
594 595
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {
596
        if (isset($element["#$name"]) || array_key_exists("#$name", $element)) {
597 598
          $variables[$name] = $element["#$name"];
        }
599 600
      }
    }
601 602
    else {
      $variables[$info['render element']] = $element;
603 604
      // Give a hint to render engines to prevent infinite recursion.
      $variables[$info['render element']]['#render_children'] = TRUE;
605
    }
606
  }
607

608
  // Merge in argument defaults.
609 610 611 612 613
  if (!empty($info['variables'])) {
    $variables += $info['variables'];
  }
  elseif (!empty($info['render element'])) {
    $variables += array($info['render element'] => array());
614
  }
615 616 617 618
  // Supply original caller info.
  $variables += array(
    'theme_hook_original' => $original_hook,
  );
619

620 621 622 623 624 625 626 627 628 629 630 631 632
  // 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));
633
  // If _theme() was invoked with a direct theme suggestion like
634 635 636 637 638
  // '#theme' => 'node__article', add it to the suggestions array before
  // invoking suggestion alter hooks.
  if (isset($info['base hook'])) {
    $suggestions[] = $hook;
  }
639 640 641 642 643 644 645 646

  // 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);
647 648

  // Check if each suggestion exists in the theme registry, and if so,
649 650
  // use it instead of the hook that _theme() was called with. For example, a
  // function may call _theme('node', ...), but a module can add
651 652 653
  // '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) {
654 655
    if ($theme_registry->has($suggestion)) {
      $info = $theme_registry->get($suggestion);
656 657 658 659 660
      break;
    }
  }

  // Invoke the variable preprocessors, if any.
661 662
  if (isset($info['base hook'])) {
    $base_hook = $info['base hook'];
663
    $base_hook_info = $theme_registry->get($base_hook);
664
    // Include files required by the base hook, since its variable preprocessors
665 666 667 668 669 670
    // might reside there.
    if (!empty($base_hook_info['includes'])) {
      foreach ($base_hook_info['includes'] as $include_file) {
        include_once DRUPAL_ROOT . '/' . $include_file;
      }
    }
671
    // Replace the preprocess functions with those from the base hook.
672
    if (isset($base_hook_info['preprocess functions'])) {
673 674 675 676
      // 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'];
677 678
    }
  }
679 680 681 682
  if (isset($info['preprocess functions'])) {
    foreach ($info['preprocess functions'] as $preprocessor_function) {
      if (function_exists($preprocessor_function)) {
        $preprocessor_function($variables, $hook, $info);
683
      }
684 685
    }
  }
686

687
  // Generate the output using either a function or a template.
688
  $output = '';
689
  if (isset($info['function'])) {
690
    if (function_exists($info['function'])) {
691
      $output = $info['function']($variables);
Dries's avatar
 
Dries committed
692
    }
Dries's avatar
 
Dries committed
693
  }
694
  else {
695 696
    $render_function = 'twig_render_template';
    $extension = '.html.twig';
697

698
    // The theme engine may use a different extension and a different renderer.
699 700
    global $theme_engine;
    if (isset($theme_engine)) {
701
      if ($info['type'] != 'module') {
702 703
        if (function_exists($theme_engine . '_render_template')) {
          $render_function = $theme_engine . '_render_template';
704
        }
705
        $extension_function = $theme_engine . '_extension';
706 707 708 709 710 711
        if (function_exists($extension_function)) {
          $extension = $extension_function();
        }
      }
    }

712 713 714 715 716
    // 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
717 718 719 720 721
    // 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.
722 723
    if (!isset($variables['directory'])) {
      $default_template_variables = array();
724
      template_preprocess($default_template_variables, $hook, $info);
725 726
      $variables += $default_template_variables;
    }
727 728 729 730 731 732 733 734 735 736 737 738 739 740
    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;
        }
      }
    }
741

742 743 744 745
    // Render the output using the template file.
    $template_file = $info['template'] . $extension;
    if (isset($info['path'])) {
      $template_file = $info['path'] . '/' . $template_file;
746
    }
747 748 749 750 751 752 753 754 755 756
    // 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;
    }
757
    $output = $render_function($template_file, $variables);
Dries's avatar
 
Dries committed
758
  }
759

760 761
  // restore path_to_theme()
  $theme_path = $temp;
762
  return (string) $output;
763 764
}

Dries's avatar
 
Dries committed
765
/**
766 767 768 769 770 771 772 773
 * 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
774
 */
Dries's avatar
 
Dries committed
775
function path_to_theme() {
776
  global $theme_path;
Dries's avatar
 
Dries committed
777

778
  if (!isset($theme_path)) {
779
    drupal_theme_initialize();
780 781
  }

782
  return $theme_path;
783 784
}

785
/**
786
 * Allows themes and/or theme engines to discover overridden theme functions.
787 788 789 790 791 792
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $prefixes
 *   An array of prefixes to test, in reverse order of importance.
 *
793
 * @return $implementations
794 795 796
 *   The functions found, suitable for returning from hook_theme;
 */
function drupal_find_theme_functions($cache, $prefixes) {
797
  $implementations = array();
798 799 800 801
  $functions = get_defined_functions();

  foreach ($cache as $hook => $info) {
    foreach ($prefixes as $prefix) {
802 803 804 805 806 807
      // 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
808
      // the same base hook. To keep things simple, deep hierarchy of
809 810 811 812
      // 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.
813
      $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
814
      if (!isset($info['base hook']) && !empty($pattern)) {
815
        $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
816 817
        if ($matches) {
          foreach ($matches as $match) {
818
            $new_hook = substr($match, strlen($prefix) + 1);
819
            $arg_name = isset($info['variables']) ? 'variables' : 'render element';
820
            $implementations[$new_hook] = array(
821
              'function' => $match,
822
              $arg_name => $info[$arg_name],
823
              'base hook' => $hook,
824 825 826 827
            );
          }
        }
      }
828 829 830
      // 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.
831
      if (function_exists($prefix . '_' . $hook)) {
832
        $implementations[$hook] = array(
833
          'function' => $prefix . '_' . $hook,
834 835 836 837 838
        );
      }
    }
  }

839
  return $implementations;
840 841 842
}

/**
843
 * Allows themes and/or theme engines to easily discover overridden templates.
844 845 846 847 848 849 850 851 852
 *
 * @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) {
853
  $implementations = array();
854

855 856 857 858
  // 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();
859
  foreach (list_themes() as $theme_info) {
860 861 862 863 864 865 866 867 868
    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]);
      }