theme.inc 104 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 12
use Drupal\Core\Utility\ThemeRegistry;

13
/**
14
 * @defgroup content_flags Content markers
15 16 17 18
 * @{
 * Markers used by theme_mark() and node_mark() to designate content.
 * @see theme_mark(), node_mark()
 */
19 20 21 22

/**
 * Mark content as read.
 */
23
const MARK_READ = 0;
24 25 26 27

/**
 * Mark content as being new.
 */
28
const MARK_NEW = 1;
29 30 31 32

/**
 * Mark content as being updated.
 */
33
const MARK_UPDATED = 2;
34

35
/**
36
 * @} End of "defgroup content_flags".
37 38
 */

39 40 41 42
/**
 * Determines if a theme is available to use.
 *
 * @param $theme
43 44
 *   Either the name of a theme or a full theme object.
 *
45 46 47 48 49
 * @return
 *   Boolean TRUE if the theme is enabled or is the site administration theme;
 *   FALSE otherwise.
 */
function drupal_theme_access($theme) {
50
  if (is_object($theme)) {
51
    return !empty($theme->status);
52 53 54
  }
  else {
    $themes = list_themes();
55
    return !empty($themes[$theme]->status);
56 57 58
  }
}

Dries's avatar
 
Dries committed
59
/**
Dries's avatar
 
Dries committed
60
 * Initialize the theme system by loading the theme.
Dries's avatar
 
Dries committed
61
 */
62
function drupal_theme_initialize() {
63
  global $theme, $user, $theme_key;
64 65 66 67 68

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

70
  drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
Dries's avatar
 
Dries committed
71 72
  $themes = list_themes();

73
  // Only select the user selected theme if it is available in the
74
  // list of themes that can be accessed.
75
  $theme = !empty($user->theme) && drupal_theme_access($user->theme) ? $user->theme : variable_get('theme_default', 'stark');
Dries's avatar
 
Dries committed
76

77 78
  // Allow modules to override the theme. Validation has already been performed
  // inside menu_get_custom_theme(), so we do not need to check it again here.
79
  $custom_theme = menu_get_custom_theme();
80
  $theme = !empty($custom_theme) ? $custom_theme : $theme;
Dries's avatar
 
Dries committed
81 82 83 84

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

85 86 87 88
  // Find all our ancestor themes and put them in an array.
  $base_theme = array();
  $ancestor = $theme;
  while ($ancestor && isset($themes[$ancestor]->base_theme)) {
89
    $ancestor = $themes[$ancestor]->base_theme;
90
    $base_theme[] = $themes[$ancestor];
91
  }
92
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
93 94 95

  // Themes can have alter functions, so reset the drupal_alter() cache.
  drupal_static_reset('drupal_alter');
96 97

  // Provide the page with information about the theme that's used, so that a
98
  // later Ajax request can be rendered using the same theme.
99 100 101
  // @see ajax_base_page_theme()
  $setting['ajaxPageState'] = array(
    'theme' => $theme_key,
102
    'theme_token' => drupal_get_token($theme_key),
103 104
  );
  drupal_add_js($setting, 'setting');
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
}

/**
 * Initialize the theme system given already loaded information. This
 * function is useful to initialize a theme when no database is present.
 *
 * @param $theme
 *   An object with the following information:
 *     filename
 *       The .info file for this theme. The 'path' to
 *       the theme will be in this file's directory. (Required)
 *     owner
 *       The path to the .theme file or the .engine file to load for
 *       the theme. (Required)
 *     stylesheet
 *       The primary stylesheet for the theme. (Optional)
 *     engine
 *       The name of theme engine to use. (Optional)
 * @param $base_theme
 *    An optional array of objects that represent the 'base theme' if the
 *    theme is meant to be derivative of another theme. It requires
 *    the same information as the $theme object. It should be in
 *    'oldest first' order, meaning the top level of the chain will
 *    be first.
129 130
 * @param $registry_callback
 *   The callback to invoke to set the theme registry.
131
 */
132
function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callback = '_theme_load_registry') {
133 134 135 136 137 138
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

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

139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154
  // 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();

  // 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;
        }
      }
    }
  }

