theme.inc 96.8 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\UrlHelper;
13
use Drupal\Component\Utility\Xss;
14
use Drupal\Core\Config\Config;
15
use Drupal\Core\Config\StorageException;
16
use Drupal\Core\Extension\Extension;
17
use Drupal\Core\Extension\ExtensionNameLengthException;
18
19
20
use Drupal\Core\Page\FeedLinkElement;
use Drupal\Core\Page\LinkElement;
use Drupal\Core\Page\MetaElement;
21
use Drupal\Core\Routing\RouteMatch;
22
use Drupal\Core\Template\Attribute;
23
use Drupal\Core\Theme\ThemeSettings;
24
use Drupal\Component\Utility\NestedArray;
25
use Drupal\Core\Render\Element;
26
use Symfony\Component\HttpFoundation\Request;
27

28
/**
29
 * @defgroup content_flags Content markers
30
31
32
33
 * @{
 * Markers used by theme_mark() and node_mark() to designate content.
 * @see theme_mark(), node_mark()
 */
34
35
36
37

/**
 * Mark content as read.
 */
38
const MARK_READ = 0;
39
40
41
42

/**
 * Mark content as being new.
 */
43
const MARK_NEW = 1;
44
45
46
47

/**
 * Mark content as being updated.
 */
48
const MARK_UPDATED = 2;
49

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/**
 * 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';

66
/**
67
 * @} End of "defgroup content_flags".
68
69
 */

70
71
72
/**
 * Determines if a theme is available to use.
 *
73
 * @param string|\Drupal\Core\Extension\Extension $theme
74
75
 *   Either the name of a theme or a full theme object.
 *
76
 * @return bool
77
78
 *   Boolean TRUE if the theme is enabled or is the site administration theme;
 *   FALSE otherwise.
79
 *
80
81
82
83
 * @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().
84
85
 */
function drupal_theme_access($theme) {
86
  if ($theme instanceof Extension) {
87
    $theme = $theme->getName();
88
  }
89
  return \Drupal::service('access_check.theme')->checkAccess($theme);
90
91
}

Dries's avatar
   
Dries committed
92
/**
93
 * Initializes the theme system by loading the theme.
94
95
96
97
 *
 * @param RouteMatch $route_match
 *   The route match to use for theme initialization.
// @todo Force calling methods to provide as RouteMatch.
Dries's avatar
   
Dries committed
98
 */
99
function drupal_theme_initialize(RouteMatch $route_match = NULL) {
100
  global $theme, $theme_key;
101
102
103
104
105

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

107
  $themes = list_themes();
Dries's avatar
   
Dries committed
108

109
110
  // 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.
111
112
113
114
  if (!$route_match) {
    $route_match = \Drupal::routeMatch();
  }
  $theme = \Drupal::service('theme.negotiator')->determineActiveTheme($route_match);
115
116
117
118
119
120
121
122
123
124
125
126
127
128

  // If no theme could be negotiated, or if the negotiated theme is not within
  // the list of enabled themes, fall back to the default theme output of core
  // and modules (similar to Stark, but without a theme extension at all). This
  // is possible, because _drupal_theme_initialize() always loads the Twig theme
  // engine.
  if (!$theme || !isset($themes[$theme])) {
    $theme = 'core';
    $theme_key = $theme;
    // /core/core.info.yml does not actually exist, but is required because
    // Extension expects a pathname.
    _drupal_theme_initialize(new Extension('theme', 'core/core.info.yml'));
    return;
  }
Dries's avatar
   
Dries committed
129
130
131
132

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

133
134
135
136
  // Find all our ancestor themes and put them in an array.
  $base_theme = array();
  $ancestor = $theme;
  while ($ancestor && isset($themes[$ancestor]->base_theme)) {
137
    $ancestor = $themes[$ancestor]->base_theme;
138
    $base_theme[] = $themes[$ancestor];
139
  }
140
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
141
142
143
}

/**
144
145
146
 * Initializes the theme system given already loaded information.
 *
 * This function is useful to initialize a theme when no database is present.
147
 *
148
149
150
 * @param \Drupal\Core\Extension\Extension $theme
 *   The theme extension object.
 * @param \Drupal\Core\Extension\Extension[] $base_theme
151
152
153
154
155
156
 *    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.
 */
