theme.inc 97.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\SafeMarkup;
12
use Drupal\Component\Utility\String;
13
use Drupal\Component\Utility\UrlHelper;
14
use Drupal\Component\Utility\Xss;
15
use Drupal\Core\Config\Config;
16
use Drupal\Core\Config\StorageException;
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\Routing\RouteMatch;
23
use Drupal\Core\Template\Attribute;
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 35
 * Markers used by mark.html.twig and node_mark() to designate content.
 *
 * @see mark.html.twig
 * @see node_mark()
36
 */
37 38 39 40

/**
 * Mark content as read.
 */
41
const MARK_READ = 0;
42 43 44 45

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

/**
 * Mark content as being updated.
 */
51
const MARK_UPDATED = 2;
52

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

69
/**
70
 * @} End of "defgroup content_flags".
71 72
 */

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

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

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

110
  $themes = list_themes();
Dries's avatar
 
Dries committed
111

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

  // 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
132 133 134 135

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

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

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

165
  $theme_path = $theme->getPath();
166

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

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

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

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

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

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

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

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

266 267 268 269 270
  $theme_engine = NULL;

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

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

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

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

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

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

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

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

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

  $module_handler = \Drupal::moduleHandler();

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

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

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

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

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

479 480

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

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

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

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

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

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

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

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

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

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

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

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

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

677
  if (!isset($theme_path)) {
678
    drupal_theme_initialize();
679 680
  }

681
  return $theme_path;
682 683
}

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

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

738
  return $implementations;
739 740 741
}

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

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

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

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

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

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

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