155 156 157
  // Add stylesheets used by this theme.
  if (!empty($theme->stylesheets)) {
    foreach ($theme->stylesheets as $media => $stylesheets) {
158 159 160 161 162 163 164 165 166
      foreach ($stylesheets as $name => $stylesheet) {
        $final_stylesheets[$media][$name] = $stylesheet;
      }
    }
  }

  // And now add the stylesheets properly
  foreach ($final_stylesheets as $media => $stylesheets) {
    foreach ($stylesheets as $stylesheet) {
167
      drupal_add_css($stylesheet, array('group' => CSS_THEME, 'every_page' => TRUE, 'media' => $media));
168 169 170 171 172 173 174 175 176 177 178
    }
  }

  // Do basically the same as the above for scripts
  $final_scripts = array();

  // Grab scripts from base theme
  foreach ($base_theme as $base) {
    if (!empty($base->scripts)) {
      foreach ($base->scripts as $name => $script) {
        $final_scripts[$name] = $script;
179
      }
Dries's avatar
 
Dries committed
180 181
    }
  }
182

183 184
  // Add scripts used by this theme.
  if (!empty($theme->scripts)) {
185 186
    foreach ($theme->scripts as $name => $script) {
      $final_scripts[$name] = $script;
187 188 189
    }
  }

190 191
  // Add scripts used by this theme.
  foreach ($final_scripts as $script) {
192
    drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
193 194
  }

195 196 197 198 199
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
200
    include_once DRUPAL_ROOT . '/' . $theme->owner;
201 202

    $theme_engine = $theme->engine;
203
    if (function_exists($theme_engine . '_init')) {
204
      foreach ($base_theme as $base) {
205
        call_user_func($theme_engine . '_init', $base);
206
      }
207
      call_user_func($theme_engine . '_init', $theme);
208 209 210 211 212 213 214
    }
  }
  else {
    // include non-engine theme files
    foreach ($base_theme as $base) {
      // Include the theme file or the engine.
      if (!empty($base->owner)) {
215
        include_once DRUPAL_ROOT . '/' . $base->owner;
216 217 218 219
      }
    }
    // and our theme gets one too.
    if (!empty($theme->owner)) {
220
      include_once DRUPAL_ROOT . '/' . $theme->owner;
Dries's avatar
 
Dries committed
221 222
    }
  }
223

224 225
  if (isset($registry_callback)) {
    _theme_registry_callback($registry_callback, array($theme, $base_theme, $theme_engine));
226
  }
Dries's avatar
 
Dries committed
227 228
}

229
/**
230
 * Get the theme registry.
231
 *
232
 * @param bool $complete
233
 *   Optional boolean to indicate whether to return the complete theme registry
234 235 236 237 238 239 240
 *   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.
241
 *
242
 * @return
243 244
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
245
 */
246
function theme_get_registry($complete = TRUE) {
247 248 249 250 251 252 253 254 255 256 257 258 259 260
  // Use the advanced drupal_static() pattern, since this is called very often.
  static $drupal_static_fast;
  if (!isset($drupal_static_fast)) {
    $drupal_static_fast['registry'] = &drupal_static('theme_get_registry');
  }
  $theme_registry = &$drupal_static_fast['registry'];

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

261
  $key = (int) $complete;
262

263
  if (!isset($theme_registry[$key])) {
264
    list($callback, $arguments) = _theme_registry_callback();
265 266 267 268
    if (!$complete) {
      $arguments[] = FALSE;
    }
    $theme_registry[$key] = call_user_func_array($callback, $arguments);
269 270
  }

271
  return $theme_registry[$key];
272 273 274
}

/**
275
 * Set the callback that will be used by theme_get_registry() to fetch the registry.
276
 *
277 278 279 280
 * @param $callback
 *   The name of the callback function.
 * @param $arguments
 *   The arguments to pass to the function.
281
 */
282 283 284 285
function _theme_registry_callback($callback = NULL, array $arguments = array()) {
  static $stored;
  if (isset($callback)) {
    $stored = array($callback, $arguments);
286
  }
287
  return $stored;
288 289 290
}

/**
291
 * Get the theme_registry cache; if it doesn't exist, build it.
292 293
 *
 * @param $theme
294
 *   The loaded $theme object as returned by list_themes().
295 296 297
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
298
 * @param $theme_engine
299
 *   The name of the theme engine.
300 301
 * @param $complete
 *   Whether to load the complete theme registry or an instance of the
302
 *   Drupal\Core\Utility\ThemeRegistry class.
303 304
 *
 * @return
305 306
 *   The theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
307
 */
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
function _theme_load_registry($theme, $base_theme = NULL, $theme_engine = NULL, $complete = TRUE) {
  if ($complete) {
    // Check the theme registry cache; if it exists, use it.
    $cached = cache()->get("theme_registry:$theme->name");
    if (isset($cached->data)) {
      $registry = $cached->data;
    }
    else {
      // If not, build one and cache it.
      $registry = _theme_build_registry($theme, $base_theme, $theme_engine);
      // Only persist this registry if all modules are loaded. This assures a
      // complete set of theme hooks.
      if (module_load_all(NULL)) {
        _theme_save_registry($theme, $registry);
      }
    }
    return $registry;
325 326
  }
  else {
327
    return new ThemeRegistry('theme_registry:runtime:' . $theme->name, 'cache');
328 329 330 331 332 333 334
  }
}