157
function _drupal_theme_initialize($theme, $base_theme = array()) {
158
159
160
161
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

162
  $theme_path = $theme->getPath();
163

164
165
166
167
  // 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();
168
169
170
171
  // CSS file basenames to override, pointing to the final, overridden filepath.
  $theme->stylesheets_override = array();
  // CSS file basenames to remove.
  $theme->stylesheets_remove = array();
172
173
174
175
176
177
178
179
180
181

  // 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;
        }
      }
    }
182
    $base_theme_path = $base->getPath();
183
184
185
186
187
188
189
190
191
192
193
    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;
      }
    }
194
195
  }

196
197
198
  // Add stylesheets used by this theme.
  if (!empty($theme->stylesheets)) {
    foreach ($theme->stylesheets as $media => $stylesheets) {
199
200
201
202
203
      foreach ($stylesheets as $name => $stylesheet) {
        $final_stylesheets[$media][$name] = $stylesheet;
      }
    }
  }
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
  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]);
      }
    }
  }
223

224
225
  // And now add the stylesheets properly.
  $css = array();
226
227
  foreach ($final_stylesheets as $media => $stylesheets) {
    foreach ($stylesheets as $stylesheet) {
228
229
230
231
232
      $css['#attached']['css'][$stylesheet] = array(
        'group' => CSS_AGGREGATE_THEME,
        'every_page' => TRUE,
        'media' => $media
      );
233
234
    }
  }
235
  drupal_render($css);
236

237
238
  // Do basically the same as the above for libraries
  $final_libraries = array();
239

240
  // Grab libraries from base theme
241
  foreach ($base_theme as $base) {
242
243
244
    if (!empty($base->libraries)) {
      foreach ($base->libraries as $library) {
        $final_libraries[] = $library;
245
      }
Dries's avatar
   
Dries committed
246
247
    }
  }
248

249
250
251
252
  // Add libraries used by this theme.
  if (!empty($theme->libraries)) {
    foreach ($theme->libraries as $library) {
      $final_libraries[] = $library;
253
254
255
    }
  }

256
257
258
259
  // Add libraries used by this theme.
  $libraries = array();
  foreach ($final_libraries as $library) {
    $libraries['#attached']['library'][] = $library;
260
  }
261
  drupal_render($libraries);
262

263
264
265
266
267
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
268
    include_once DRUPAL_ROOT . '/' . $theme->owner;
269
270

    $theme_engine = $theme->engine;
271
    if (function_exists($theme_engine . '_init')) {
272
      foreach ($base_theme as $base) {
273
        call_user_func($theme_engine . '_init', $base);
274
      }
275
      call_user_func($theme_engine . '_init', $theme);
276
277
278
279
280
281
282
    }
  }
  else {
    // include non-engine theme files
    foreach ($base_theme as $base) {
      // Include the theme file or the engine.
      if (!empty($base->owner)) {
283
        include_once DRUPAL_ROOT . '/' . $base->owner;
284
285
286
287
      }
    }
    // and our theme gets one too.
    if (!empty($theme->owner)) {
288
      include_once DRUPAL_ROOT . '/' . $theme->owner;
Dries's avatar
   
Dries committed
289
290
    }
  }
291
292

  // Always include Twig as the default theme engine.
293
  include_once DRUPAL_ROOT . '/core/themes/engines/twig/twig.engine';
Dries's avatar
   
Dries committed
294
295
}

296
/**
297
 * Gets the theme registry.
298
 *
299
 * @param bool $complete
300
 *   Optional boolean to indicate whether to return the complete theme registry
301
302
303
304
305
306
307
 *   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.
308
 *
309
 * @return
310
311
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
312
 */
313
function theme_get_registry($complete = TRUE) {
314
  $theme_registry = \Drupal::service('theme.registry');
315
  if ($complete) {
316
    return $theme_registry->get();
317
318
  }
  else {
319
    return $theme_registry->getRuntime();
320
321
322
323
  }
}

/**
324
325
326
327
 * 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.
328
 */
