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

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

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

94
  drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
95
  $themes = list_themes();
Dries's avatar
 
Dries committed
96

97 98 99 100 101 102 103 104
  // Only select the user selected theme if it is available in the
  // list of themes that can be accessed.
  $theme = !empty($user->theme) && drupal_theme_access($user->theme) ? $user->theme : \Drupal::config('system.theme')->get('default');

  // Allow modules to override the theme. Validation has already been performed
  // inside menu_get_custom_theme(), so we do not need to check it again here.
  $custom_theme = menu_get_custom_theme();
  $theme = !empty($custom_theme) ? $custom_theme : $theme;
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

  // Themes can have alter functions, so reset the drupal_alter() cache.
  drupal_static_reset('drupal_alter');
120 121 122
}

/**
123 124 125
 * Initializes the theme system given already loaded information.
 *
 * This function is useful to initialize a theme when no database is present.
126 127 128 129
 *
 * @param $theme
 *   An object with the following information:
 *     filename
130
 *       The .info.yml file for this theme. The 'path' to
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
 *       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
 *    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.
 */
146
function _drupal_theme_initialize($theme, $base_theme = array()) {
147 148 149 150 151 152
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

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

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

  // 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;
        }
      }
    }
171 172 173 174 175 176 177 178 179 180 181 182
    $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;
      }
    }
183 184
  }

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

  // And now add the stylesheets properly
  foreach ($final_stylesheets as $media => $stylesheets) {
    foreach ($stylesheets as $stylesheet) {
216
      drupal_add_css($stylesheet, array('group' => CSS_AGGREGATE_THEME, 'every_page' => TRUE, 'media' => $media));
217 218 219 220 221 222 223 224 225 226 227
    }
  }

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

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

239 240
  // Add scripts used by this theme.
  foreach ($final_scripts as $script) {
241
    drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
242 243
  }

244 245 246 247 248
  $theme_engine = NULL;

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

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

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

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

/**
305 306 307 308
 * 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.
309
 */
310
function drupal_theme_rebuild() {
311
  \Drupal::service('theme.registry')->reset();
312 313
}

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

  if ($refresh) {
363
    $list = array();
364
    system_list_reset();
Dries's avatar
 
Dries committed
365 366
  }

367
  if (empty($list)) {
Dries's avatar
 
Dries committed
368
    $list = array();
369
    // Extract from the database only when it is available.
370
    // Also check that the site is not in the middle of an install or update.
371 372
    try {
      $themes = system_list('theme');
373
    }
374 375
    catch (Exception $e) {
      // If the database is not available, rebuild the theme data.
376
      $themes = _system_rebuild_theme_data();
377 378 379 380 381
    }

    foreach ($themes as $theme) {
      foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
        foreach ($stylesheets as $stylesheet => $path) {
382
          $theme->stylesheets[$media][$stylesheet] = $path;
383
        }
384 385
      }
      foreach ($theme->info['scripts'] as $script => $path) {
386
        $theme->scripts[$script] = $path;
Dries's avatar
 
Dries committed
387
      }
388 389
      if (isset($theme->info['engine'])) {
        $theme->engine = $theme->info['engine'];
Dries's avatar
 
Dries committed
390
      }
391 392 393
      if (isset($theme->info['base theme'])) {
        $theme->base_theme = $theme->info['base theme'];
      }
394 395 396 397 398
      // Status is normally retrieved from the database. Add zero values when
      // read from the installation directory to prevent notices.
      if (!isset($theme->status)) {
        $theme->status = 0;
      }
399
      $list[$theme->name] = $theme;
Dries's avatar
 
Dries committed
400 401 402 403 404 405
    }
  }

  return $list;
}

406
/**
407
 * Finds all the base themes for the specified theme.
408
 *
409 410
 * Themes can inherit templates and function implementations from earlier
 * themes.
411 412 413 414 415 416
 *
 * @param $themes
 *   An array of available themes.
 * @param $key
 *   The name of the theme whose base we are looking for.
 * @param $used_keys
417 418 419
 *   (optional) A recursion parameter preventing endless loops. Defaults to
 *   NULL.
 *
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
 * @return
 *   Returns an array of all of the theme's ancestors; the first element's value
 *   will be NULL if an error occurred.
 */
