theme.inc 115 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\Core\Cache\CacheBackendInterface;
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\Utility\ThemeRegistry;
19
use Drupal\Core\Theme\ThemeSettings;
20
use Drupal\Component\Utility\NestedArray;
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);
Dries's avatar
 
Dries committed
95 96
  $themes = list_themes();

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

101 102
  // 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.
103
  $custom_theme = menu_get_custom_theme();
104
  $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
 *       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.
145 146
 * @param $registry_callback
 *   The callback to invoke to set the theme registry.
147
 */
148
function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callback = '_theme_load_registry') {
149 150 151 152 153 154
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

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

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

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

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

  // And now add the stylesheets properly
  foreach ($final_stylesheets as $media => $stylesheets) {
    foreach ($stylesheets as $stylesheet) {
218
      drupal_add_css($stylesheet, array('group' => CSS_AGGREGATE_THEME, 'every_page' => TRUE, 'media' => $media));
219 220 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 242
  // Add scripts used by this theme.
  foreach ($final_scripts as $script) {
243
    drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
244 245
  }

246 247 248 249 250
  $theme_engine = NULL;

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

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

  // Always include Twig as the default theme engine.
276
  include_once DRUPAL_ROOT . '/core/themes/engines/twig/twig.engine';
277

278 279
  if (isset($registry_callback)) {
    _theme_registry_callback($registry_callback, array($theme, $base_theme, $theme_engine));
280
  }
Dries's avatar
 
Dries committed
281 282
}

283
/**
284
 * Gets the theme registry.
285
 *
286
 * @param bool $complete
287
 *   Optional boolean to indicate whether to return the complete theme registry
288 289 290 291 292 293 294
 *   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.
295
 *
296
 * @return
297 298
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
299
 */
300
function theme_get_registry($complete = TRUE) {
301 302 303 304 305 306 307 308 309 310 311 312 313 314
  // Use the advanced drupal_static() pattern, since this is called very often.
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['registry'] = &drupal_static('theme_get_registry');
  }
  $theme_registry = &$drupal_static_fast['registry'];

  // Initialize the theme, if this is called early in the bootstrap, or after
  // static variables have been reset.
  if (!is_array($theme_registry)) {
    drupal_theme_initialize();
    $theme_registry = array();
  }

315
  $key = (int) $complete;
316

317
  if (!isset($theme_registry[$key])) {
318
    list($callback, $arguments) = _theme_registry_callback();
319 320 321 322
    if (!$complete) {
      $arguments[] = FALSE;
    }
    $theme_registry[$key] = call_user_func_array($callback, $arguments);
323 324
  }

325
  return $theme_registry[$key];
326 327 328
}

/**
329
 * Sets the callback that will be used by theme_get_registry().
330
 *
331 332 333 334
 * @param $callback
 *   The name of the callback function.
 * @param $arguments
 *   The arguments to pass to the function.
335
 */
336 337 338 339
function _theme_registry_callback($callback = NULL, array $arguments = array()) {
  static $stored;
  if (isset($callback)) {
    $stored = array($callback, $arguments);
340
  }
341
  return $stored;
342 343 344
}

/**
345
 * Gets the theme_registry cache; if it doesn't exist, builds it.
346 347
 *
 * @param $theme
348
 *   The loaded $theme object as returned by list_themes().
349 350 351
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
352
 * @param $theme_engine
353
 *   The name of the theme engine.
354 355
 * @param $complete
 *   Whether to load the complete theme registry or an instance of the
356
 *   Drupal\Core\Utility\ThemeRegistry class.
357 358
 *
 * @return
359 360
 *   The theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
361
 */
362 363 364 365 366 367 368 369 370 371 372 373
function _theme_load_registry($theme, $base_theme = NULL, $theme_engine = NULL, $complete = TRUE) {
  if ($complete) {
    // Check the theme registry cache; if it exists, use it.
    $cached = cache()->get("theme_registry:$theme->name");
    if (isset($cached->data)) {
      $registry = $cached->data;
    }
    else {
      // If not, build one and cache it.
      $registry = _theme_build_registry($theme, $base_theme, $theme_engine);
      // Only persist this registry if all modules are loaded. This assures a
      // complete set of theme hooks.
374
      if (\Drupal::moduleHandler()->isLoaded()) {
375 376 377 378
        _theme_save_registry($theme, $registry);
      }
    }
    return $registry;
379 380
  }
  else {
381
    return new ThemeRegistry('theme_registry:runtime:' . $theme->name, 'cache', array('theme_registry' => TRUE), \Drupal::moduleHandler()->isLoaded());
382 383 384 385
  }
}

/**
386
 * Writes the theme_registry cache into the database.
387 388
 */
function _theme_save_registry($theme, $registry) {
389
  cache()->set("theme_registry:$theme->name", $registry, CacheBackendInterface::CACHE_PERMANENT, array('theme_registry' => TRUE));
390 391 392
}

/**
393 394 395 396
 * 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.
397
 */
398
function drupal_theme_rebuild() {
399
  drupal_static_reset('theme_get_registry');
400
  cache()->invalidateTags(array('theme_registry' => TRUE));
401 402 403
}

/**
404
 * Process a single implementation of hook_theme().
405
 *
406 407 408 409
 * @param $cache
 *   The theme registry that will eventually be cached; It is an associative
 *   array keyed by theme hooks, whose values are associative arrays describing
 *   the hook:
410 411
 *   - 'type': The passed-in $type.
 *   - 'theme path': The passed-in $path.
412
 *   - 'function': The name of the function generating output for this theme
413 414 415 416 417
 *     hook. Either defined explicitly in hook_theme() or, if neither
 *     'function' nor 'template' is defined, then the default theme function
 *     name is used. The default theme function name is the theme hook prefixed
 *     by either 'theme_' for modules or '$name_' for everything else. If
 *     'function' is defined, 'template' is not used.
418 419
 *   - 'template': The filename of the template generating output for this
 *     theme hook. The template is in the directory defined by the 'path' key of
420
 *     hook_theme() or defaults to "$path/templates".
421
 *   - 'variables': The variables for this theme hook as defined in
422 423
 *     hook_theme(). If there is more than one implementation and 'variables'
 *     is not specified in a later one, then the previous definition is kept.
424 425 426 427
 *   - 'render element': The renderable element for this theme hook as defined
 *     in hook_theme(). If there is more than one implementation and
 *     'render element' is not specified in a later one, then the previous
 *     definition is kept.
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
 *   - 'preprocess functions': See theme() for detailed documentation.
 * @param $name
 *   The name of the module, theme engine, base theme engine, theme or base
 *   theme implementing hook_theme().
 * @param $type
 *   One of 'module', 'theme_engine', 'base_theme_engine', 'theme', or
 *   'base_theme'. Unlike regular hooks that can only be implemented by modules,
 *   each of these can implement hook_theme(). _theme_process_registry() is
 *   called in aforementioned order and new entries override older ones. For
 *   example, if a theme hook is both defined by a module and a theme, then the
 *   definition in the theme will be used.
 * @param $theme
 *   The loaded $theme object as returned from list_themes().
 * @param $path
 *   The directory where $name is. For example, modules/system or
443
 *   themes/bartik.
444
 *
445 446 447
 * @see theme()
 * @see hook_theme()
 * @see list_themes()
448
 */
449
function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
450
  $result = array();
451

452 453 454 455 456 457 458
  $hook_defaults = array(
    'variables' => TRUE,
    'render element' => TRUE,
    'pattern' => TRUE,
    'base hook' => TRUE,
  );

459
  $module_list = array_keys(\Drupal::moduleHandler()->getModuleList());
460

461
  // Invoke the hook_theme() implementation, preprocess what is returned, and
462 463
  // merge it into $cache.
  $function = $name . '_theme';
464
  if (function_exists($function)) {
465
    $result = $function($cache, $type, $theme, $path);
466
    foreach ($result as $hook => $info) {
467 468 469 470 471 472 473
      // When a theme or engine overrides a module's theme function
      // $result[$hook] will only contain key/value pairs for information being
      // overridden.  Pull the rest of the information from what was defined by
      // an earlier hook.

      // Fill in the type and path of the module, theme, or engine that
      // implements this theme function.
474
      $result[$hook]['type'] = $type;
475
      $result[$hook]['theme path'] = $path;
476 477

      // If function and file are omitted, default to standard naming
478
      // conventions.
479
      if (!isset($info['template']) && !isset($info['function'])) {
480
        $result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
481
      }
482

483 484
      if (isset($cache[$hook]['includes'])) {
        $result[$hook]['includes'] = $cache[$hook]['includes'];
485
      }
486 487 488 489 490

      // If the theme implementation defines a file, then also use the path
      // that it defined. Otherwise use the default path. This allows
      // system.module to declare theme functions on behalf of core .include
      // files.
491 492 493 494 495
      if (isset($info['file'])) {
        $include_file = isset($info['path']) ? $info['path'] : $path;
        $include_file .= '/' . $info['file'];
        include_once DRUPAL_ROOT . '/' . $include_file;
        $result[$hook]['includes'][] = $include_file;
496
      }
497

498 499 500 501
      // If the default keys are not set, use the default values registered
      // by the module.
      if (isset($cache[$hook])) {
        $result[$hook] += array_intersect_key($cache[$hook], $hook_defaults);
502
      }
503 504 505 506 507

      // The following apply only to theming hooks implemented as templates.
      if (isset($info['template'])) {
        // Prepend the current theming path when none is set.
        if (!isset($info['path'])) {
508
          $result[$hook]['template'] = $path . '/templates/' . $info['template'];
509
        }
510
      }
511

512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
      // Preprocess variables for all theming hooks, whether the hook is
      // implemented as a template or as a function. Ensure they are arrays.
      if (!isset($info['preprocess functions']) || !is_array($info['preprocess functions'])) {
        $info['preprocess functions'] = array();
        $prefixes = array();
        if ($type == 'module') {
          // Default variable preprocessor prefix.
          $prefixes[] = 'template';
          // Add all modules so they can intervene with their own variable
          // preprocessors. This allows them to provide variable preprocessors
          // even if they are not the owner of the current hook.
          $prefixes = array_merge($prefixes, $module_list);
        }
        elseif ($type == 'theme_engine' || $type == 'base_theme_engine') {
          // Theme engines get an extra set that come before the normally
          // named variable preprocessors.
          $prefixes[] = $name . '_engine';
          // The theme engine registers on behalf of the theme using the
          // theme's name.
          $prefixes[] = $theme;
532
        }
533 534 535 536
        else {
          // This applies when the theme manually registers their own variable
          // preprocessors.
          $prefixes[] = $name;
537
        }
538 539 540 541 542 543 544 545 546
        foreach ($prefixes as $prefix) {
          // Only use non-hook-specific variable preprocessors for theming
          // hooks implemented as templates. See theme().
          if (isset($info['template']) && function_exists($prefix . '_preprocess')) {
            $info['preprocess functions'][] = $prefix . '_preprocess';
          }
          if (function_exists($prefix . '_preprocess_' . $hook)) {
            $info['preprocess functions'][] = $prefix . '_preprocess_' . $hook;
          }
547
        }
548
      }
549 550 551 552 553 554 555 556 557 558 559
      // Check for the override flag and prevent the cached variable
      // preprocessors from being used. This allows themes or theme engines
      // to remove variable preprocessors set earlier in the registry build.
      if (!empty($info['override preprocess functions'])) {
        // Flag not needed inside the registry.
        unset($result[$hook]['override preprocess functions']);
      }
      elseif (isset($cache[$hook]['preprocess functions']) && is_array($cache[$hook]['preprocess functions'])) {
        $info['preprocess functions'] = array_merge($cache[$hook]['preprocess functions'], $info['preprocess functions']);
      }
      $result[$hook]['preprocess functions'] = $info['preprocess functions'];
560 561
    }

562
    // Merge the newly created theme hooks into the existing cache.
563
    $cache = $result + $cache;
564
  }
565

566
  // Let themes have variable preprocessors even if they didn't register a
567
  // template.
568 569
  if ($type == 'theme' || $type == 'base_theme') {
    foreach ($cache as $hook => $info) {
570 571
      // Check only if not registered by the theme or engine.
      if (empty($result[$hook])) {
572 573 574 575 576 577 578 579 580 581 582
        if (!isset($info['preprocess functions'])) {
          $cache[$hook]['preprocess functions'] = array();
        }
        // Only use non-hook-specific variable preprocessors for theme hooks
        // implemented as templates. See theme().
        if (isset($info['template']) && function_exists($name . '_preprocess')) {
          $cache[$hook]['preprocess functions'][] = $name . '_preprocess';
        }
        if (function_exists($name . '_preprocess_' . $hook)) {
          $cache[$hook]['preprocess functions'][] = $name . '_preprocess_' . $hook;
          $cache[$hook]['theme path'] = $path;
583
        }
584 585
        // Ensure uniqueness.
        $cache[$hook]['preprocess functions'] = array_unique($cache[$hook]['preprocess functions']);
586 587 588
      }
    }
  }
589 590 591
}