329
function drupal_theme_rebuild() {
330
  \Drupal::service('theme.registry')->reset();
331
332
}

Dries's avatar
   
Dries committed
333
/**
334
 * Returns a list of all currently available themes.
Dries's avatar
   
Dries committed
335
 *
336
337
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
338
 *
Dries's avatar
   
Dries committed
339
 * @param $refresh
340
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
341
 *
342
343
 * @return array
 *   An associative array of the currently available themes.
344
 *
345
346
347
348
 * @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().
349
 */
350
function list_themes($refresh = FALSE) {
351
352
  /** @var \Drupal\Core\Extension\ThemeHandler $theme_handler */
  $theme_handler = \Drupal::service('theme_handler');
Dries's avatar
   
Dries committed
353
354

  if ($refresh) {
355
    $theme_handler->reset();
356
    system_list_reset();
Dries's avatar
   
Dries committed
357
358
  }

359
  return $theme_handler->listInfo();
Dries's avatar
   
Dries committed
360
361
}

Dries's avatar
   
Dries committed
362
/**
363
 * Generates themed output (internal use only).
364
 *
365
366
367
368
369
370
371
372
 * _theme() is an internal function. Do not call this function directly as it
 * will prevent the following items from working correctly:
 * - Render caching.
 * - JavaScript and CSS asset attachment.
 * - Pre / post render hooks.
 * - Defaults provided by hook_element_info(), including attached assets.
 * Instead, build a render array with a #theme key, and either return the
 * array (where possible) or call drupal_render() to convert it to HTML.
373
 *
374
375
376
377
378
379
 * All requests for themed output must go through this function, which is
 * invoked as part of the @link theme_render drupal_render() process @endlink.
 * The appropriate theme function is indicated by the #theme property
 * of a renderable array. _theme() examines the request and routes it to the
 * appropriate @link themeable theme function or template @endlink, by checking
 * the theme registry.
380
 *
381
 * @param $hook
382
383
 *   The name of the theme hook to call. If the name contains a
 *   double-underscore ('__') and there isn't an implementation for the full
384
 *   name, the part before the '__' is checked. This allows a fallback to a
385
 *   more generic implementation. For example, if _theme('links__node', ...) is
386
387
 *   called, but there is no implementation of that theme hook, then the
 *   'links' implementation is used. This process is iterative, so if
388
 *   _theme('links__contextual__node', ...) is called, _theme() checks for the
389
390
391
392
393
394
 *   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
395
 *   may also be an array, in which case the first theme hook that has an
396
 *   implementation is used. This allows for the code that calls _theme() to
397
 *   explicitly specify the fallback order in a situation where using the '__'
398
 *   convention is not desired or is insufficient.
399
400
 * @param $variables
 *   An associative array of variables to merge with defaults from the theme
401
402
403
404
 *   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.
405
 *
406
407
408
 * @return string|false
 *   An HTML string representing the themed output or FALSE if the passed $hook
 *   is not implemented.
409
 *
410
 * @see drupal_render()
411
 * @see themeable
412
413
 * @see hook_theme()
 * @see template_preprocess()
Dries's avatar
   
Dries committed
414
 */
415
function _theme($hook, $variables = array()) {
416
  static $default_attributes;
417
418
419

  $module_handler = \Drupal::moduleHandler();

420
421
  // 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
422
  // request properly. See also \Drupal\Core\Theme\Registry::get().
423
  if (!$module_handler->isLoaded() && !defined('MAINTENANCE_MODE')) {
424
    throw new Exception(t('_theme() may not be called until all modules are loaded.'));
425
  }
426
427
  // Ensure the theme is initialized.
  drupal_theme_initialize();
428

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

432
433
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
434
435
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
436
      if ($theme_registry->has($candidate)) {
437
438
439
440
441
        break;
      }
    }
    $hook = $candidate;
  }
442
443
444
  // Save the original theme hook, so it can be supplied to theme variable
  // preprocess callbacks.
  $original_hook = $hook;
445

446
447
  // If there's no implementation, check for more generic fallbacks. If there's
  // still no implementation, log an error and return an empty string.