/**
 * Write the theme_registry cache into the database.
 */
function _theme_save_registry($theme, $registry) {
335
  cache()->set("theme_registry:$theme->name", $registry);
336 337 338 339 340 341 342
}

/**
 * Force the system to rebuild the theme registry; this should be called
 * when modules are added to the system, or when a dynamic system needs
 * to add more theme hooks.
 */
343
function drupal_theme_rebuild() {
344
  drupal_static_reset('theme_get_registry');
345
  cache()->deletePrefix('theme_registry');
346 347 348
}

/**
349
 * Process a single implementation of hook_theme().
350
 *
351 352 353 354
 * @param $cache
 *   The theme registry that will eventually be cached; It is an associative
 *   array keyed by theme hooks, whose values are associative arrays describing
 *   the hook:
355 356
 *   - 'type': The passed-in $type.
 *   - 'theme path': The passed-in $path.
357 358 359 360 361 362 363 364 365
 *   - 'function': The name of the function generating output for this theme
 *     hook. Either defined explicitly in hook_theme() or, if neither 'function'
 *     nor 'template' is defined, then the default theme function name is used.
 *     The default theme function name is the theme hook prefixed by either
 *     'theme_' for modules or '$name_' for everything else. If 'function' is
 *     defined, 'template' is not used.
 *   - 'template': The filename of the template generating output for this
 *     theme hook. The template is in the directory defined by the 'path' key of
 *     hook_theme() or defaults to $path.
366 367
 *   - 'variables': The variables for this theme hook as defined in
 *     hook_theme(). If there is more than one implementation and 'variables' is
368
 *     not specified in a later one, then the previous definition is kept.
369 370 371 372
 *   - 'render element': The renderable element for this theme hook as defined
 *     in hook_theme(). If there is more than one implementation and
 *     'render element' is not specified in a later one, then the previous
 *     definition is kept.
373
 *   - 'preprocess functions': See theme() for detailed documentation.
374
 *   - 'process functions': See theme() for detailed documentation.
375 376 377 378 379 380 381 382 383 384 385 386 387 388
 * @param $name
 *   The name of the module, theme engine, base theme engine, theme or base
 *   theme implementing hook_theme().
 * @param $type
 *   One of 'module', 'theme_engine', 'base_theme_engine', 'theme', or
 *   'base_theme'. Unlike regular hooks that can only be implemented by modules,
 *   each of these can implement hook_theme(). _theme_process_registry() is
 *   called in aforementioned order and new entries override older ones. For
 *   example, if a theme hook is both defined by a module and a theme, then the
 *   definition in the theme will be used.
 * @param $theme
 *   The loaded $theme object as returned from list_themes().
 * @param $path
 *   The directory where $name is. For example, modules/system or
389
 *   themes/bartik.
390
 *
391 392 393 394
 * @see theme()
 * @see _theme_process_registry()
 * @see hook_theme()
 * @see list_themes()
395
 */
396
function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
397
  $result = array();
398

399
  // Processor functions work in two distinct phases with the process
400
  // functions always being executed after the preprocess functions.
401
  $variable_process_phases = array(
402 403 404 405
    'preprocess functions' => 'preprocess',
    'process functions'    => 'process',
  );

406 407 408 409 410 411 412 413 414 415
  $hook_defaults = array(
    'variables' => TRUE,
    'render element' => TRUE,
    'pattern' => TRUE,
    'base hook' => TRUE,
  );

  // Invoke the hook_theme() implementation, process what is returned, and
  // merge it into $cache.
  $function = $name . '_theme';
