theme.inc 102 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 51 52 53 54 55 56 57 58 59 60 61 62 63 64
  if (is_object($theme)) {
    return _drupal_theme_access($theme);
  }
  else {
    $themes = list_themes();
    return isset($themes[$theme]) && _drupal_theme_access($themes[$theme]);
  }
}

/**
 * Helper function for determining access to a theme.
 *
 * @see drupal_theme_access()
 */
function _drupal_theme_access($theme) {
65 66 67 68
  $admin_theme = variable_get('admin_theme');
  return !empty($theme->status) || ($admin_theme && $theme->name == $admin_theme);
}

Dries's avatar
 
Dries committed
69
/**
Dries's avatar
 
Dries committed
70
 * Initialize the theme system by loading the theme.
Dries's avatar
 
Dries committed
71
 */
72
function drupal_theme_initialize() {
73
  global $theme, $user, $theme_key;
74 75 76 77 78

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

80
  drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
Dries's avatar
 
Dries committed
81 82
  $themes = list_themes();

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

87 88
  // 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.
89
  $custom_theme = menu_get_custom_theme();
90
  $theme = !empty($custom_theme) ? $custom_theme : $theme;
Dries's avatar
 
Dries committed
91 92 93 94

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

95 96 97 98
  // Find all our ancestor themes and put them in an array.
  $base_theme = array();
  $ancestor = $theme;
  while ($ancestor && isset($themes[$ancestor]->base_theme)) {
99
    $ancestor = $themes[$ancestor]->base_theme;
100
    $base_theme[] = $themes[$ancestor];
101
  }
102
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
103 104 105

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

  // Provide the page with information about the theme that's used, so that a
108
  // later Ajax request can be rendered using the same theme.
109 110 111
  // @see ajax_base_page_theme()
  $setting['ajaxPageState'] = array(
    'theme' => $theme_key,
112
    'theme_token' => drupal_get_token($theme_key),
113 114
  );
  drupal_add_js($setting, 'setting');
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
}

/**
 * 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.
139 140
 * @param $registry_callback
 *   The callback to invoke to set the theme registry.
141
 */
142
function _drupal_theme_initialize($theme, $base_theme = array(), $registry_callback = '_theme_load_registry') {
143 144 145 146 147 148
  global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  $theme_info = $theme;
  $base_theme_info = $base_theme;

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

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
  // 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;
        }
      }
    }
  }

165 166 167
  // Add stylesheets used by this theme.
  if (!empty($theme->stylesheets)) {
    foreach ($theme->stylesheets as $media => $stylesheets) {
168 169 170 171 172 173 174 175 176
      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) {
177
      drupal_add_css($stylesheet, array('group' => CSS_THEME, 'every_page' => TRUE, 'media' => $media));
178 179 180 181 182 183 184 185 186 187 188
    }
  }

  // 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;
189
      }
Dries's avatar
 
Dries committed
190 191
    }
  }
192

193 194
  // Add scripts used by this theme.
  if (!empty($theme->scripts)) {
195 196
    foreach ($theme->scripts as $name => $script) {
      $final_scripts[$name] = $script;
197 198 199
    }
  }

200 201
  // Add scripts used by this theme.
  foreach ($final_scripts as $script) {
202
    drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
203 204
  }

205 206 207 208 209
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
210
    include_once DRUPAL_ROOT . '/' . $theme->owner;
211 212

    $theme_engine = $theme->engine;
213
    if (function_exists($theme_engine . '_init')) {
214
      foreach ($base_theme as $base) {
215
        call_user_func($theme_engine . '_init', $base);
216
      }
217
      call_user_func($theme_engine . '_init', $theme);
218 219 220 221 222 223 224
    }
  }
  else {
    // include non-engine theme files
    foreach ($base_theme as $base) {
      // Include the theme file or the engine.
      if (!empty($base->owner)) {
225
        include_once DRUPAL_ROOT . '/' . $base->owner;
226 227 228 229
      }
    }
    // and our theme gets one too.
    if (!empty($theme->owner)) {
230
      include_once DRUPAL_ROOT . '/' . $theme->owner;
Dries's avatar
 
Dries committed
231 232
    }
  }