448
  if (!$theme_registry->has($hook)) {
449
450
451
452
    // Iteratively strip everything after the last '__' delimiter, until an
    // implementation is found.
    while ($pos = strrpos($hook, '__')) {
      $hook = substr($hook, 0, $pos);
453
      if ($theme_registry->has($hook)) {
454
455
456
        break;
      }
    }
457
    if (!$theme_registry->has($hook)) {
458
459
460
      // Only log a message when not trying theme suggestions ($hook being an
      // array).
      if (!isset($candidate)) {
461
        \Drupal::logger('theme')->warning('Theme hook %hook not found.', array('%hook' => $hook));
462
      }
463
      // There is no theme implementation for the hook passed. Return FALSE so
464
      // the function calling _theme() can differentiate between a hook that
465
466
      // exists and renders an empty string and a hook that is not implemented.
      return FALSE;
467
    }
468
469
  }

470
  $info = $theme_registry->get($hook);
471
472
473
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
474
  $theme_path = $info['theme path'];
Dries's avatar
   
Dries committed
475

476
477

  // If a renderable array is passed as $variables, then set $variables to
478
  // the arguments expected by the theme function.
479
480
481
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
482
483
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {
484
        if (isset($element["#$name"]) || array_key_exists("#$name", $element)) {
485
486
          $variables[$name] = $element["#$name"];
        }
487
488
      }
    }
489
490
    else {
      $variables[$info['render element']] = $element;
491
492
      // Give a hint to render engines to prevent infinite recursion.
      $variables[$info['render element']]['#render_children'] = TRUE;
493
    }
494
  }
495

496
  // Merge in argument defaults.
497
498
499
500
501
  if (!empty($info['variables'])) {
    $variables += $info['variables'];
  }
  elseif (!empty($info['render element'])) {
    $variables += array($info['render element'] => array());
502
  }
503
504
505
506
  // Supply original caller info.
  $variables += array(
    'theme_hook_original' => $original_hook,
  );
507

508
509
510
511
512
513
514
515
516
517
518
519
  // 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().
520
  $suggestions = $module_handler->invokeAll('theme_suggestions_' . $base_theme_hook, array($variables));
521
  // If _theme() was invoked with a direct theme suggestion like
522
523
524
525
526
  // '#theme' => 'node__article', add it to the suggestions array before
  // invoking suggestion alter hooks.
  if (isset($info['base hook'])) {
    $suggestions[] = $hook;
  }
527
528
529
530
531
532
533

  // Invoke hook_theme_suggestions_alter() and
  // hook_theme_suggestions_HOOK_alter().
  $hooks = array(
    'theme_suggestions',
    'theme_suggestions_' . $base_theme_hook,
  );
534
  $module_handler->alter($hooks, $suggestions, $variables, $base_theme_hook);
535
536

  // Check if each suggestion exists in the theme registry, and if so,
537
538
  // use it instead of the hook that _theme() was called with. For example, a
  // function may call _theme('node', ...), but a module can add
539
540
541
  // '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) {
542
543
    if ($theme_registry->has($suggestion)) {
      $info = $theme_registry->get($suggestion);
544
545
546
547
      break;
    }
  }

548
549
550
551
552
553
554
555
  // Include a file if the theme function or variable preprocessor is held
  // elsewhere.
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
    }
  }

556
  // Invoke the variable preprocessors, if any.
557
558
  if (isset($info['base hook'])) {
    $base_hook = $info['base hook'];
559
    $base_hook_info = $theme_registry->get($base_hook);
560
    // Include files required by the base hook, since its variable preprocessors
561
562
563
564
565
566
    // might reside there.
    if (!empty($base_hook_info['includes'])) {
      foreach ($base_hook_info['includes'] as $include_file) {
        include_once DRUPAL_ROOT . '/' . $include_file;
      }
    }
567
    // Replace the preprocess functions with those from the base hook.
568
    if (isset($base_hook_info['preprocess functions'])) {
569
570
571
572
      // 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'];
573
574
    }
  }
575
576
577
578
  if (isset($info['preprocess functions'])) {
    foreach ($info['preprocess functions'] as $preprocessor_function) {
      if (function_exists($preprocessor_function)) {
        $preprocessor_function($variables, $hook, $info);
579
      }
580
581
    }
  }