/**
592
 * Builds the theme registry cache.
593 594
 *
 * @param $theme
595
 *   The loaded $theme object as returned by list_themes().
596 597 598
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
599
 * @param $theme_engine
600
 *   The name of the theme engine.
601
 */
602
function _theme_build_registry($theme, $base_theme, $theme_engine) {
603
  $cache = array();
604
  // First, preprocess the theme hooks advertised by modules. This will
605 606 607
  // serve as the basic registry. Since the list of enabled modules is the same
  // regardless of the theme used, this is cached in its own entry to save
  // building it for every theme.
608
  if ($cached = cache()->get('theme_registry:build:modules')) {
609 610 611
    $cache = $cached->data;
  }
  else {
612
    foreach (\Drupal::moduleHandler()->getImplementations('theme') as $module) {
613 614 615
      _theme_process_registry($cache, $module, 'module', $module, drupal_get_path('module', $module));
    }
    // Only cache this registry if all modules are loaded.
616
    if (\Drupal::moduleHandler()->isLoaded()) {
617
      cache()->set("theme_registry:build:modules", $cache, CacheBackendInterface::CACHE_PERMANENT, array('theme_registry' => TRUE));
618
    }
619 620 621 622
  }

  // Process each base theme.
  foreach ($base_theme as $base) {
623
    // If the base theme uses a theme engine, process its hooks.
624 625 626 627 628
    $base_path = dirname($base->filename);
    if ($theme_engine) {
      _theme_process_registry($cache, $theme_engine, 'base_theme_engine', $base->name, $base_path);
    }
    _theme_process_registry($cache, $base->name, 'base_theme', $base->name, $base_path);
629 630
  }

631
  // And then the same thing, but for the theme.
632
  if ($theme_engine) {
633
    _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
634 635
  }

636 637
  // Finally, hooks provided by the theme itself.
  _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
638

639
  // Let modules alter the registry.
640
  drupal_alter('theme_registry', $cache);
641 642 643

  // Optimize the registry to not have empty arrays for functions.
  foreach ($cache as $hook => $info) {
644 645
    if (empty($info['preprocess functions'])) {
      unset($cache[$hook]['preprocess functions']);
646 647
    }
  }
648 649 650
  return $cache;
}