233

234 235
  if (isset($registry_callback)) {
    _theme_registry_callback($registry_callback, array($theme, $base_theme, $theme_engine));
236
  }
Dries's avatar
 
Dries committed
237 238
}

239
/**
240
 * Get the theme registry.
241
 *
242
 * @param bool $complete
243
 *   Optional boolean to indicate whether to return the complete theme registry
244 245 246 247 248 249 250
 *   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.
251
 *
252
 * @return
253 254
 *   The complete theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
255
 */
256
function theme_get_registry($complete = TRUE) {
257 258 259 260 261 262 263 264 265 266 267 268 269 270
  // 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();
  }

271
  $key = (int) $complete;
272

273
  if (!isset($theme_registry[$key])) {
274
    list($callback, $arguments) = _theme_registry_callback();
275 276 277 278
    if (!$complete) {
      $arguments[] = FALSE;
    }
    $theme_registry[$key] = call_user_func_array($callback, $arguments);
279 280
  }

281
  return $theme_registry[$key];
282 283 284
}

/**
285
 * Set the callback that will be used by theme_get_registry() to fetch the registry.
286
 *
287 288 289 290
 * @param $callback
 *   The name of the callback function.
 * @param $arguments
 *   The arguments to pass to the function.
291
 */
292 293 294 295
function _theme_registry_callback($callback = NULL, array $arguments = array()) {
  static $stored;
  if (isset($callback)) {
    $stored = array($callback, $arguments);
296
  }
297
  return $stored;
298 299 300
}

/**
301
 * Get the theme_registry cache; if it doesn't exist, build it.
302 303
 *
 * @param $theme
304
 *   The loaded $theme object as returned by list_themes().
305 306 307
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
308
 * @param $theme_engine
309
 *   The name of the theme engine.
310 311
 * @param $complete
 *   Whether to load the complete theme registry or an instance of the
312
 *   Drupal\Core\Utility\ThemeRegistry class.
313 314
 *
 * @return
315 316
 *   The theme registry array, or an instance of the
 *   Drupal\Core\Utility\ThemeRegistry class.
317
 */
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
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;
335 336
  }
  else {
337
    return new ThemeRegistry('theme_registry:runtime:' . $theme->name, 'cache');
338 339 340 341 342 343 344
  }
}

/**
 * Write the theme_registry cache into the database.
 */
function _theme_save_registry($theme, $registry) {
345
  cache()->set("theme_registry:$theme->name", $registry);
346 347 348 349 350 351 352
}

/**
 * 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.
 */
353
function drupal_theme_rebuild() {
354
  drupal_static_reset('theme_get_registry');
355
  cache()->deletePrefix('theme_registry');
356 357 358
}

/**
359
 * Process a single implementation of hook_theme().
360
 *
361 362 363 364
 * @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:
365 366
 *   - 'type': The passed-in $type.
 *   - 'theme path': The passed-in $path.
367 368 369 370 371 372 373 374 375
 *   - '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.
376 377
 *   - 'variables': The variables for this theme hook as defined in
 *     hook_theme(). If there is more than one implementation and 'variables' is
378
 *     not specified in a later one, then the previous definition is kept.
379 380 381 382
 *   - '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.
383
 *   - 'preprocess functions': See theme() for detailed documentation.
384
 *   - 'process functions': See theme() for detailed documentation.
385 386 387 388 389 390 391 392 393 394 395 396 397 398
 * @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
399
 *   themes/bartik.
400
 *
401 402 403 404
 * @see theme()
 * @see _theme_process_registry()
 * @see hook_theme()
 * @see list_themes()
405
 */
406
function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
407
  $result = array();