582

583
  // Generate the output using either a function or a template.
584
  $output = '';
585
  if (isset($info['function'])) {
586
    if (function_exists($info['function'])) {
587
      $output = $info['function']($variables);
Dries's avatar
   
Dries committed
588
    }
Dries's avatar
   
Dries committed
589
  }
590
  else {
591
592
    $render_function = 'twig_render_template';
    $extension = '.html.twig';
593

594
    // The theme engine may use a different extension and a different renderer.
595
596
    global $theme_engine;
    if (isset($theme_engine)) {
597
      if ($info['type'] != 'module') {
598
599
        if (function_exists($theme_engine . '_render_template')) {
          $render_function = $theme_engine . '_render_template';
600
        }
601
        $extension_function = $theme_engine . '_extension';
602
603
604
605
606
607
        if (function_exists($extension_function)) {
          $extension = $extension_function();
        }
      }
    }

608
609
610
611
612
    // 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
613
614
615
616
617
    // 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.
618
619
    if (!isset($variables['directory'])) {
      $default_template_variables = array();
620
      template_preprocess($default_template_variables, $hook, $info);
621
622
      $variables += $default_template_variables;
    }
623
624
625
626
627
628
629
630
631
632
633
634
635
636
    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;
        }
      }
    }
637

638
639
640
641
    // Render the output using the template file.
    $template_file = $info['template'] . $extension;
    if (isset($info['path'])) {
      $template_file = $info['path'] . '/' . $template_file;
642
    }
643
644
645
646
647
648
649
650
651
652
    // 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;
    }
653
    $output = $render_function($template_file, $variables);
Dries's avatar
   
Dries committed
654
  }
655

656
657
  // restore path_to_theme()
  $theme_path = $temp;
658
  return (string) $output;
659
660
}

Dries's avatar
   
Dries committed
661
/**
662
663
664
665
666
667
668
669
 * 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
670
 */
Dries's avatar
   
Dries committed
671
function path_to_theme() {
672
  global $theme_path;
Dries's avatar
   
Dries committed
673

674
  if (!isset($theme_path)) {
675
    drupal_theme_initialize();
676
677
  }

678
  return $theme_path;
679
680
}

681
/**
682
 * Allows themes and/or theme engines to discover overridden theme functions.
683
684
685
686
687
688
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $prefixes
 *   An array of prefixes to test, in reverse order of importance.
 *
689
 * @return $implementations
690
691
692
 *   The functions found, suitable for returning from hook_theme;
 */
function drupal_find_theme_functions($cache, $prefixes) {
693
  $implementations = array();
694
695
696
697
  $functions = get_defined_functions();

  foreach ($cache as $hook => $info) {
    foreach ($prefixes as $prefix) {
698
699
700
701
702
703
      // 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
704
      // the same base hook. To keep things simple, deep hierarchy of
705
706
707
708
      // 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.
709
      $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
710
      if (!isset($info['base hook']) && !empty($pattern)) {
711
        $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
712
713
        if ($matches) {
          foreach ($matches as $match) {
714
            $new_hook = substr($match, strlen($prefix) + 1);
715
            $arg_name = isset($info['variables']) ? 'variables' : 'render element';
716
            $implementations[$new_hook] = array(
717
              'function' => $match,
718
              $arg_name => $info[$arg_name],
719
              'base hook' => $hook,
720
721
722
723
            );
          }
        }
      }
724
725
726
      // 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.
727
      if (function_exists($prefix . '_' . $hook)) {
728
        $implementations[$hook] = array(
729
          'function' => $prefix . '_' . $hook,
730
731
732
733
734
        );
      }
    }
  }

735
  return $implementations;
736
737
738
}