function drupal_find_base_themes($themes, $key, $used_keys = array()) {
  $base_key = $themes[$key]->info['base theme'];
  // Does the base theme exist?
  if (!isset($themes[$base_key])) {
    return array($base_key => NULL);
  }

  $current_base_theme = array($base_key => $themes[$base_key]->info['name']);

  // Is the base theme itself a child of another theme?
  if (isset($themes[$base_key]->info['base theme'])) {
    // Do we already know the base themes of this theme?
    if (isset($themes[$base_key]->base_themes)) {
      return $themes[$base_key]->base_themes + $current_base_theme;
    }
    // Prevent loops.
    if (!empty($used_keys[$base_key])) {
      return array($base_key => NULL);
    }
    $used_keys[$base_key] = TRUE;
    return drupal_find_base_themes($themes, $base_key, $used_keys) + $current_base_theme;
  }
  // If we get here, then this is our parent theme.
  return $current_base_theme;
}

Dries's avatar
 
Dries committed
450
/**
451 452
 * Generates themed output.
 *
453 454 455
 * All requests for themed output must go through this function (however,
 * calling the theme() function directly is strongly discouraged - see next
 * paragraph). It examines the request and routes it to the appropriate
456 457
 * @link themeable theme function or template @endlink, by checking the theme
 * registry.
458
 *
459 460 461 462 463
 * Avoid calling this function directly. It is preferable to replace direct
 * calls to the theme() function with calls to drupal_render() by passing a
 * render array with a #theme key to drupal_render(), which in turn calls
 * theme().
 *
464
 * @section sec_theme_hooks Theme Hooks
465 466 467 468 469 470 471
 * 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
472
 * Twig rendering engine and are named the same as the theme hook, with
473
 * underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
474
 * default template is 'taxonomy-term.html.twig'.
475
 *
476
 * @subsection sub_overriding_theme_hooks Overriding Theme Hooks
477 478 479 480 481 482 483 484
 * 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
485 486 487
 * 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).
488
 *
489
 * @subsection sub_preprocess_templates Preprocessing for Template Files
490 491 492 493 494 495 496 497
 * 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.
498 499
 * - template_preprocess_HOOK(&$variables): Should be implemented by the module
 *   that registers the theme hook, to set up default variables.
500 501 502
 * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
 *   implementing modules.
 * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
503 504
 *   all implementing modules, so that modules that didn't define the theme hook
 *   can alter the variables.
505
 * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
506
 *   set necessary variables for all theme hooks with template implementations.
507 508 509
 * - 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
510
 *   variables for all theme hooks with template implementations.
511 512 513
 * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
 *   variables specific to the particular theme hook.
 *
514
 * @subsection sub_preprocess_theme_funcs Preprocessing for Theme Functions
515
 * If the implementation is a function, only the theme-hook-specific preprocess
516 517 518 519
 * 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.
520
 *
521
 * @subsection sub_alternate_suggestions Suggesting Alternate Hooks
522 523 524 525 526 527 528 529 530 531
 * 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
 * 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).
 * The difference is whether the suggestions are determined by the code that
 * calls theme() or by altering the suggestions via the suggestion alter hooks.
532
 *
533
 * @param $hook
534 535
 *   The name of the theme hook to call. If the name contains a
 *   double-underscore ('__') and there isn't an implementation for the full
536 537 538 539
 *   name, the part before the '__' is checked. This allows a fallback to a
 *   more generic implementation. For example, if theme('links__node', ...) is
 *   called, but there is no implementation of that theme hook, then the
 *   'links' implementation is used. This process is iterative, so if
540 541 542 543 544 545 546
 *   theme('links__contextual__node', ...) is called, theme() checks for the
 *   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
547
 *   may also be an array, in which case the first theme hook that has an
548 549
 *   implementation is used. This allows for the code that calls theme() to
 *   explicitly specify the fallback order in a situation where using the '__'
550
 *   convention is not desired or is insufficient.
551 552
 * @param $variables
 *   An associative array of variables to merge with defaults from the theme
553 554 555 556
 *   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.
557
 *
558 559 560
 * @return string|false
 *   An HTML string representing the themed output or FALSE if the passed $hook
 *   is not implemented.
561
 *
562
 * @see drupal_render()
563
 * @see themeable
564 565
 * @see hook_theme()
 * @see template_preprocess()
Dries's avatar
 
Dries committed
566
 */
