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 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
}

/**
 * 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.
120 121
 * @param $registry_callback
 *   The callback to invoke to set the theme registry.
122
 */
123
function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callback = '_theme_load_registry') {
124 125 126 127 128 129
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

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

130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
  // 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;
        }
      }
    }
  }

146 147 148
  // Add stylesheets used by this theme.
  if (!empty($theme->stylesheets)) {
    foreach ($theme->stylesheets as $media => $stylesheets) {
149 150 151 152 153 154 155 156 157
      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) {
158
      drupal_add_css($stylesheet, array('group' => CSS_THEME, 'every_page' => TRUE, 'media' => $media));
159 160 161 162 163 164 165 166 167 168 169
    }
  }

  // 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;
170
      }
Dries's avatar
 
Dries committed
171 172
    }
  }
173

174 175
  // Add scripts used by this theme.
  if (!empty($theme->scripts)) {
176 177
    foreach ($theme->scripts as $name => $script) {
      $final_scripts[$name] = $script;
178 179 180
    }
  }

181 182
  // Add scripts used by this theme.
  foreach ($final_scripts as $script) {
183
    drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
184 185
  }

186 187 188 189 190
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
191
    include_once DRUPAL_ROOT . '/' . $theme->owner;
192 193

    $theme_engine = $theme->engine;
194
    if (function_exists($theme_engine . '_init')) {
195
      foreach ($base_theme as $base) {
196
        call_user_func($theme_engine . '_init', $base);
197
      }
198
      call_user_func($theme_engine . '_init', $theme);
199 200 201 202 203 204 205
    }
  }
  else {
    // include non-engine theme files
    foreach ($base_theme as $base) {
      // Include the theme file or the engine.
      if (!empty($base->owner)) {
206
        include_once DRUPAL_ROOT . '/' . $base->owner;
207 208 209 210
      }
    }
    // and our theme gets one too.
    if (!empty($theme->owner)) {
211
      include_once DRUPAL_ROOT . '/' . $theme->owner;
Dries's avatar
 
Dries committed
212 213
    }
  }
214

215 216
  if (isset($registry_callback)) {
    _theme_registry_callback($registry_callback, array($theme, $base_theme, $theme_engine));
217
  }
Dries's avatar
 
Dries committed
218 219
}

220
/**
221
 * Get the theme registry.
222
 *
223
 * @param bool $complete
224
 *   Optional boolean to indicate whether to return the complete theme registry
225 226 227 228 229 230 231
 *   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.
232
 *
233
 * @return
234 235
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
236
 */
237
function theme_get_registry($complete = TRUE) {
238 239 240 241 242 243 244 245 246 247 248 249 250 251
  // 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();
  }

252
  $key = (int) $complete;
253

254
  if (!isset($theme_registry[$key])) {
255
    list($callback, $arguments) = _theme_registry_callback();
256 257 258 259
    if (!$complete) {
      $arguments[] = FALSE;
    }
    $theme_registry[$key] = call_user_func_array($callback, $arguments);
260 261
  }

262
  return $theme_registry[$key];
263 264 265
}

/**
266
 * Set the callback that will be used by theme_get_registry() to fetch the registry.
267
 *
268 269 270 271
 * @param $callback
 *   The name of the callback function.
 * @param $arguments
 *   The arguments to pass to the function.
272
 */
273 274 275 276
function _theme_registry_callback($callback = NULL, array $arguments = array()) {
  static $stored;
  if (isset($callback)) {
    $stored = array($callback, $arguments);
277
  }
278
  return $stored;
279 280 281
}

/**
282
 * Get the theme_registry cache; if it doesn't exist, build it.
283 284
 *
 * @param $theme
285
 *   The loaded $theme object as returned by list_themes().
286 287 288
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
289
 * @param $theme_engine
290
 *   The name of the theme engine.
291 292
 * @param $complete
 *   Whether to load the complete theme registry or an instance of the
293
 *   Drupal\Core\Utility\ThemeRegistry class.
294 295
 *
 * @return
296 297
 *   The theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
298
 */
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
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;
316 317
  }
  else {
318
    return new ThemeRegistry('theme_registry:runtime:' . $theme->name, 'cache');
319 320 321 322 323 324 325
  }
}

/**
 * Write the theme_registry cache into the database.
 */
function _theme_save_registry($theme, $registry) {
326
  cache()->set("theme_registry:$theme->name", $registry);
327 328 329 330 331 332 333
}

/**
 * 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.
 */
334
function drupal_theme_rebuild() {
335
  drupal_static_reset('theme_get_registry');
336
  cache()->deletePrefix('theme_registry');
337 338 339
}