Dries's avatar
 
Dries committed
651
/**
652
 * Returns a list of all currently available themes.
Dries's avatar
 
Dries committed
653
 *
654 655
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
656
 *
Dries's avatar
 
Dries committed
657
 * @param $refresh
658
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
659
 *
660
 * @return
661
 *   An associative array of the currently available themes. The keys are the
662
 *   themes' machine names and the values are objects having the following
663
 *   properties:
664
 *   - filename: The filepath and name of the .info.yml file.
665 666
 *   - name: The machine name of the theme.
 *   - status: 1 for enabled, 0 for disabled themes.
667
 *   - info: The contents of the .info.yml file.
668 669 670 671
 *   - 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
672
 *     .info.yml file.
673 674
 *   - 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
675
 *     the .info.yml file.
676 677 678
 *   - 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
679
 *     defined in the .info.yml file. Otherwise, the element is not set.
680 681 682 683 684 685 686 687 688 689 690 691 692 693
 *   - 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
694
 *     declare this theme as their base theme.
695
 */
696
function list_themes($refresh = FALSE) {
697
  $list = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
698 699

  if ($refresh) {
700
    $list = array();
701
    system_list_reset();
Dries's avatar
 
Dries committed
702 703
  }

704
  if (empty($list)) {
Dries's avatar
 
Dries committed
705
    $list = array();
706
    // Extract from the database only when it is available.
707
    // Also check that the site is not in the middle of an install or update.
708 709
    if (!defined('MAINTENANCE_MODE')) {
      try {
710
        $themes = system_list('theme');
711
      }
712 713 714 715
      catch (Exception $e) {
        // If the database is not available, rebuild the theme data.
        $themes = _system_rebuild_theme_data();
      }
716 717
    }
    else {
718
      // Scan the installation when the database should not be read.
719
      $themes = _system_rebuild_theme_data();
720 721 722 723 724
    }

    foreach ($themes as $theme) {
      foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
        foreach ($stylesheets as $stylesheet => $path) {
725
          $theme->stylesheets[$media][$stylesheet] = $path;
726
        }
727 728
      }
      foreach ($theme->info['scripts'] as $script => $path) {
729
        $theme->scripts[$script] = $path;
Dries's avatar
 
Dries committed
730
      }
731 732
      if (isset($theme->info['engine'])) {
        $theme->engine = $theme->info['engine'];
Dries's avatar
 
Dries committed
733
      }
734 735 736
      if (isset($theme->info['base theme'])) {
        $theme->base_theme = $theme->info['base theme'];
      }
737 738 739 740 741
      // 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;
      }
742
      $list[$theme->name] = $theme;
Dries's avatar
 
Dries committed
743 744 745 746 747 748
    }
  }

  return $list;
}