408

409
  // Processor functions work in two distinct phases with the process
410
  // functions always being executed after the preprocess functions.
411
  $variable_process_phases = array(
412 413 414 415
    'preprocess functions' => 'preprocess',
    'process functions'    => 'process',
  );

416 417 418 419 420 421 422 423 424 425
  $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';
426
  if (function_exists($function)) {
427
    $result = $function($cache, $type, $theme, $path);
428
    foreach ($result as $hook => $info) {
429 430 431 432 433 434 435
      // 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.
436
      $result[$hook]['type'] = $type;
437
      $result[$hook]['theme path'] = $path;
438 439

      // If function and file are omitted, default to standard naming
440
      // conventions.
441
      if (!isset($info['template']) && !isset($info['function'])) {
442
        $result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
443
      }
444

445 446
      if (isset($cache[$hook]['includes'])) {
        $result[$hook]['includes'] = $cache[$hook]['includes'];
447
      }
448 449 450 451 452

      // 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.
453 454 455 456 457
      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;
458
      }
459

460 461 462 463
      // 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);
464
      }
465 466 467 468 469 470

      // 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'];
471
        }
472
      }
473

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
      // 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;
496
          }
497 498 499 500
          else {
            // This applies when the theme manually registers their own variable
            // processors.
            $prefixes[] = $name;
501
          }
502 503
          foreach ($prefixes as $prefix) {
            // Only use non-hook-specific variable processors for theming hooks
504
            // implemented as templates. See theme().
505 506 507 508 509 510
            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;
            }
511
          }
512
        }
513 514 515 516 517 518 519 520 521 522 523
        // 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];
524
      }
525 526
    }

527
    // Merge the newly created theme hooks into the existing cache.
528
    $cache = $result + $cache;
529
  }
530

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

/**
558
 * Build the theme registry cache.
559 560
 *
 * @param $theme
561
 *   The loaded $theme object as returned by list_themes().
562 563 564
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
565
 * @param $theme_engine
566
 *   The name of the theme engine.
567
 */
568
function _theme_build_registry($theme, $base_theme, $theme_engine) {
569
  $cache = array();
570
  // First, process the theme hooks advertised by modules. This will
571 572 573
  // 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.
574
  if ($cached = cache()->get('theme_registry:build:modules')) {
575 576 577 578 579 580 581 582
    $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)) {
583
      cache()->set('theme_registry:build:modules', $cache);
584
    }
585 586 587 588
  }

  // Process each base theme.
  foreach ($base_theme as $base) {
589
    // If the base theme uses a theme engine, process its hooks.
590 591 592 593 594
    $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);
595 596
  }

597
  // And then the same thing, but for the theme.
598
  if ($theme_engine) {
599
    _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
600 601
  }

602 603
  // Finally, hooks provided by the theme itself.
  _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
604

605
  // Let modules alter the registry.
606
  drupal_alter('theme_registry', $cache);
607 608 609 610 611 612 613 614 615

  // 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]);
      }
    }
  }
616 617 618
  return $cache;
}

Dries's avatar
 
Dries committed
619
/**
620
 * Return a list of all currently available themes.
Dries's avatar
 
Dries committed
621
 *
622 623
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
624
 *
Dries's avatar
 
Dries committed
625
 * @param $refresh
626
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
627
 *
628
 * @return
629 630 631 632
 *   An associative array of the currently available themes. The keys are the
 *   names of the themes and the values are objects having the following
 *   properties:
 *   - 'filename': The name of the .info file.
633
 *   - 'name': The machine name of the theme.
634 635 636 637 638
 *   - '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
639
 *     (e.g. themes/bartik/style.css).
640 641 642
 *   - 'scripts': An associative array of JavaScripts, using the filename as key
 *     and the complete filepath as value.
 *   - 'engine': The name of the theme engine.
643 644 645 646
 *   - 'base_theme': The name of the base theme.
 *   - 'base_themes': An ordered array of all the base themes. If the first item
 *     is NULL, a base theme is missing for this theme.
 *   - 'sub_themes': An unordered array of sub-themes of this theme.
Dries's avatar
 
Dries committed
647
 */