567
function theme($hook, $variables = array()) {
568
  static $default_attributes;
569 570
  // 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
571
  // request properly. See also \Drupal\Core\Theme\Registry::get().
572
  if (!\Drupal::moduleHandler()->isLoaded() && !defined('MAINTENANCE_MODE')) {
573 574 575
    throw new Exception(t('theme() may not be called until all modules are loaded.'));
  }

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

579 580
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
581 582
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
583
      if ($theme_registry->has($candidate)) {
584 585 586 587 588
        break;
      }
    }
    $hook = $candidate;
  }
589 590 591
  // Save the original theme hook, so it can be supplied to theme variable
  // preprocess callbacks.
  $original_hook = $hook;
592

593 594
  // If there's no implementation, check for more generic fallbacks. If there's
  // still no implementation, log an error and return an empty string.
595
  if (!$theme_registry->has($hook)) {
596 597 598 599
    // Iteratively strip everything after the last '__' delimiter, until an
    // implementation is found.
    while ($pos = strrpos($hook, '__')) {
      $hook = substr($hook, 0, $pos);
600
      if ($theme_registry->has($hook)) {
601 602 603
        break;
      }
    }
604
    if (!$theme_registry->has($hook)) {
605 606 607
      // Only log a message when not trying theme suggestions ($hook being an
      // array).
      if (!isset($candidate)) {
608
        watchdog('theme', 'Theme hook %hook not found.', array('%hook' => $hook), WATCHDOG_WARNING);
609
      }
610 611 612 613
      // There is no theme implementation for the hook passed. Return FALSE so
      // the function calling theme() can differentiate between a hook that
      // exists and renders an empty string and a hook that is not implemented.
      return FALSE;
614
    }
615 616
  }

617
  $info = $theme_registry->get($hook);
618 619 620
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
621
  $theme_path = $info['theme path'];
Dries's avatar
 
Dries committed
622

623
  // Include a file if the theme function or variable preprocessor is held
624
  // elsewhere.
625 626 627
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
628 629
    }
  }
630 631

  // If a renderable array is passed as $variables, then set $variables to
632
  // the arguments expected by the theme function.
633 634 635
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
636 637
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {
638
        if (isset($element["#$name"]) || array_key_exists("#$name", $element)) {
639 640
          $variables[$name] = $element["#$name"];
        }
641 642
      }
    }
643 644
    else {
      $variables[$info['render element']] = $element;
645 646
      // Give a hint to render engines to prevent infinite recursion.
      $variables[$info['render element']]['#render_children'] = TRUE;
647
    }
648
  }
649

650
  // Merge in argument defaults.
651 652 653 654 655
  if (!empty($info['variables'])) {
    $variables += $info['variables'];
  }
  elseif (!empty($info['render element'])) {
    $variables += array($info['render element'] => array());
656
  }
657 658 659 660
  // Supply original caller info.
  $variables += array(
    'theme_hook_original' => $original_hook,
  );
661

662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
  // 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));
  // If theme() was invoked with a direct theme suggestion like
  // '#theme' => 'node__article', add it to the suggestions array before
  // invoking suggestion alter hooks.
  if (isset($info['base hook'])) {
    $suggestions[] = $hook;
  }
  // Allow suggestions to be altered via hook_theme_suggestions_HOOK_alter().
  Drupal::moduleHandler()->alter('theme_suggestions_' . $base_theme_hook, $suggestions, $variables);

  // Check if each suggestion exists in the theme registry, and if so,
  // use it instead of the hook that theme() was called with. For example, a
  // function may call theme('node', ...), but a module can add
  // 'node__article' as a suggestion via hook_theme_suggestions_HOOK_alter(),
  // enabling a theme to have an alternate template file for article nodes.
  foreach (array_reverse($suggestions) as $suggestion) {
690 691
    if ($theme_registry->has($suggestion)) {
      $info = $theme_registry->get($suggestion);
692 693 694 695 696
      break;
    }
  }

  // Invoke the variable preprocessors, if any.
697 698
  if (isset($info['base hook'])) {
    $base_hook = $info['base hook'];
699
    $base_hook_info = $theme_registry->get($base_hook);
700
    // Include files required by the base hook, since its variable preprocessors
701 702 703 704 705 706
    // might reside there.
    if (!empty($base_hook_info['includes'])) {
      foreach ($base_hook_info['includes'] as $include_file) {
        include_once DRUPAL_ROOT . '/' . $include_file;
      }
    }
707
    // Replace the preprocess functions with those from the base hook.
708
    if (isset($base_hook_info['preprocess functions'])) {
709 710 711 712
      // 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'];
713 714
    }
  }