/**
739
 * Allows themes and/or theme engines to easily discover overridden templates.
740
741
742
743
744
745
746
747
748
 *
 * @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) {
749
  $implementations = array();
750

751
752
753
754
  // 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();
755
  foreach (list_themes() as $theme_info) {
756
    if (!empty($theme_info->base_theme)) {
757
      $theme_paths[$theme_info->base_theme][$theme_info->getName()] = $theme_info->getPath();
758
759
760
761
762
763
764
    }
  }
  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]);
      }
765
766
    }
  }
767
768
  global $theme;
  $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
769

770
  // Escape the periods in the extension.
771
  $regex = '/' . str_replace('.', '\.', $extension) . '$/';
772
  // Get a listing of all template files in the path to search.
773
  $files = file_scan_directory($path, $regex, array('key' => 'filename'));
774
775
776
777

  // Find templates that implement registered theme hooks and include that in
  // what is returned so that the registry knows that the theme has this
  // implementation.
778
  foreach ($files as $template => $file) {
779
    // Ignore sub-theme templates for the current theme.
780
    if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
781
782
      continue;
    }
783
784
    // Remove the extension from the filename.
    $template = str_replace($extension, '', $template);
785
786
787
788
    // Transform - in filenames to _ to match function naming scheme
    // for the purposes of searching.
    $hook = strtr($template, '-', '_');
    if (isset($cache[$hook])) {
789
      $implementations[$hook] = array(
790
        'template' => $template,
791
        'path' => dirname($file->uri),
792
793
      );
    }
794
795
796
797

    // Match templates based on the 'template' filename.
    foreach ($cache as $hook => $info) {
      if (isset($info['template'])) {
798
        $template_candidates = array($info['template'], str_replace($info['theme path'] . '/templates/', '', $info['template']));
799
800
801
802
803
804
805
806
        if (in_array($template, $template_candidates)) {
          $implementations[$hook] = array(
            'template' => $template,
            'path' => dirname($file->uri),
          );
        }
      }
    }
807
808
  }

809
  // Find templates that implement possible "suggestion" variants of registered
810
  // theme hooks and add those as new registered theme hooks. See
811
812
  // drupal_find_theme_functions() for more information about suggestions and
  // the use of 'pattern' and 'base hook'.
813
814
  $patterns = array_keys($files);
  foreach ($cache as $hook => $info) {
815
    $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
816
    if (!isset($info['base hook']) && !empty($pattern)) {
817
818
      // Transform _ in pattern to - to match file naming scheme
      // for the purposes of searching.
819
      $pattern = strtr($pattern, '_', '-');
820

821
      $matches = preg_grep('/^' . $pattern . '/', $patterns);
822
823
      if ($matches) {
        foreach ($matches as $match) {
824
          $file = $match;
825
826
          // Remove the extension from the filename.
          $file = str_replace($extension, '', $file);
827
828
          // Put the underscores back in for the hook name and register this
          // pattern.
829
          $arg_name = isset($info['variables']) ? 'variables' : 'render element';
830
          $implementations[strtr($file, '-', '_')] = array(
831
            'template' => $file,
832
            'path' => dirname($files[$match]->uri),
833
            $arg_name => $info[$arg_name],
834
            'base hook' => $hook,
835
836
837
838
839
          );
        }
      }
    }
  }
840
  return $implementations;
841
842
}

Dries's avatar
   
Dries committed
843
/**
844
 * Retrieves a setting for the current theme or for a given theme.
Dries's avatar
   
Dries committed
845
 *
846
847
 * The final setting is obtained from the last value found in the following
 * sources:
848
849
850
 * - the default theme-specific settings defined in any base theme's .info.yml
 *   file
 * - the default theme-specific settings defined in the theme's .info.yml file
851
852
853
854
 * - the saved values from the global theme settings form
 * - the saved values from the theme's settings form
 * To only retrieve the default global theme setting, an empty string should be
 * given for $theme.
Dries's avatar
   
Dries committed
855
856
 *
 * @param $setting_name
857
 *   The name of the setting to be retrieved.
858
 * @param $theme
859
860
 *   The name of a given theme; defaults to the current theme.
 *
Dries's avatar
   
Dries committed
861
862
863
 * @return
 *   The value of the requested setting, NULL if the setting does not exist.
 */