416
  if (function_exists($function)) {
417
    $result = $function($cache, $type, $theme, $path);
418
    foreach ($result as $hook => $info) {
419 420 421 422 423 424 425
      // When a theme or engine overrides a module's theme function
      // $result[$hook] will only contain key/value pairs for information being
      // overridden.  Pull the rest of the information from what was defined by
      // an earlier hook.

      // Fill in the type and path of the module, theme, or engine that
      // implements this theme function.
426
      $result[$hook]['type'] = $type;
427
      $result[$hook]['theme path'] = $path;
428 429

      // If function and file are omitted, default to standard naming
430
      // conventions.
431
      if (!isset($info['template']) && !isset($info['function'])) {
432
        $result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
433
      }
434

435 436
      if (isset($cache[$hook]['includes'])) {
        $result[$hook]['includes'] = $cache[$hook]['includes'];
437
      }
438 439 440 441 442

      // If the theme implementation defines a file, then also use the path
      // that it defined. Otherwise use the default path. This allows
      // system.module to declare theme functions on behalf of core .include
      // files.
443 444 445 446 447
      if (isset($info['file'])) {
        $include_file = isset($info['path']) ? $info['path'] : $path;
        $include_file .= '/' . $info['file'];
        include_once DRUPAL_ROOT . '/' . $include_file;
        $result[$hook]['includes'][] = $include_file;
448
      }
449

450 451 452 453
      // If the default keys are not set, use the default values registered
      // by the module.
      if (isset($cache[$hook])) {
        $result[$hook] += array_intersect_key($cache[$hook], $hook_defaults);
454
      }
455 456 457 458 459 460

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

464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
      // Allow variable processors for all theming hooks, whether the hook is
      // implemented as a template or as a function.
      foreach ($variable_process_phases as $phase_key => $phase) {
        // Check for existing variable processors. Ensure arrayness.
        if (!isset($info[$phase_key]) || !is_array($info[$phase_key])) {
          $info[$phase_key] = array();
          $prefixes = array();
          if ($type == 'module') {
            // Default variable processor prefix.
            $prefixes[] = 'template';
            // Add all modules so they can intervene with their own variable
            // processors. This allows them to provide variable processors even
            // if they are not the owner of the current hook.
            $prefixes += module_list();
          }
          elseif ($type == 'theme_engine' || $type == 'base_theme_engine') {
            // Theme engines get an extra set that come before the normally
            // named variable processors.
            $prefixes[] = $name . '_engine';
            // The theme engine registers on behalf of the theme using the
            // theme's name.
            $prefixes[] = $theme;
486
          }
487 488 489 490
          else {
            // This applies when the theme manually registers their own variable
            // processors.
            $prefixes[] = $name;
491
          }
492 493
          foreach ($prefixes as $prefix) {
            // Only use non-hook-specific variable processors for theming hooks
494
            // implemented as templates. See theme().
495 496 497 498 499 500
            if (isset($info['template']) && function_exists($prefix . '_' . $phase)) {
              $info[$phase_key][] = $prefix . '_' . $phase;
            }
            if (function_exists($prefix . '_' . $phase . '_' . $hook)) {
              $info[$phase_key][] = $prefix . '_' . $phase . '_' . $hook;
            }
501
          }
502
        }
503 504 505 506 507 508 509 510 511 512 513
        // Check for the override flag and prevent the cached variable
        // processors from being used. This allows themes or theme engines to
        // remove variable processors set earlier in the registry build.
        if (!empty($info['override ' . $phase_key])) {
          // Flag not needed inside the registry.
          unset($result[$hook]['override ' . $phase_key]);
        }
        elseif (isset($cache[$hook][$phase_key]) && is_array($cache[$hook][$phase_key])) {
          $info[$phase_key] = array_merge($cache[$hook][$phase_key], $info[$phase_key]);
        }
        $result[$hook][$phase_key] = $info[$phase_key];
514
      }
515 516
    }

517
    // Merge the newly created theme hooks into the existing cache.
518
    $cache = $result + $cache;
519
  }
520

521
  // Let themes have variable processors even if they didn't register a template.
522 523
  if ($type == 'theme' || $type == 'base_theme') {
    foreach ($cache as $hook => $info) {
524 525 526
      // Check only if not registered by the theme or engine.
      if (empty($result[$hook])) {
        foreach ($variable_process_phases as $phase_key => $phase) {
527 528 529
          if (!isset($info[$phase_key])) {
            $cache[$hook][$phase_key] = array();
          }
530
          // Only use non-hook-specific variable processors for theming hooks
531
          // implemented as templates. See theme().
532 533
          if (isset($info['template']) && function_exists($name . '_' . $phase)) {
            $cache[$hook][$phase_key][] = $name . '_' . $phase;
534
          }
535 536
          if (function_exists($name . '_' . $phase . '_' . $hook)) {
            $cache[$hook][$phase_key][] = $name . '_' . $phase . '_' . $hook;
537
            $cache[$hook]['theme path'] = $path;
538 539 540
          }
          // Ensure uniqueness.
          $cache[$hook][$phase_key] = array_unique($cache[$hook][$phase_key]);
541 542 543 544
        }
      }
    }
  }
