theme.inc 96.1 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\Template\RenderWrapper;
24
use Drupal\Core\Theme\ThemeSettings;
25
use Drupal\Component\Utility\NestedArray;
26
use Drupal\Core\Render\Element;
27
use Symfony\Component\HttpFoundation\Request;
28

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
93
/**
94
 * Initializes the theme system by loading the theme.
95 96 97 98
 *
 * @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
99
 */
100
function drupal_theme_initialize(RouteMatch $route_match = NULL) {
101
  global $theme, $theme_key;
102 103 104 105 106

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

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

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

  // 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
130 131 132 133

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

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

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

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

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

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

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

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

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

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

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

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

264 265 266 267 268
  $theme_engine = NULL;

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

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

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

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

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

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

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

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

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

  $module_handler = \Drupal::moduleHandler();

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

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

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

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

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

477 478

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

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

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

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

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

549 550 551 552 553 554 555 556
  // 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;
    }
  }

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

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

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

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

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

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

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

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

679
  return $theme_path;
680 681
}

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

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

736
  return $implementations;
737 738 739
}

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

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

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

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

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

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

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

Dries's avatar
 
Dries committed
844
/**