715 716 717 718
  if (isset($info['preprocess functions'])) {
    foreach ($info['preprocess functions'] as $preprocessor_function) {
      if (function_exists($preprocessor_function)) {
        $preprocessor_function($variables, $hook, $info);
719
      }
720 721
    }
  }
722

723
  // Generate the output using either a function or a template.
724
  $output = '';
725
  if (isset($info['function'])) {
726
    if (function_exists($info['function'])) {
727
      $output = $info['function']($variables);
Dries's avatar
 
Dries committed
728
    }
Dries's avatar
 
Dries committed
729
  }
730
  else {
731 732
    $render_function = 'twig_render_template';
    $extension = '.html.twig';
733

734
    // The theme engine may use a different extension and a different renderer.
735 736
    global $theme_engine;
    if (isset($theme_engine)) {
737
      if ($info['type'] != 'module') {
738 739
        if (function_exists($theme_engine . '_render_template')) {
          $render_function = $theme_engine . '_render_template';
740
        }
741
        $extension_function = $theme_engine . '_extension';
742 743 744 745 746 747
        if (function_exists($extension_function)) {
          $extension = $extension_function();
        }
      }
    }

748 749 750 751 752
    // 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
753 754 755 756 757
    // 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.
758 759
    if (!isset($variables['directory'])) {
      $default_template_variables = array();
760
      template_preprocess($default_template_variables, $hook, $info);
761 762
      $variables += $default_template_variables;
    }
763 764 765 766 767 768 769 770 771 772 773 774 775 776
    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;
        }
      }
    }
777

778 779 780 781
    // Render the output using the template file.
    $template_file = $info['template'] . $extension;
    if (isset($info['path'])) {
      $template_file = $info['path'] . '/' . $template_file;
782
    }
783 784 785 786 787 788 789 790 791 792
    // 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;
    }
793
    $output = $render_function($template_file, $variables);
Dries's avatar
 
Dries committed
794
  }
795

796 797
  // restore path_to_theme()
  $theme_path = $temp;
798
  return (string) $output;
799 800
}

Dries's avatar
 
Dries committed
801
/**
802 803 804 805 806 807 808 809
 * 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
810
 */
Dries's avatar
 
Dries committed
811
function path_to_theme() {
812
  global $theme_path;
Dries's avatar
 
Dries committed
813

814
  if (!isset($theme_path)) {
815
    drupal_theme_initialize();
816 817
  }

818
  return $theme_path;
819 820
}

821
/**
822
 * Allows themes and/or theme engines to discover overridden theme functions.
823 824 825 826 827 828
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $prefixes
 *   An array of prefixes to test, in reverse order of importance.
 *
829
 * @return $implementations
830 831 832
 *   The functions found, suitable for returning from hook_theme;
 */
function drupal_find_theme_functions($cache, $prefixes) {
833
  $implementations = array();
834 835 836 837
  $functions = get_defined_functions();

  foreach ($cache as $hook => $info) {
    foreach ($prefixes as $prefix) {
838 839 840 841 842 843
      // 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
844
      // the same base hook. To keep things simple, deep hierarchy of
845 846 847 848
      // 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.
849
      $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
850
      if (!isset($info['base hook']) && !empty($pattern)) {
851
        $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
852 853
        if ($matches) {
          foreach ($matches as $match) {
854
            $new_hook = substr($match, strlen($prefix) + 1);
855
            $arg_name = isset($info['variables']) ? 'variables' : 'render element';
856
            $implementations[$new_hook] = array(
857
              'function' => $match,
858
              $arg_name => $info[$arg_name],
859
              'base hook' => $hook,
860 861 862 863
            );
          }
        }
      }
864 865 866
      // 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.
867
      if (function_exists($prefix . '_' . $hook)) {
868
        $implementations[$hook] = array(
869
          'function' => $prefix . '_' . $hook,
870 871 872 873 874
        );
      }
    }
  }

875
  return $implementations;
876 877 878
}

/**
879
 * Allows themes and/or theme engines to easily discover overridden templates.
880 881 882 883 884 885 886 887 888
 *
 * @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) {
889
  $implementations = array();
890

891 892 893 894
  // 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();
895
  foreach (list_themes() as $theme_info) {
896 897 898 899 900 901 902 903 904
    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]);
      }
905 906
    }
  }
907 908
  global $theme;
  $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
909

910
  // Escape the periods in the extension.
911
  $regex = '/' . str_replace('.', '\.', $extension) . '$/';