545 546 547
}

/**
548
 * Build the theme registry cache.
549 550
 *
 * @param $theme
551
 *   The loaded $theme object as returned by list_themes().
552 553 554
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
555
 * @param $theme_engine
556
 *   The name of the theme engine.
557
 */
558
function _theme_build_registry($theme, $base_theme, $theme_engine) {
559
  $cache = array();
560
  // First, process the theme hooks advertised by modules. This will
561 562 563
  // serve as the basic registry. Since the list of enabled modules is the same
  // regardless of the theme used, this is cached in its own entry to save
  // building it for every theme.
564
  if ($cached = cache()->get('theme_registry:build:modules')) {
565 566 567 568 569 570 571 572
    $cache = $cached->data;
  }
  else {
    foreach (module_implements('theme') as $module) {
      _theme_process_registry($cache, $module, 'module', $module, drupal_get_path('module', $module));
    }
    // Only cache this registry if all modules are loaded.
    if (module_load_all(NULL)) {
573
      cache()->set('theme_registry:build:modules', $cache);
574
    }
575 576 577 578
  }

  // Process each base theme.
  foreach ($base_theme as $base) {
579
    // If the base theme uses a theme engine, process its hooks.
580 581 582 583 584
    $base_path = dirname($base->filename);
    if ($theme_engine) {
      _theme_process_registry($cache, $theme_engine, 'base_theme_engine', $base->name, $base_path);
    }
    _theme_process_registry($cache, $base->name, 'base_theme', $base->name, $base_path);
585 586
  }

587
  // And then the same thing, but for the theme.
588
  if ($theme_engine) {
589
    _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
590 591
  }

592 593
  // Finally, hooks provided by the theme itself.
  _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
594

595
  // Let modules alter the registry.
596
  drupal_alter('theme_registry', $cache);
597 598 599 600 601 602 603 604 605

  // Optimize the registry to not have empty arrays for functions.
  foreach ($cache as $hook => $info) {
    foreach (array('preprocess functions', 'process functions') as $phase) {
      if (empty($info[$phase])) {
        unset($cache[$hook][$phase]);
      }
    }
  }
606 607 608
  return $cache;
}

Dries's avatar
 