/**
340
 * Process a single implementation of hook_theme().
341
 *
342 343 344 345
 * @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:
346 347
 *   - 'type': The passed-in $type.
 *   - 'theme path': The passed-in $path.
348 349 350 351 352 353 354 355 356
 *   - '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.
357 358
 *   - 'variables': The variables for this theme hook as defined in
 *     hook_theme(). If there is more than one implementation and 'variables' is
359
 *     not specified in a later one, then the previous definition is kept.
360 361 362 363
 *   - '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.
364
 *   - 'preprocess functions': See theme() for detailed documentation.
365
 *   - 'process functions': See theme() for detailed documentation.
366 367 368 369 370 371 372 373 374 375 376 377 378 379
 * @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
380
 *   themes/bartik.
381
 *
382 383 384 385
 * @see theme()
 * @see _theme_process_registry()
 * @see hook_theme()
 * @see list_themes()
386
 */
387
function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
388
  $result = array();
389

390
  // Processor functions work in two distinct phases with the process
391
  // functions always being executed after the preprocess functions.
392
  $variable_process_phases = array(
393 394 395 396
    'preprocess functions' => 'preprocess',
    'process functions'    => 'process',
  );

397 398 399 400 401 402 403 404 405 406
  $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';
407
  if (function_exists($function)) {
408
    $result = $function($cache, $type, $theme, $path);
409
    foreach ($result as $hook => $info) {
410 411 412 413 414 415 416
      // 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.
417
      $result[$hook]['type'] = $type;
418
      $result[$hook]['theme path'] = $path;
419 420

      // If function and file are omitted, default to standard naming
421
      // conventions.
422
      if (!isset($info['template']) && !isset($info['function'])) {
423
        $result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
424
      }
425

426 427
      if (isset($cache[$hook]['includes'])) {
        $result[$hook]['includes'] = $cache[$hook]['includes'];
428
      }
429 430 431 432 433

      // 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.
434 435 436 437 438
      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;
439
      }
440

441 442 443 444
      // 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);
445
      }
446 447 448 449 450 451

      // 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'];
452
        }
453
      }
454

455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476
      // 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;
477
          }
478 479 480 481
          else {
            // This applies when the theme manually registers their own variable
            // processors.
            $prefixes[] = $name;
482
          }
483 484
          foreach ($prefixes as $prefix) {
            // Only use non-hook-specific variable processors for theming hooks
485
            // implemented as templates. See theme().
486 487 488 489 490 491
            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;
            }
492
          }
493
        }
494 495 496 497 498 499 500 501 502 503 504
        // 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];
505
      }
506 507
    }

508
    // Merge the newly created theme hooks into the existing cache.
509
    $cache = $result + $cache;
510
  }
511

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

/**
539
 * Build the theme registry cache.
540 541
 *
 * @param $theme
542
 *   The loaded $theme object as returned by list_themes().
543 544 545
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
546
 * @param $theme_engine
547
 *   The name of the theme engine.
548
 */
549
function _theme_build_registry($theme, $base_theme, $theme_engine) {
550
  $cache = array();
551
  // First, process the theme hooks advertised by modules. This will
552 553 554
  // 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.
555
  if ($cached = cache()->get('theme_registry:build:modules')) {
556 557 558 559 560 561 562 563
    $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)) {
564
      cache()->set('theme_registry:build:modules', $cache);
565
    }
566 567 568 569
  }

  // Process each base theme.
  foreach ($base_theme as $base) {
570
    // If the base theme uses a theme engine, process its hooks.
571 572 573 574 575
    $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);
576 577
  }

578
  // And then the same thing, but for the theme.
579
  if ($theme_engine) {
580
    _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
581 582
  }

583 584
  // Finally, hooks provided by the theme itself.
  _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
585

586
  // Let modules alter the registry.
587
  drupal_alter('theme_registry', $cache);
588 589 590 591 592 593 594 595 596

  // 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]);
      }
    }
  }
597 598 599
  return $cache;
}

Dries's avatar
 
Dries committed
600
/**
601
 * Return a list of all currently available themes.
Dries's avatar
 
Dries committed
602
 *
603 604
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
605
 *
Dries's avatar
 
Dries committed
606
 * @param $refresh
607
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
608
 *
609
 * @return
610
 *   An associative array of the currently available themes. The keys are the
611
 *   themes' machine names and the values are objects having the following
612
 *   properties:
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
 *   - 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
643
 *     declare this theme as their base theme.
644
*/
645
function list_themes($refresh = FALSE) {
646
  $list = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
647 648

  if ($refresh) {
649
    $list = array();
650
    system_list_reset();
Dries's avatar
 
Dries committed
651 652
  }

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

    foreach ($themes as $theme) {
      foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
        foreach ($stylesheets as $stylesheet => $path) {
675
          $theme->stylesheets[$media][$stylesheet] = $path;
676
        }
677 678
      }
      foreach ($theme->info['scripts'] as $script => $path) {
679
        $theme->scripts[$script] = $path;
Dries's avatar
 
Dries committed
680
      }
681 682
      if (isset($theme->info['engine'])) {
        $theme->engine = $theme->info['engine'];
Dries's avatar
 
Dries committed
683
      }
684 685 686
      if (isset($theme->info['base theme'])) {
        $theme->base_theme = $theme->info['base theme'];
      }
687 688 689 690 691
      // 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;
      }