864
865
function theme_get_setting($setting_name, $theme = NULL) {
  $cache = &drupal_static(__FUNCTION__, array());
Dries's avatar
   
Dries committed
866

867
  // If no key is given, use the current theme if we can determine it.
868
  if (!isset($theme)) {
869
    $theme = !empty($GLOBALS['theme_key']) ? $GLOBALS['theme_key'] : '';
870
  }
Dries's avatar
   
Dries committed
871

872
  if (empty($cache[$theme])) {
873
874
    // Create a theme settings object.
    $cache[$theme] = new ThemeSettings($theme);
875

876
877
    // Get the values for the theme-specific settings from the .info.yml files
    // of the theme and all its base themes.
878
879
    $themes = list_themes();
    if ($theme && isset($themes[$theme])) {
880
881
882
883
884
885
      $theme_object = $themes[$theme];

      // Create a list which includes the current theme and all its base themes.
      if (isset($theme_object->base_themes)) {
        $theme_keys = array_keys($theme_object->base_themes);
        $theme_keys[] = $theme;
Dries's avatar
   
Dries committed
886
      }
887
888
889
      else {
        $theme_keys = array($theme);
      }
890
      // Read hard-coded default settings from the theme info files.
891
892
      foreach ($theme_keys as $theme_key) {
        if (!empty($themes[$theme_key]->info['settings'])) {
893
          $cache[$theme]->merge($themes[$theme_key]->info['settings']);
894
        }
Dries's avatar
   
Dries committed
895
896
897
      }
    }

898
    // Get the global settings from configuration.
899
    $cache[$theme]->merge(\Drupal::config('system.theme.global')->get());
900

901
    if ($theme && isset($themes[$theme])) {
902
903
904
905
906
907
908
909
      // Retrieve configured theme-specific settings, if any.
      try {
        if ($theme_settings = \Drupal::config($theme . '.settings')->get()) {
          $cache[$theme]->merge($theme_settings);
        }
      }
      catch (StorageException $e) {
      }
910

911
912
913
      // If the theme does not support a particular feature, override the global
      // setting and set the value to NULL.
      if (!empty($theme_object->info['features'])) {
914
        foreach (_system_default_theme_features() as $feature) {
915
          if (!in_array($feature, $theme_object->info['features'])) {
916
            $cache[$theme]->set('features.' . $feature, NULL);
917
918
919
920
          }
        }
      }

921
      // Generate the path to the logo image.
922
923
924
      if ($cache[$theme]->get('features.logo')) {
        $logo_path = $cache[$theme]->get('logo.path');
        if ($cache[$theme]->get('logo.use_default')) {
925
          $cache[$theme]->set('logo.url', file_create_url($theme_object->getPath() . '/logo.png'));
926
        }
927
928
        elseif ($logo_path) {
          $cache[$theme]->set('logo.url', file_create_url($logo_path));
929
930
        }
      }
931
932

      // Generate the path to the favicon.
933
934
935
      if ($cache[$theme]->get('features.favicon')) {
        $favicon_path = $cache[$theme]->get('favicon.path');
        if ($cache[$theme]->get('favicon.use_default')) {
936
          if (file_exists($favicon = $theme_object->getPath() . '/favicon.ico')) {
937
            $cache[$theme]->set('favicon.url', file_create_url($favicon));
938
939
          }
          else {
940
            $cache[$theme]->set('favicon.url', file_create_url('core/misc/favicon.ico'));
941
942
          }
        }
943
944
        elseif ($favicon_path) {
          $cache[$theme]->set('favicon.url', file_create_url($favicon_path));
945
946
        }
        else {
947
          $cache[$theme]->set('features.favicon', FALSE);
948
        }
949
      }
950
    }
Dries's avatar
   
Dries committed
951
952
  }

953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
  return $cache[$theme]->get($setting_name);
}

/**
 * Converts theme settings to configuration.
 *
 * @see system_theme_settings_submit()
 *
 * @param array $theme_settings
 *   An array of theme settings from system setting form or a Drupal 7 variable.
 * @param Config $config
 *   The configuration object to update.
 *
 * @return
 *   The Config object with updated data.
 */
function theme_settings_convert_to_config(array $theme_settings, Config $config) {
  foreach ($theme_settings as $key => $value) {
    if ($key == 'default_logo') {
      $config->set('logo.use_default', $value);
    }
    else if ($key == 'logo_path') {
      $config->set('logo.path', $value);
    }
    else if ($key == 'default_favicon') {
      $config->set('favicon.use_default',