Dries committed
609
/**
610
 * Return a list of all currently available themes.
Dries's avatar
 
Dries committed
611
 *
612 613
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
614
 *
Dries's avatar
 
Dries committed
615
 * @param $refresh
616
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
617
 *
618
 * @return
619
 *   An associative array of the currently available themes. The keys are the
620
 *   themes' machine names and the values are objects having the following
621
 *   properties:
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
 *   - filename: The filepath and name of the .info file.
 *   - name: The machine name of the theme.
 *   - status: 1 for enabled, 0 for disabled themes.
 *   - info: The contents of the .info file.
 *   - stylesheets: A two dimensional array, using the first key for the
 *     media attribute (e.g. 'all'), the second for the name of the file
 *     (e.g. style.css). The value is a complete filepath (e.g.
 *     themes/bartik/style.css). Not set if no stylesheets are defined in the
 *     .info file.
 *   - scripts: An associative array of JavaScripts, using the filename as key
 *     and the complete filepath as value. Not set if no scripts are defined in
 *     the .info file.
 *   - prefix: The base theme engine prefix.
 *   - engine: The machine name of the theme engine.
 *   - base_theme: If this is a sub-theme, the machine name of the base theme
 *     defined in the .info file. Otherwise, the element is not set.
 *   - base_themes: If this is a sub-theme, an associative array of the
 *     base-theme ancestors of this theme, starting with this theme's base
 *     theme, then the base theme's own base theme, etc. Each entry has an
 *     array key equal to the theme's machine name, and a value equal to the
 *     human-readable theme name; if a theme with matching machine name does
 *     not exist in the system, the value will instead be NULL (and since the
 *     system would not know whether that theme itself has a base theme, that
 *     will end the array of base themes). This is not set if the theme is not
 *     a sub-theme.
 *   - sub_themes: An associative array of themes on the system that are
 *     either direct sub-themes (that is, they declare this theme to be
 *     their base theme), direct sub-themes of sub-themes, etc. The keys are
 *     the themes' machine names, and the values are the themes' human-readable
 *     names. This element is not set if there are no themes on the system that
 *     declare this theme as their base theme. 
*/
654
function list_themes($refresh = FALSE) {
655
  $list = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
656 657

  if ($refresh) {
658
    $list = array();
659
    system_list_reset();
Dries's avatar
 
Dries committed
660 661
  }

662
  if (empty($list)) {
Dries's avatar
 
Dries committed
663
    $list = array();
664 665
    $themes = array();
    // Extract from the database only when it is available.
666
    // Also check that the site is not in the middle of an install or update.
667 668
    if (!defined('MAINTENANCE_MODE')) {
      try {
669
        $themes = system_list('theme');
670
      }
671 672 673 674
      catch (Exception $e) {
        // If the database is not available, rebuild the theme data.
        $themes = _system_rebuild_theme_data();
      }
675 676
    }
    else {
677
      // Scan the installation when the database should not be read.
678
      $themes = _system_rebuild_theme_data();
679 680 681 682 683
    }

    foreach ($themes as $theme) {
      foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
        foreach ($stylesheets as $stylesheet => $path) {
684
          $theme->stylesheets[$media][$stylesheet] = $path;
685
        }
686 687
      }
      foreach ($theme->info['scripts'] as $script => $path) {
688
        $theme->scripts[$script] = $path;
Dries's avatar
 
Dries committed
689
      }
690 691
      if (isset($theme->info['engine'])) {
        $theme->engine = $theme->info['engine'];
Dries's avatar
 
Dries committed
692
      }
693 694 695
      if (isset($theme->info['base theme'])) {
        $theme->base_theme = $theme->info['base theme'];
      }
696 697 698 699 700
      // Status is normally retrieved from the database. Add zero values when
      // read from the installation directory to prevent notices.
      if (!isset($theme->status)) {
        $theme->status = 0;
      }
701
      $list[$theme->name] = $theme;
Dries's avatar
 
Dries committed
702 703 704 705 706 707
    }
  }

  return $list;
}

708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748
/**
 * Find all the base themes for the specified theme.
 *
 * Themes can inherit templates and function implementations from earlier themes.
 *
 * @param $themes
 *   An array of available themes.
 * @param $key
 *   The name of the theme whose base we are looking for.
 * @param $used_keys
 *   A recursion parameter preventing endless loops.
 * @return
 *   Returns an array of all of the theme's ancestors; the first element's value
 *   will be NULL if an error occurred.
 */
function drupal_find_base_themes($themes, $key, $used_keys = array()) {
  $base_key = $themes[$key]->info['base theme'];
  // Does the base theme exist?
  if (!isset($themes[$base_key])) {
    return array($base_key => NULL);
  }

  $current_base_theme = array($base_key => $themes[$base_key]->info['name']);

  // Is the base theme itself a child of another theme?
  if (isset($themes[$base_key]->info['base theme'])) {
    // Do we already know the base themes of this theme?
    if (isset($themes[$base_key]->base_themes)) {
      return $themes[$base_key]->base_themes + $current_base_theme;
    }
    // Prevent loops.
    if (!empty($used_keys[$base_key])) {
      return array($base_key => NULL);
    }
    $used_keys[$base_key] = TRUE;
    return drupal_find_base_themes($themes, $base_key, $used_keys) + $current_base_theme;
  }
  // If we get here, then this is our parent theme.
  return $current_base_theme;
}

Dries's avatar
 