749
/**
750
 * Finds all the base themes for the specified theme.
751
 *
752 753
 * Themes can inherit templates and function implementations from earlier
 * themes.
754 755 756 757 758 759
 *
 * @param $themes
 *   An array of available themes.
 * @param $key
 *   The name of the theme whose base we are looking for.
 * @param $used_keys
760 761 762
 *   (optional) A recursion parameter preventing endless loops. Defaults to
 *   NULL.
 *
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792
 * @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
793
/**
794 795
 * Generates themed output.
 *
796 797 798
 * 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
799 800
 * @link themeable theme function or template @endlink, by checking the theme
 * registry.
801
 *
802 803 804 805 806
 * 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().
 *
807
 * @section sec_theme_hooks Theme Hooks
808 809 810 811 812 813 814
 * 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
815
 * Twig rendering engine and are named the same as the theme hook, with
816 817 818
 * underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
 * default template is 'taxonomy-term.tpl.php'.
 *
819
 * @subsection sub_overriding_theme_hooks Overriding Theme Hooks
820 821 822 823 824 825 826 827
 * 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
828 829 830
 * 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).
831
 *
832
 * @subsection sub_preprocess_templates Preprocessing for Template Files
833 834 835 836 837 838 839 840
 * 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.
841 842
 * - template_preprocess_HOOK(&$variables): Should be implemented by the module
 *   that registers the theme hook, to set up default variables.
843 844 845
 * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
 *   implementing modules.
 * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
846 847
 *   all implementing modules, so that modules that didn't define the theme hook
 *   can alter the variables.
848
 * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
849
 *   set necessary variables for all theme hooks with template implementations.
850 851 852
 * - 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
853
 *   variables for all theme hooks with template implementations.
854 855 856
 * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
 *   variables specific to the particular theme hook.
 *
857
 * @subsection sub_preprocess_theme_funcs Preprocessing for Theme Functions
858
 * If the implementation is a function, only the theme-hook-specific preprocess
859 860 861 862
 * 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.
863
 *
864
 * @subsection sub_alternate_suggestions Suggesting Alternate Hooks
865 866 867 868 869 870 871 872 873 874 875
 * There are two special variables that these preprocess functions can set:
 * 'theme_hook_suggestion' and 'theme_hook_suggestions'. These will be merged
 * together to form a list of 'suggested' alternate theme hooks to use, in
 * reverse order of priority. theme_hook_suggestion will always be a higher
 * priority than items in theme_hook_suggestions. 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 a preprocess
 * function.
876
 *
877
 * @param $hook
878 879
 *   The name of the theme hook to call. If the name contains a
 *   double-underscore ('__') and there isn't an implementation for the full
880 881 882 883
 *   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
884 885 886 887 888 889 890
 *   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
891
 *   may also be an array, in which case the first theme hook that has an
892 893
 *   implementation is used. This allows for the code that calls theme() to
 *   explicitly specify the fallback order in a situation where using the '__'
894
 *   convention is not desired or is insufficient.
895 896
 * @param $variables
 *   An associative array of variables to merge with defaults from the theme
897 898 899 900
 *   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.
901
 *
902 903 904
 * @return string|false
 *   An HTML string representing the themed output or FALSE if the passed $hook
 *   is not implemented.
905
 *
906
 * @see drupal_render()
907
 * @see themeable
908 909
 * @see hook_theme()
 * @see template_preprocess()
Dries's avatar
 
Dries committed
910
 */