theme.inc 96.4 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\Language\Language;
17
use Drupal\Core\Extension\Extension;
18
use Drupal\Core\Extension\ExtensionNameLengthException;
19
20
21
use Drupal\Core\Page\FeedLinkElement;
use Drupal\Core\Page\LinkElement;
use Drupal\Core\Page\MetaElement;
22
use Drupal\Core\Template\Attribute;
23
use Drupal\Core\Template\RenderWrapper;
24
use Drupal\Core\Theme\ThemeSettings;
25
use Drupal\Component\Utility\NestedArray;
26
use Drupal\Core\Render\Element;
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.
Dries's avatar
   
Dries committed
94
 */
95
function drupal_theme_initialize() {
96
  global $theme, $theme_key;
97
98
99
100
101

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

103
  $themes = list_themes();
Dries's avatar
   
Dries committed
104

105
106
107
108
  // @todo Let the theme.negotiator listen to the kernel request event.
  // Determine the active theme for the theme negotiator service. This includes
  // the default theme as well as really specific ones like the ajax base theme.
  $request = \Drupal::request();
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
  $theme = \Drupal::service('theme.negotiator')->determineActiveTheme($request);

  // 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
124
125
126
127

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

128
129
130
131
  // Find all our ancestor themes and put them in an array.
  $base_theme = array();
  $ancestor = $theme;
  while ($ancestor && isset($themes[$ancestor]->base_theme)) {
132
    $ancestor = $themes[$ancestor]->base_theme;
133
    $base_theme[] = $themes[$ancestor];
134
  }
135
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
136
137
138
}

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

157
  $theme_path = $theme->getPath();
158

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

  // 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;
        }
      }
    }
177
    $base_theme_path = $base->getPath();
178
179
180
181
182
183
184
185
186
187
188
    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;
      }
    }
189
190
  }

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

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

232
233
  // Do basically the same as the above for libraries
  $final_libraries = array();
234

235
  // Grab libraries from base theme
236
  foreach ($base_theme as $base) {
237
238
239
    if (!empty($base->libraries)) {
      foreach ($base->libraries as $library) {
        $final_libraries[] = $library;
240
      }
Dries's avatar
   
Dries committed
241
242
    }
  }
243

244
245
246
247
  // Add libraries used by this theme.
  if (!empty($theme->libraries)) {
    foreach ($theme->libraries as $library) {
      $final_libraries[] = $library;
248
249
250
    }
  }

251
252
253
254
  // Add libraries used by this theme.
  $libraries = array();
  foreach ($final_libraries as $library) {
    $libraries['#attached']['library'][] = $library;
255
  }
256
  drupal_render($libraries);
257

258
259
260
261
262
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
263
    include_once DRUPAL_ROOT . '/' . $theme->owner;
264
265

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

  // Always include Twig as the default theme engine.
288
  include_once DRUPAL_ROOT . '/core/themes/engines/twig/twig.engine';
Dries's avatar
   
Dries committed
289
290
}

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

/**
319
320
321
322
 * 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.
323
 */
324
function drupal_theme_rebuild() {
325
  \Drupal::service('theme.registry')->reset();
326
327
}

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

  if ($refresh) {
350
    $theme_handler->reset();
351
    system_list_reset();
Dries's avatar
   
Dries committed
352
353
  }

354
  return $theme_handler->listInfo();
Dries's avatar
   
Dries committed
355
356
}

Dries's avatar
   
Dries committed
357
/**
358
 * Generates themed output (internal use only).
359
 *
360
361
362
363
364
365
366
367
 * _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.
368
 *
369
370
371
372
373
374
 * 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.
375
 *
376
 * @param $hook
377
378
 *   The name of the theme hook to call. If the name contains a
 *   double-underscore ('__') and there isn't an implementation for the full
379
 *   name, the part before the '__' is checked. This allows a fallback to a
380
 *   more generic implementation. For example, if _theme('links__node', ...) is
381
382
 *   called, but there is no implementation of that theme hook, then the
 *   'links' implementation is used. This process is iterative, so if
383
 *   _theme('links__contextual__node', ...) is called, _theme() checks for the
384
385
386
387
388
389
 *   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
390
 *   may also be an array, in which case the first theme hook that has an
391
 *   implementation is used. This allows for the code that calls _theme() to
392
 *   explicitly specify the fallback order in a situation where using the '__'
393
 *   convention is not desired or is insufficient.
394
395
 * @param $variables
 *   An associative array of variables to merge with defaults from the theme
396
397
398
399
 *   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.
400
 *
401
402
403
 * @return string|false
 *   An HTML string representing the themed output or FALSE if the passed $hook
 *   is not implemented.
404
 *
405
 * @see drupal_render()
406
 * @see themeable
407
408
 * @see hook_theme()
 * @see template_preprocess()
Dries's avatar
   
Dries committed
409
 */