Dries committed
749
/**
750 751 752
 * Generates themed output.
 *
 * All requests for themed output must go through this function. It examines
753 754 755
 * the request and routes it to the appropriate
 * @link themeable theme function or template @endlink, by checking the theme
 * registry.
756
 *
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778
 * Most commonly, the first argument to this function is the name of the theme
 * hook. For instance, to theme a taxonomy term, the theme hook name is
 * 'taxonomy_term'. Modules register theme hooks within a hook_theme()
 * implementation and provide a default implementation via a function named
 * theme_HOOK() (e.g., theme_taxonomy_term()) or via a template file named
 * according to the value of the 'template' key registered with the theme hook
 * (see hook_theme() for details). Default templates are implemented with the
 * PHPTemplate rendering engine and are named the same as the theme hook, with
 * underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
 * default template is 'taxonomy-term.tpl.php'.
 *
 * Themes may also register new theme hooks within a hook_theme()
 * implementation, but it is more common for themes to override default
 * implementations provided by modules than to register entirely new theme
 * hooks. Themes can override a default implementation by implementing a
 * function named THEME_HOOK() (for example, the 'bartik' theme overrides the
 * default implementation of the 'menu_tree' theme hook by implementing a
 * bartik_menu_tree() function), or by adding a template file within its folder
 * structure that follows the template naming structure used by the theme's
 * rendering engine (for example, since the Bartik theme uses the PHPTemplate
 * rendering engine, it overrides the default implementation of the 'page' theme
 * hook by containing a 'page.tpl.php' file within its folder structure).
779 780 781 782 783 784 785 786
 *
 * If the implementation is a template file, several functions are called
 * before the template file is invoked, to modify the $variables array. These
 * fall into the "preprocessing" phase and the "processing" phase, and are
 * executed (if they exist), in the following order (note that in the following
 * list, HOOK indicates the theme hook name, MODULE indicates a module name,
 * THEME indicates a theme name, and ENGINE indicates a theme engine name):
 * - template_preprocess(&$variables, $hook): Creates a default set of variables
787 788 789
 *   for all theme hooks with template implementations.
 * - template_preprocess_HOOK(&$variables): Should be implemented by the module
 *   that registers the theme hook, to set up default variables.
790 791 792 793 794 795
 * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
 *   implementing modules.
 * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
 *   all implementing modules, so that modules that didn't define the theme hook
 *   can alter the variables.
 * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
796
 *   set necessary variables for all theme hooks with template implementations.
797 798 799
 * - ENGINE_engine_preprocess_HOOK(&$variables): Allows the theme engine to set
 *   necessary variables for the particular theme hook.
 * - THEME_preprocess(&$variables, $hook): Allows the theme to set necessary
800
 *   variables for all theme hooks with template implementations.
801 802
 * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
 *   variables specific to the particular theme hook.
803 804 805 806 807 808 809 810 811 812 813
 * - template_process(&$variables, $hook): Creates an additional set of default
 *   variables for all theme hooks with template implementations. The variables
 *   created in this function are derived from ones created by
 *   template_preprocess(), but potentially altered by the other preprocess
 *   functions listed above. For example, any preprocess function can add to or
 *   modify the $variables['attributes_array'] variable, and after all of them
 *   have finished executing, template_process() flattens it into a
 *   $variables['attributes'] string for convenient use by templates.
 * - template_process_HOOK(&$variables): Should be implemented by the module
 *   that registers the theme hook, if it needs to perform additional variable
 *   processing after all preprocess functions have finished.
814 815 816 817 818
 * - MODULE_process(&$variables, $hook): hook_process() is invoked on all
 *   implementing modules.
 * - MODULE_process_HOOK(&$variables): hook_process_HOOK() is invoked on
 *   on all implementing modules, so that modules that didn't define the theme
 *   hook can alter the variables.
819 820 821 822
 * - ENGINE_engine_process(&$variables, $hook): Allows the theme engine to
 *   process variables for all theme hooks with template implementations.
 * - ENGINE_engine_process_HOOK(&$variables): Allows the theme engine to process
 *   the variables specific to the theme hook.
823
 * - THEME_process(&$variables, $hook):  Allows the theme to process the
824
 *   variables for all theme hooks with template implementations.
825 826 827 828
 * - THEME_process_HOOK(&$variables):  Allows the theme to process the
 *   variables specific to the theme hook.
 *
 * If the implementation is a function, only the theme-hook-specific preprocess
829
 * and process functions (the ones ending in _HOOK) are called from the
830 831 832
 * list above. This is because theme hooks with function implementations
 * need to be fast, and calling the non-theme-hook-specific preprocess and
 * process functions for them would incur a noticeable performance penalty.
833
 *
834
 * There are two special variables that these preprocess and process functions
835 836 837 838 839 840 841 842 843 844
 * can set: 'theme_hook_suggestion' and 'theme_hook_suggestions'. These will be
 * merged together to form a list of 'suggested' alternate theme hooks to use,
 * in reverse order of priority. theme_hook_suggestion will always be a higher
 * priority than items in theme_hook_suggestions. theme() will use the
 * highest priority implementation that exists. If none exists, theme() will
 * use the implementation for the theme hook it was called with. These
 * suggestions are similar to and are used for similar reasons as calling
 * theme() with an array as the $hook parameter (see below). The difference
 * is whether the suggestions are determined by the code that calls theme() or
 * by a preprocess or process function.
845
 *
846
 * @param $hook
847 848 849 850
 *   The name of the theme hook to call. If the name contains a
 *   double-underscore ('__') and there isn't an implementation for the full
 *   name, the part before the '__' is checked. This allows a fallback to a more
 *   generic implementation. For example, if theme('links__node', ...) is
851
 *   called, but there is no implementation of that theme hook, then the 'links'
852 853 854 855 856 857 858 859
 *   implementation is used. This process is iterative, so if
 *   theme('links__contextual__node', ...) is called, theme() checks for the
 *   following implementations, and uses the first one that exists:
 *   - links__contextual__node
 *   - links__contextual
 *   - links
 *   This allows themes to create specific theme implementations for named
 *   objects and contexts of otherwise generic theme hooks. The $hook parameter
860
 *   may also be an array, in which case the first theme hook that has an
861 862
 *   implementation is used. This allows for the code that calls theme() to
 *   explicitly specify the fallback order in a situation where using the '__'
863
 *   convention is not desired or is insufficient.
864 865 866 867
 * @param $variables
 *   An associative array of variables to merge with defaults from the theme
 *   registry, pass to preprocess and process functions for modification, and
 *   finally, pass to the function or template implementing the theme hook.
868 869 870
 *   Alternatively, this can be a renderable array, in which case, its
 *   properties are mapped to variables expected by the theme hook
 *   implementations.
871
 *
872
 * @return
873
 *   An HTML string representing the themed output.
874 875
 *
 * @see themeable
876 877 878
 * @see hook_theme()
 * @see template_preprocess()
 * @see template_process()
Dries's avatar
 
Dries committed
879
 */