648
function list_themes($refresh = FALSE) {
649
  $list = &drupal_static(__FUNCTION__, array());
Dries's avatar
 
Dries committed
650 651

  if ($refresh) {
652
    $list = array();
653
    system_list_reset();
Dries's avatar
 
Dries committed
654 655
  }

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

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

  return $list;
}

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

860
  $hooks = theme_get_registry(FALSE);
861

862 863
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
864 865 866 867 868 869 870 871 872
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
      if (isset($hooks[$candidate])) {
        break;
      }
    }
    $hook = $candidate;
  }

873 874
  // If there's no implementation, check for more generic fallbacks. If there's
  // still no implementation, log an error and return an empty string.
875
  if (!isset($hooks[$hook])) {
876 877 878 879 880 881 882 883 884
    // 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])) {
885 886 887
      // Only log a message when not trying theme suggestions ($hook being an
      // array).
      if (!isset($candidate)) {
888
        watchdog('theme', 'Theme key "@key" not found.', array('@key' => $hook), WATCHDOG_WARNING);
889
      }
890 891
      return '';
    }
892 893
  }

894
  $info = $hooks[$hook];
895 896 897
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
898
  $theme_path = $info['theme path'];
Dries's avatar
 
Dries committed
899

900
  // Include a file if the theme function or variable processor is held elsewhere.
901 902 903
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
904 905
    }
  }
906 907

  // If a renderable array is passed as $variables, then set $variables to
908
  // the arguments expected by the theme function.
909 910 911
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
912 913
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {
914 915 916
        if (isset($element["#$name"])) {
          $variables[$name] = $element["#$name"];
        }
917 918
      }
    }
919 920 921
    else {
      $variables[$info['render element']] = $element;
    }
922
  }
923

924
  // Merge in argument defaults.
925 926 927 928 929
  if (!empty($info['variables'])) {
    $variables += $info['variables'];
  }
  elseif (!empty($info['render element'])) {
    $variables += array($info['render element'] => array());
930
  }
931

932
  // Invoke the variable processors, if any. The processors may specify
933 934 935 936 937 938 939
  // 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];
940 941 942 943 944 945 946
    // 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;
      }
    }
947 948 949 950 951 952
    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;
    }
  }
953
  if (isset($info['preprocess functions']) || isset($info['process functions'])) {
954
    $variables['theme_hook_suggestions'] = array();
955 956 957 958 959 960 961
    foreach (array('preprocess functions', 'process functions') as $phase) {
      if (!empty($info[$phase])) {
        foreach ($info[$phase] as $processor_function) {
          if (function_exists($processor_function)) {
            // We don't want a poorly behaved process function changing $hook.
            $hook_clone = $hook;
            $processor_function($variables, $hook_clone);
962 963 964
          }
        }
      }
965
    }
966 967 968 969 970 971 972 973 974 975 976 977
    // If the preprocess/process functions specified hook suggestions, and the
    // suggestion exists in the theme registry, use it instead of the hook that
    // theme() was called with. This allows the preprocess/process step to
    // route to a more specific theme hook. For example, a function may call
    // theme('node', ...), but a preprocess function can add 'node__article' as
    // a suggestion, enabling a theme to have an alternate template file for
    // article nodes. Suggestions are checked in the following order:
    // - The 'theme_hook_suggestion' variable is checked first. It overrides
    //   all others.
    // - The 'theme_hook_suggestions' variable is checked in FILO order, so the
    //   last suggestion added to the array takes precedence over suggestions
    //   added earlier.
978
    $suggestions = array();
979 980
    if (!empty($variables['theme_hook_suggestions'])) {
      $suggestions = $variables['theme_hook_suggestions'];