692
      $list[$theme->name] = $theme;
Dries's avatar
 
Dries committed
693 694 695 696 697 698
    }
  }

  return $list;
}

699 700 701 702 703 704 705 706 707 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
/**
 * 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
740
/**
741 742 743
 * Generates themed output.
 *
 * All requests for themed output must go through this function. It examines
744 745 746
 * the request and routes it to the appropriate
 * @link themeable theme function or template @endlink, by checking the theme
 * registry.
747
 *
748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
 * 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).
770 771 772 773 774 775 776 777
 *
 * 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
778 779 780
 *   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.
781 782 783 784 785 786
 * - 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
787
 *   set necessary variables for all theme hooks with template implementations.
788 789 790
 * - 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
791
 *   variables for all theme hooks with template implementations.
792 793
 * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
 *   variables specific to the particular theme hook.
794 795 796 797 798 799 800 801 802 803 804
 * - 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.
805 806 807 808 809
 * - 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.
810 811 812 813
 * - 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.
814
 * - THEME_process(&$variables, $hook):  Allows the theme to process the
815
 *   variables for all theme hooks with template implementations.
816 817 818 819
 * - 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
820
 * and process functions (the ones ending in _HOOK) are called from the
821 822 823
 * 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.
824
 *
825
 * There are two special variables that these preprocess and process functions
826 827 828 829 830 831 832 833 834 835
 * 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.
836
 *
837
 * @param $hook
838 839 840 841
 *   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
842
 *   called, but there is no implementation of that theme hook, then the 'links'
843 844 845 846 847 848 849 850
 *   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
851
 *   may also be an array, in which case the first theme hook that has an
852 853
 *   implementation is used. This allows for the code that calls theme() to
 *   explicitly specify the fallback order in a situation where using the '__'
854
 *   convention is not desired or is insufficient.
855 856 857 858
 * @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.
859 860 861
 *   Alternatively, this can be a renderable array, in which case, its
 *   properties are mapped to variables expected by the theme hook
 *   implementations.
862
 *
863
 * @return
864
 *   An HTML string representing the themed output.
865 866
 *
 * @see themeable
867 868 869
 * @see hook_theme()
 * @see template_preprocess()
 * @see template_process()
Dries's avatar
 
Dries committed
870
 */
871
function theme($hook, $variables = array()) {
872 873 874 875 876 877 878
  // 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.'));
  }

879
  $hooks = theme_get_registry(FALSE);
880

881 882
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
883 884 885 886 887 888 889 890 891
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
      if (isset($hooks[$candidate])) {
        break;
      }
    }
    $hook = $candidate;
  }

892 893
  // If there's no implementation, check for more generic fallbacks. If there's
  // still no implementation, log an error and return an empty string.
894
  if (!isset($hooks[$hook])) {
895 896 897 898 899 900 901 902 903
    // 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])) {
904 905 906
      // Only log a message when not trying theme suggestions ($hook being an
      // array).
      if (!isset($candidate)) {
907
        watchdog('theme', 'Theme hook %hook not found.', array('%hook' => $hook), WATCHDOG_WARNING);
908
      }
909 910
      return '';
    }
911 912
  }

913
  $info = $hooks[$hook];
914 915 916
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
917
  $theme_path = $info['theme path'];
Dries's avatar
 
Dries committed
918

919
  // Include a file if the theme function or variable processor is held elsewhere.
920 921 922
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
923 924
    }
  }
925 926

  // If a renderable array is passed as $variables, then set $variables to
927
  // the arguments expected by the theme function.
928 929 930
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
931 932
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {
933 934 935
        if (isset($element["#$name"])) {
          $variables[$name] = $element["#$name"];
        }
936 937
      }
    }
938 939 940
    else {
      $variables[$info['render element']] = $element;
    }
941
  }
942

943
  // Merge in argument defaults.
944 945 946 947 948
  if (!empty($info['variables'])) {
    $variables += $info['variables'];
  }
  elseif (!empty($info['render element'])) {
    $variables += array($info['render element'] => array());
949
  }
950

951
  // Invoke the variable processors, if any. The processors may specify
952 953 954 955 956 957 958
  // 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];
959 960 961 962 963 964 965
    // Include files required by the base hook, since its variable processors
    // might reside there.
    if (!empty($base_hook_info['includes'])) {
      foreach ($base_hook_info['includes'] as $include_file) {
        include_once DRUPAL_ROOT . '/' . $include_file;
      }
    }
966 967 968 969 970 971
    if (isset($base_hook_info['preprocess functions']) || isset($base_hook_info['process functions'])) {
      $variables['theme_hook_suggestion'] = $hook;
      $hook = $base_hook;
      $info = $base_hook_info;
    }
  }