880
function theme($hook, $variables = array()) {
881 882 883 884 885 886 887
  // 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
  // request properly. See also _theme_load_registry().
  if (!module_load_all(NULL) && !defined('MAINTENANCE_MODE')) {
    throw new Exception(t('theme() may not be called until all modules are loaded.'));
  }

888
  $hooks = theme_get_registry(FALSE);
889

890 891
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
892 893 894 895 896 897 898 899 900
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
      if (isset($hooks[$candidate])) {
        break;
      }
    }
    $hook = $candidate;
  }

901 902
  // If there's no implementation, check for more generic fallbacks. If there's
  // still no implementation, log an error and return an empty string.
903
  if (!isset($hooks[$hook])) {
904 905 906 907 908 909 910 911 912
    // Iteratively strip everything after the last '__' delimiter, until an
    // implementation is found.
    while ($pos = strrpos($hook, '__')) {
      $hook = substr($hook, 0, $pos);
      if (isset($hooks[$hook])) {
        break;
      }
    }
    if (!isset($hooks[$hook])) {
913 914 915
      // Only log a message when not trying theme suggestions ($hook being an
      // array).
      if (!isset($candidate)) {
916
        watchdog('theme', 'Theme key "@key" not found.', array('@key' => $hook), WATCHDOG_WARNING);
917
      }
918 919
      return '';
    }
920 921
  }

922
  $info = $hooks[$hook];
923 924 925
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
926
  $theme_path = $info['theme path'];
Dries's avatar
 
Dries committed
927

928
  // Include a file if the theme function or variable processor is held elsewhere.
929 930 931
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
932 933
    }
  }
934 935

  // If a renderable array is passed as $variables, then set $variables to
936
  // the arguments expected by the theme function.
937 938 939
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
940 941
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {
942 943 944
        if (isset($element["#$name"])) {
          $variables[$name] = $element["#$name"];
        }
945 946
      }
    }
947 948 949
    else {
      $variables[$info['render element']] = $element;
    }
950
  }
951

952
  // Merge in argument defaults.
953 954 955 956 957
  if (!empty($info['variables'])) {
    $variables += $info['variables'];
  }
  elseif (!empty($info['render element'])) {
    $variables += array($info['render element'] => array());
958
  }
959

960
  // Invoke the variable processors, if any. The processors may specify
961 962 963 964 965 966 967
  // alternate suggestions for which hook's template/function to use. If the
  // hook is a suggestion of a base hook, invoke the variable processors of
  // the base hook, but retain the suggestion as a high priority suggestion to
  // be used unless overridden by a variable processor function.
  if (isset($info['base hook'])) {
    $base_hook = $info['base hook'];
    $base_hook_info = $hooks[$base_hook];