410
function _theme($hook, $variables = array()) {
411
  static $default_attributes;
412
413
414

  $module_handler = \Drupal::moduleHandler();

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

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

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

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

465
  $info = $theme_registry->get($hook);
466
467
468
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
469
  $theme_path = $info['theme path'];
Dries's avatar
   
Dries committed
470

471
472

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

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

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

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

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

543
544
545
546
547
548
549
550
  // 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;
    }
  }

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

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

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

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

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

651
652
  // restore path_to_theme()
  $theme_path = $temp;
653
  return (string) $output;
654
655
}

Dries's avatar
   
Dries committed
656
/**
657
658
659
660
661
662
663
664
 * 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
665
 */
Dries's avatar
   
Dries committed
666
function path_to_theme() {
667
  global $theme_path;
Dries's avatar
   
Dries committed
668

669
  if (!isset($theme_path)) {
670
    drupal_theme_initialize();
671
672
  }

673
  return $theme_path;
674
675
}

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

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

730
  return $implementations;
731
732
733
}

/**
734
 * Allows themes and/or theme engines to easily discover overridden templates.
735
736
737
738
739
740
741
742
743
 *
 * @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) {
744
  $implementations = array();
745

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

765
  // Escape the periods in the extension.
766
  $regex = '/' . str_replace('.', '\.', $extension) . '$/';
767
  // Get a listing of all template files in the path to search.
768
  $files = file_scan_directory($path, $regex, array('key' => 'filename'));
769
770
771
772

  // 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.
773
  foreach ($files as $template => $file) {
774
    // Ignore sub-theme templates for the current theme.
775
    if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
776
777
      continue;
    }
778
779
    // Remove the extension from the filename.
    $template = str_replace($extension, '', $template);
780
781
782
783
    // Transform - in filenames to _ to match function naming scheme
    // for the purposes of searching.
    $hook = strtr($template, '-', '_');
    if (isset($cache[$hook])) {
784
      $implementations[$hook] = array(
785
        'template' => $template,
786
        'path' => dirname($file->uri),
787
788
      );
    }
789
790
791
792

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

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

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

Dries's avatar
   
Dries committed
838
/**
839
 * Retrieves a setting for the current theme or for a given theme.
Dries's avatar
   
Dries committed
840
 *
841
842
 * The final setting is obtained from the last value found in the following
 * sources:
843
844
845
 * - 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
846
847
848
849
 * - 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
850
851
 *
 * @param $setting_name
852
 *   The name of the setting to be retrieved.
853
 * @param $theme
854
855
 *   The name of a given theme; defaults to the current theme.
 *
Dries's avatar
   
Dries committed
856
857
858
 * @return
 *   The value of the requested setting, NULL if the setting does not exist.
 */
859
860
function theme_get_setting($setting_name, $theme = NULL) {
  $cache = &drupal_static(__FUNCTION__, array());
Dries's avatar
   
Dries committed
861

862
  // If no key is given, use the current theme if we can determine it.
863
  if (!isset($theme)) {
864
    $theme = !empty($GLOBALS['theme_key']) ? $GLOBALS['theme_key'] : '';
865
  }
Dries's avatar
   
Dries committed
866

867
  if (empty($cache[$theme])) {
868
869
    // Create a theme settings object.
    $cache[$theme] = new ThemeSettings($theme);
870

871
872
    // Get the values for the theme-specific settings from the .info.yml files
    // of the theme and all its base themes.
873
874
    $themes = list_themes();
    if ($theme && isset($themes[$theme])) {
875
876
877
878
879
880
      $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
881
      }
882
883
884
      else {
        $theme_keys = array($theme);
      }
885
      // Read hard-coded default settings from the theme info files.
886
887
      foreach ($theme_keys as $theme_key) {
        if (!empty($themes[$theme_key]->info['settings'])) {
888
          $cache[$theme]->merge($themes[$theme_key]->info['settings']);
889
        }
Dries's avatar
   
Dries committed
890
891
892
      }
    }

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

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

906
907
908
      // 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'])) {
909
        foreach (_system_default_theme_features() as $feature) {
910
          if (!in_array($feature, $theme_object->info['features'])) {
911
            $cache[$theme]->set('features.' . $feature, NULL);
912
913
914
915
          }
        }
      }

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

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

948
949
950
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
  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', $value);
    }
    else if ($key == 'favicon_path') {
      $config->set('favicon.path', $value);
    }
    else if ($key == 'favicon_mimetype') {
      $config->set('favicon.mimetype', $value);
    }
    else if (substr($key, 0, 7) == 'toggle_') {
      $config->set('features.' . drupal_substr($key, 7), $value);
    }
    else if (!in_array($key, array('theme', 'logo_upload'))) {
      $config->set($key, $value);
    }
  }
  return $config;
Dries's avatar
   
Dries committed