theme.inc 91.7 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
2
// $Id$
Dries's avatar
   
Dries committed
3

4
/**
Dries's avatar
   
Dries committed
5
 * @file
6
 * The theme system, which controls the output of Drupal.
Dries's avatar
   
Dries committed
7
8
9
10
 *
 * The theme system allows for nearly all output of the Drupal system to be
 * customized by user themes.
 *
11
 * @ingroup themeable
Dries's avatar
   
Dries committed
12
 */
Dries's avatar
   
Dries committed
13

14
/**
15
16
17
18
19
 * @name Content markers
 * @{
 * Markers used by theme_mark() and node_mark() to designate content.
 * @see theme_mark(), node_mark()
 */
20
21
22
23
24
25
26
27
28
29
30
31
32
33

/**
 * Mark content as read.
 */
define('MARK_READ', 0);

/**
 * Mark content as being new.
 */
define('MARK_NEW', 1);

/**
 * Mark content as being updated.
 */
34
define('MARK_UPDATED', 2);
35

36
37
38
39
/**
 * @} End of "Content markers".
 */

40
41
42
43
44
45
46
47
48
49
50
51
52
53
/**
 * Determines if a theme is available to use.
 *
 * @param $theme
 *   An object representing the theme to check.
 * @return
 *   Boolean TRUE if the theme is enabled or is the site administration theme;
 *   FALSE otherwise.
 */
function drupal_theme_access($theme) {
  $admin_theme = variable_get('admin_theme');
  return !empty($theme->status) || ($admin_theme && $theme->name == $admin_theme);
}

Dries's avatar
   
Dries committed
54
/**
Dries's avatar
   
Dries committed
55
 * Initialize the theme system by loading the theme.
Dries's avatar
   
Dries committed
56
 */
57
function drupal_theme_initialize() {
58
  global $theme, $user, $theme_key;
59
60
61
62
63

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

65
  drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
Dries's avatar
   
Dries committed
66
67
  $themes = list_themes();

68
  // Only select the user selected theme if it is available in the
69
70
  // list of themes that can be accessed.
  $theme = !empty($user->theme) && isset($themes[$user->theme]) && drupal_theme_access($themes[$user->theme]) ? $user->theme : variable_get('theme_default', 'garland');
Dries's avatar
   
Dries committed
71
72

  // Allow modules to override the present theme... only select custom theme
73
74
75
  // if it is available in the list of themes that can be accessed.
  $custom_theme = menu_get_custom_theme();
  $theme = $custom_theme && isset($themes[$custom_theme]) && drupal_theme_access($themes[$custom_theme]) ? $custom_theme : $theme;
Dries's avatar
   
Dries committed
76
77
78
79

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

80
81
82
83
  // Find all our ancestor themes and put them in an array.
  $base_theme = array();
  $ancestor = $theme;
  while ($ancestor && isset($themes[$ancestor]->base_theme)) {
84
85
    $base_theme[] = $new_base_theme = $themes[$themes[$ancestor]->base_theme];
    $ancestor = $themes[$ancestor]->base_theme;
86
  }
87
  _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
88
89
90

  // Themes can have alter functions, so reset the drupal_alter() cache.
  drupal_static_reset('drupal_alter');
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
}

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

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

125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
  // 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;
        }
      }
    }
  }

141
142
143
  // Add stylesheets used by this theme.
  if (!empty($theme->stylesheets)) {
    foreach ($theme->stylesheets as $media => $stylesheets) {
144
145
146
147
148
149
150
151
152
      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) {
153
      drupal_add_css($stylesheet, array('weight' => CSS_THEME, 'media' => $media));
154
155
156
157
158
159
160
161
162
163
164
    }
  }

  // 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;
165
      }
Dries's avatar
   
Dries committed
166
167
    }
  }
168

169
170
  // Add scripts used by this theme.
  if (!empty($theme->scripts)) {
171
172
    foreach ($theme->scripts as $name => $script) {
      $final_scripts[$name] = $script;
173
174
175
    }
  }

176
177
  // Add scripts used by this theme.
  foreach ($final_scripts as $script) {
178
    drupal_add_js($script, array('weight' => JS_THEME));
179
180
  }

181
182
183
184
185
  $theme_engine = NULL;

  // Initialize the theme.
  if (isset($theme->engine)) {
    // Include the engine.
186
    include_once DRUPAL_ROOT . '/' . $theme->owner;
187
188

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

210
  if (function_exists($registry_callback)) {
211
212
    $registry_callback($theme, $base_theme, $theme_engine);
  }
Dries's avatar
   
Dries committed
213
214
}

215
/**
216
 * Get the theme registry.
217
218
 * @return
 *   The theme registry array if it has been stored in memory, NULL otherwise.
219
 */
220
221
function theme_get_registry() {
  return _theme_set_registry();
222
223
224
225
}

/**
 * Store the theme registry in memory.
226
227
 * @param $registry
 *   A registry array as returned by _theme_build_registry()
228
 * @return
229
 *   The theme registry array stored in memory
230
 */
231
232
function _theme_set_registry($registry = NULL) {
  static $theme_registry = NULL;
233

234
235
236
  if (isset($registry)) {
    $theme_registry = $registry;
  }
237

238
  return $theme_registry;
239
240
241
}

/**
242
 * Get the theme_registry cache from the database; if it doesn't exist, build it.
243
244
 *
 * @param $theme
245
 *   The loaded $theme object as returned by list_themes().
246
247
248
249
250
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
 * @param theme_engine
 *   The name of the theme engine.
251
 */
252
253
254
function _theme_load_registry($theme, $base_theme = NULL, $theme_engine = NULL) {
  // Check the theme registry cache; if it exists, use it.
  $cache = cache_get("theme_registry:$theme->name", 'cache');
255
  if (isset($cache->data)) {
256
    $registry = $cache->data;
257
    _theme_set_registry($registry);
258
259
  }
  else {
260
261
    // If not, build one and cache it.
    $registry = _theme_build_registry($theme, $base_theme, $theme_engine);
262
   // Only persist this registry if all modules are loaded. This assures a
263
   // complete set of theme hooks.
264
    if (module_load_all(NULL)) {
265
266
267
      _theme_save_registry($theme, $registry);
      _theme_set_registry($registry);
    }
268
269
270
271
272
273
274
  }
}

/**
 * Write the theme_registry cache into the database.
 */
function _theme_save_registry($theme, $registry) {
275
  cache_set("theme_registry:$theme->name", $registry);
276
277
278
279
280
281
282
}

/**
 * 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.
 */
283
function drupal_theme_rebuild() {
284
285
286
287
  cache_clear_all('theme_registry', 'cache', TRUE);
}

/**
288
 * Process a single implementation of hook_theme().
289
 *
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 * @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:
 *   - 'type': The passed in $type.
 *   - 'theme path': The passed in $path.
 *   - '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.
305
306
 *   - 'variables': The variables for this theme hook as defined in
 *     hook_theme(). If there is more than one implementation and 'variables' is
307
 *     not specified in a later one, then the previous definition is kept.
308
309
310
311
 *   - '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.
312
 *   - 'theme paths': The paths where implementations of a theme hook can be
313
 *     found. Its definition is similarly inherited like 'variables'. Each time
314
315
316
 *     _theme_process_registry() is called for this theme hook, either the
 *     'path' key from hook_theme() (if defined) or $path is added.
 *   - 'preprocess functions': See theme() for detailed documentation.
317
 *   - 'process functions': See theme() for detailed documentation.
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 * @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
 *   themes/garland.
333
 *
334
335
336
337
 * @see theme()
 * @see _theme_process_registry()
 * @see hook_theme()
 * @see list_themes()
338
 */
339
function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
340
  $result = array();
341
  $function = $name . '_theme';
342

343
  // Processor functions work in two distinct phases with the process
344
  // functions always being executed after the preprocess functions.
345
  $variable_process_phases = array(
346
347
348
349
    'preprocess functions' => 'preprocess',
    'process functions'    => 'process',
  );

350
  if (function_exists($function)) {
351
    $result = $function($cache, $type, $theme, $path);
352
353
    foreach ($result as $hook => $info) {
      $result[$hook]['type'] = $type;
354
      $result[$hook]['theme path'] = $path;
355
356
      // if function and file are left out, default to standard naming
      // conventions.
357
      if (!isset($info['template']) && !isset($info['function'])) {
358
        $result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
359
      }
360
361
362
363
364
      // If a path is set in the info, use what was set. Otherwise use the
      // default path. This is mostly so system.module can declare theme
      // functions on behalf of core .include files.
      // All files are included to be safe. Conditionally included
      // files can prevent them from getting registered.
365
366
      if (isset($cache[$hook]['includes'])) {
        $result[$hook]['includes'] = $cache[$hook]['includes'];
367
      }
368
369
370
371
372
      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;
373
      }
374

375
      // If 'variables' have been defined previously, carry them forward.
376
377
      // This should happen if a theme overrides a Drupal defined theme
      // function, for example.
378
379
380
381
382
383
      if (!isset($info['variables']) && isset($cache[$hook]['variables'])) {
        $result[$hook]['variables'] = $cache[$hook]['variables'];
      }
      // Same for 'render element'.
      if (!isset($info['render element']) && isset($cache[$hook]['render element'])) {
        $result[$hook]['render element'] = $cache[$hook]['render element'];
384
      }
385
386
387
388
389
390

      // 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'];
391
392
        }

393
394
395
396
397
398
399
        // These are used for template naming suggestions. Theme implementations
        // can occur in multiple paths. Suggestions should follow.
        if (!isset($info['theme paths']) && isset($cache[$hook])) {
          $result[$hook]['theme paths'] = $cache[$hook]['theme paths'];
        }
        // Check for sub-directories.
        $result[$hook]['theme paths'][] = isset($info['path']) ? $info['path'] : $path;
400
      }
401

402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
      // 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;
424
          }
425
426
427
428
          else {
            // This applies when the theme manually registers their own variable
            // processors.
            $prefixes[] = $name;
429
          }
430
431
432
433
434
435
436
437
438
          foreach ($prefixes as $prefix) {
            // Only use non-hook-specific variable processors for theming hooks
            // implemented as templates. @see theme().
            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;
            }
439
          }
440
        }
441
442
443
444
445
446
447
448
449
450
451
        // 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];
452
      }
453
454
    }

455
    // Merge the newly created theme hooks into the existing cache.
456
457
    $cache = array_merge($cache, $result);
  }
458

459
  // Let themes have variable processors even if they didn't register a template.
460
461
  if ($type == 'theme' || $type == 'base_theme') {
    foreach ($cache as $hook => $info) {
462
463
464
      // Check only if not registered by the theme or engine.
      if (empty($result[$hook])) {
        foreach ($variable_process_phases as $phase_key => $phase) {
465
466
467
          if (!isset($info[$phase_key])) {
            $cache[$hook][$phase_key] = array();
          }
468
469
470
471
          // Only use non-hook-specific variable processors for theming hooks
          // implemented as templates. @see theme().
          if (isset($info['template']) && function_exists($name . '_' . $phase)) {
            $cache[$hook][$phase_key][] = $name . '_' . $phase;
472
          }
473
474
          if (function_exists($name . '_' . $phase . '_' . $hook)) {
            $cache[$hook][$phase_key][] = $name . '_' . $phase . '_' . $hook;
475
476
477
          }
          // Ensure uniqueness.
          $cache[$hook][$phase_key] = array_unique($cache[$hook][$phase_key]);
478
479
480
481
        }
      }
    }
  }
482
483
484
}

/**
485
 * Rebuild the theme registry cache.
486
487
 *
 * @param $theme
488
 *   The loaded $theme object as returned by list_themes().
489
490
491
492
493
 * @param $base_theme
 *   An array of loaded $theme objects representing the ancestor themes in
 *   oldest first order.
 * @param theme_engine
 *   The name of the theme engine.
494
 */
495
function _theme_build_registry($theme, $base_theme, $theme_engine) {
496
  $cache = array();
497
498
  // First, process the theme hooks advertised by modules. This will
  // serve as the basic registry.
499
  foreach (module_implements('theme') as $module) {
500
501
502
503
504
    _theme_process_registry($cache, $module, 'module', $module, drupal_get_path('module', $module));
  }

  // Process each base theme.
  foreach ($base_theme as $base) {
505
    // If the base theme uses a theme engine, process its hooks.
506
507
508
509
510
    $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);
511
512
  }

513
  // And then the same thing, but for the theme.
514
  if ($theme_engine) {
515
    _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
516
517
  }

518
519
  // Finally, hooks provided by the theme itself.
  _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
520

521
  // Let modules alter the registry.
522
  drupal_alter('theme_registry', $cache);
523
524
525
526
527
528
529
530
531

  // 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]);
      }
    }
  }
532
533
534
  return $cache;
}

Dries's avatar
   
Dries committed
535
/**
536
 * Return a list of all currently available themes.
Dries's avatar
   
Dries committed
537
 *
538
539
 * Retrieved from the database, if available and the site is not in maintenance
 * mode; otherwise compiled freshly from the filesystem.
540
 *
Dries's avatar
   
Dries committed
541
 * @param $refresh
542
 *   Whether to reload the list of themes from the database. Defaults to FALSE.
543
 * @return
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 *   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.
 *   - 'name': The 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/garland/style.css).
 *   - 'scripts': An associative array of JavaScripts, using the filename as key
 *     and the complete filepath as value.
 *   - 'engine': The name of the theme engine.
 *   - 'base theme': The name of the base theme.
Dries's avatar
   
Dries committed
559
 */
560
function list_themes($refresh = FALSE) {
561
  static $list = array();
Dries's avatar
   
Dries committed
562
563

  if ($refresh) {
564
    $list = array();
565
    system_list_reset();
Dries's avatar
   
Dries committed
566
567
  }

568
  if (empty($list)) {
Dries's avatar
   
Dries committed
569
    $list = array();
570
571
    $themes = array();
    // Extract from the database only when it is available.
572
573
    // Also check that the site is not in the middle of an install or update.
    if (db_is_active() && !defined('MAINTENANCE_MODE')) {
574
      foreach (system_list('theme') as $theme) {
575
576
577
        if (file_exists($theme->filename)) {
          $theme->info = unserialize($theme->info);
          $themes[] = $theme;
578
        }
579
580
581
      }
    }
    else {
582
      // Scan the installation when the database should not be read.
583
      $themes = _system_rebuild_theme_data();
584
585
586
587
588
    }

    foreach ($themes as $theme) {
      foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
        foreach ($stylesheets as $stylesheet => $path) {
589
          $theme->stylesheets[$media][$stylesheet] = $path;
590
        }
591
592
593
594
      }
      foreach ($theme->info['scripts'] as $script => $path) {
        if (file_exists($path)) {
          $theme->scripts[$script] = $path;
595
        }
Dries's avatar
   
Dries committed
596
      }
597
598
      if (isset($theme->info['engine'])) {
        $theme->engine = $theme->info['engine'];
Dries's avatar
   
Dries committed
599
      }
600
601
602
      if (isset($theme->info['base theme'])) {
        $theme->base_theme = $theme->info['base theme'];
      }
603
604
605
606
607
      // 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;
      }
608
      $list[$theme->name] = $theme;
Dries's avatar
   
Dries committed
609
610
611
612
613
614
    }
  }

  return $list;
}

Dries's avatar
   
Dries committed
615
/**
616
617
618
619
620
621
622
 * Generate the themed output.
 *
 * All requests for theme hooks must go through this function. It examines
 * the request and routes it to the appropriate theme function. The theme
 * registry is checked to determine which implementation to use, which may
 * be a function or a template.
 *
623
624
625
626
 * If the implementation is a template, the following functions may be used to
 * modify the $variables array. They are processed in two distinct phases;
 * "preprocess" and "process" functions. The order listed here is the order in
 * which they execute.
627
 *
628
629
 * - template_preprocess(&$variables)
 *   This sets a default set of variables for all template implementations.
630
 *
631
632
633
 * - template_preprocess_HOOK(&$variables)
 *   This is the first preprocessor called specific to the hook; it should be
 *   implemented by the module that registers it.
634
 *
635
636
637
 * - MODULE_preprocess(&$variables)
 *   This will be called for all templates; it should only be used if there
 *   is a real need. It's purpose is similar to template_preprocess().
638
 *
639
640
641
 * - MODULE_preprocess_HOOK(&$variables)
 *   This is for modules that want to alter or provide extra variables for
 *   theming hooks not registered to itself. For example, if a module named
642
 *   "foo" wanted to alter the $classes_array variable for the hook "node" a
643
644
 *   preprocess function of foo_preprocess_node() can be created to intercept
 *   and alter the variable.
645
 *
646
647
648
 * - ENGINE_engine_preprocess(&$variables)
 *   This function should only be implemented by theme engines and exists
 *   so that it can set necessary variables for all hooks.
649
 *
650
651
652
653
654
 * - ENGINE_engine_preprocess_HOOK(&$variables)
 *   This is the same as the previous function, but it is called for a single
 *   theming hook.
 *
 * - THEME_preprocess(&$variables)
655
 *   This is for themes that want to alter or provide extra variables. For
656
657
 *   example, if a theme named "foo" wanted to alter the $classes_array variable
 *   for the hook "node" a preprocess function of foo_preprocess_node() can be
658
 *   created to intercept and alter the variable.
659
 *
660
661
662
 * - THEME_preprocess_HOOK(&$variables)
 *   The same applies from the previous function, but it is called for a
 *   specific hook.
Dries's avatar
   
Dries committed
663
 *
664
665
666
667
668
669
670
671
672
673
674
675
676
677
 * - template_process(&$variables)
 *   This sets a default set of variables for all template implementations.
 *
 * - template_process_HOOK(&$variables)
 *   This is the first processor called specific to the hook; it should be
 *   implemented by the module that registers it.
 *
 * - MODULE_process(&$variables)
 *   This will be called for all templates; it should only be used if there
 *   is a real need. It's purpose is similar to template_process().
 *
 * - MODULE_process_HOOK(&$variables)
 *   This is for modules that want to alter or provide extra variables for
 *   theming hooks not registered to itself. For example, if a module named
678
 *   "foo" wanted to alter the $classes_array variable for the hook "node" a
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 *   process function of foo_process_node() can be created to intercept
 *   and alter the variable.
 *
 * - ENGINE_engine_process(&$variables)
 *   This function should only be implemented by theme engines and exists
 *   so that it can set necessary variables for all hooks.
 *
 * - ENGINE_engine_process_HOOK(&$variables)
 *   This is the same as the previous function, but it is called for a single
 *   theming hook.
 *
 * - ENGINE_process(&$variables)
 *   This is meant to be used by themes that utilize a theme engine. It is
 *   provided so that the processor is not locked into a specific theme.
 *   This makes it easy to share and transport code but theme authors must be
 *   careful to prevent fatal re-declaration errors when using sub-themes that
 *   have their own processor named exactly the same as its base theme. In
 *   the default theme engine (PHPTemplate), sub-themes will load their own
 *   template.php file in addition to the one used for its parent theme. This
 *   increases the risk for these errors. A good practice is to use the engine
 *   name for the base theme and the theme name for the sub-themes to minimize
 *   this possibility.
 *
 * - ENGINE_process_HOOK(&$variables)
 *   The same applies from the previous function, but it is called for a
 *   specific hook.
 *
 * - THEME_process(&$variables)
 *   These functions are based upon the raw theme; they should primarily be
 *   used by themes that do not use an engine or by sub-themes. It serves the
 *   same purpose as ENGINE_process().
 *
 * - THEME_process_HOOK(&$variables)
 *   The same applies from the previous function, but it is called for a
 *   specific hook.
 *
715
716
 * If the implementation is a function, only the hook-specific preprocess
 * and process functions (the ones ending in _HOOK) are called from the
717
718
719
 * above list. This is because theme hooks with function implementations
 * need to be fast, and calling the non-hook-specific preprocess and process
 * functions for them would incur a noticeable performance penalty.
720
721
722
 *
 * For template-implemented theme hooks, there are two special variables that
 * these preprocess and process functions can set:
723
724
725
726
 *   'template_file' and 'template_files'. These will be merged together
 *   to form a list of 'suggested' alternate template files to use, in
 *   reverse order of priority. template_file will always be a higher
 *   priority than items in template_files. theme() will then look for these
727
728
729
730
731
732
733
734
735
736
737
738
 *   files, one at a time, and use the first one that exists. If none exists,
 *   theme() will use the original registered file for the theme hook.
 *
 * For function-implemented theme hooks, there are two special variables that
 * these preprocess and process functions can set:
 *   'theme_function' and 'theme_functions'. These will be merged together
 *   to form a list of 'suggested' alternate functions to use, in
 *   reverse order of priority. theme_function will always be a higher
 *   priority than items in theme_functions. theme() will then call the
 *   highest priority function that exists. If none exists, theme() will call
 *   the original registered function for the theme hook.
 *
739
 * @param $hook
740
741
742
743
744
745
 *   The name of the theme function to call. May be an array, in which
 *   case the first hook that actually has an implementation registered
 *   will be used. This can be used to choose 'fallback' theme implementations,
 *   so that if the specific theme hook isn't implemented anywhere, a more
 *   generic one will be used. This can allow themes to create specific theme
 *   implementations for named objects.
746
747
748
749
750
751
752
753
 *
 * @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.
 *   Alternatively, this can be a renderable array, in which case, its properties
 *   are mapped to variables expected by the theme hook implementations.
 *
754
755
 * @return
 *   An HTML string that generates the themed output.
Dries's avatar
   
Dries committed
756
 */
757
function theme($hook, $variables = array()) {
758
759
  static $hooks = NULL;
  if (!isset($hooks)) {
760
    drupal_theme_initialize();
761
    $hooks = theme_get_registry();
762
  }
763

764
765
  // If an array of hook candidates were passed, use the first one that has an
  // implementation.
766
767
768
769
770
771
772
773
774
  if (is_array($hook)) {
    foreach ($hook as $candidate) {
      if (isset($hooks[$candidate])) {
        break;
      }
    }
    $hook = $candidate;
  }

775
  if (!isset($hooks[$hook])) {
776
    watchdog('theme', 'Theme key "@key" not found.', array('@key' => $hook), WATCHDOG_WARNING);
777
    return '';
778
779
  }

780
  $info = $hooks[$hook];
781
782
783
  global $theme_path;
  $temp = $theme_path;
  // point path_to_theme() to the currently used theme path:
784
  $theme_path = $info['theme path'];
Dries's avatar
   
Dries committed
785

786
  // Include a file if the theme function or variable processor is held elsewhere.
787
788
789
  if (!empty($info['includes'])) {
    foreach ($info['includes'] as $include_file) {
      include_once DRUPAL_ROOT . '/' . $include_file;
790
791
    }
  }
792
793

  // If a renderable array is passed as $variables, then set $variables to
794
  // the arguments expected by the theme function.
795
796
797
  if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
    $element = $variables;
    $variables = array();
798
799
    if (isset($info['variables'])) {
      foreach (array_keys($info['variables']) as $name) {
800
801
802
        if (isset($element["#$name"])) {
          $variables[$name] = $element["#$name"];
        }
803
804
      }
    }
805
806
807
    else {
      $variables[$info['render element']] = $element;
    }
808
  }
809

810
  // Merge in argument defaults.
811
812
813
814
815
  if (!empty($info['variables'])) {
    $variables += $info['variables'];
  }
  elseif (!empty($info['render element'])) {
    $variables += array($info['render element'] => array());
816
  }
817

818
819
820
821
822
823
824
825
826
827
828
829
  // Invoke the variable processors, if any. The processors may specify
  // alternate suggestions for which function/template should be used.
  if (isset($info['preprocess functions']) || isset($info['process functions'])) {
    $variables['theme_functions'] = array();
    $variables['template_files'] = array();
    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);
830
831
832
          }
        }
      }
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
    }
    // Function suggestion takes priority over template suggestion.
    // theme_function takes priority over theme_functions.
    // theme_functions are in FILO order (least appropriate to most appropriate).
    // Here, just look for function suggestions. Deal with template
    // suggestions only after determining that the theme call is a template.
    $suggestions = array();
    if (!empty($variables['theme_functions'])) {
      $suggestions = $variables['theme_functions'];
    }
    if (!empty($variables['theme_function'])) {
      $suggestions[] = $variables['theme_function'];
    }
    foreach (array_reverse($suggestions) as $suggestion) {
      if (function_exists($suggestion)) {
        $info['function'] = $suggestion;
        break;
850
      }
851
    }
852
  }
853

854
855
  // Generate the output using either a function or a template.
  if (isset($info['function'])) {
856
    if (function_exists($info['function'])) {
857
      $output = $info['function']($variables);
Dries's avatar
   
Dries committed
858
    }
Dries's avatar
   
Dries committed
859
  }
860
  else {
861
    // Default render function and extension.
862
863
864
865
866
867
868
869
    $render_function = 'theme_render_template';
    $extension = '.tpl.php';

    // Run through the theme engine variables, if necessary
    global $theme_engine;
    if (isset($theme_engine)) {
      // If theme or theme engine is implementing this, it may have
      // a different extension and a different renderer.
870
      if ($info['type'] != 'module') {
871
872
        if (function_exists($theme_engine . '_render_template')) {
          $render_function = $theme_engine . '_render_template';
873
        }
874
        $extension_function = $theme_engine . '_extension';
875
876
877
878
879
880
        if (function_exists($extension_function)) {
          $extension = $extension_function();
        }
      }
    }

881
882
883
884
885
    // Find which template file exists and can be used. Priority order is:
    // 1. $variables['template_file'].
    // 2. $variables['template_files'] in FILO order (later in array is higher
    //    priority).
    // 3. $info['template'].
886
887
888
889
890
891
892
893
    $suggestions = array();
    if (isset($variables['template_files'])) {
      $suggestions = $variables['template_files'];
    }
    if (isset($variables['template_file'])) {
      $suggestions[] = $variables['template_file'];
    }
    if ($suggestions) {
894
      $template_file = drupal_discover_template($info['theme paths'], $suggestions, $extension);
895
896
    }
    if (empty($template_file)) {
897
898
      $template_file = $info['template'] . $extension;
      if (isset($info['path'])) {
899
        $template_file = $info['path'] . '/' . $template_file;
900
901
      }
    }
902
903

    // Render the output using the found template file.
904
    $output = $render_function($template_file, $variables);
Dries's avatar
   
Dries committed
905
  }
906

907
908
909
  // restore path_to_theme()
  $theme_path = $temp;
  return $output;
910
911
912
}

/**
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
 * Determine and return which template file will generate the output.
 *
 * This helper allows the theme system to pick the template at runtime instead
 * of build time.
 *
 * @see template_page_suggestions()
 * @see template_preprocess_block()
 *
 * @param $paths
 *   The paths where templates can be found. See _theme_process_registry()
 *   'theme paths' for more information.
 * @param $suggestions
 *   The possible template names. These are derived from
 *   $variables['template_files'] and $variables['template_file], defined by
 *   preprocess functions. Each file is checked on every path in the order of
 *   precedence defined by theme().
 * @return
 *   The filepath to the template that will generate the output. If none is
 *   found, then theme() will use the 'template' as set by
 *   _theme_process_registry().
 *
 * @see _theme_process_registry()
 * @see theme()
936
 */
937
function drupal_discover_template($paths, $suggestions, $extension = '.tpl.php') {
938
939
  global $theme_engine;

940
941
942
943
  // Remove slashes or null to prevent files from being included from
  // an unexpected location (especially on Windows servers).
  $extension = str_replace(array("/", "\\", "\0"), '', $extension);

944
  // Loop through all paths and suggestions in FIFO order.
945
  $suggestions = array_reverse($suggestions);
946
  $paths = array_reverse($paths);
947
  foreach ($suggestions as $suggestion) {
948
    if (!empty($suggestion)) {
949
      $suggestion = str_replace(array("/", "\\", "\0"), '', $suggestion);
950
      foreach ($paths as $path) {
951
        if (file_exists($file = $path . '/' . $suggestion . $extension)) {
952
953
954
          return $file;
        }
      }
955
    }
Dries's avatar
   
Dries committed
956
957
958
959
  }
}

/**
960
961
962
963
964
965
966
967
 * Return the path to the current themed element.
 *
 * It can point to the active theme or the module handling a themed implementation.
 * For example, when invoked within the scope of a theming call it will depend
 * on where the theming function is handled. If implemented from a module, it
 * will point to the module. If implemented from the active theme, it will point
 * to the active theme. When called outside the scope of a theming call, it will
 * always point to the active theme.
Dries's avatar
   
Dries committed
968
 */
Dries's avatar
   
Dries committed
969
function path_to_theme() {
970
  global $theme_path;
Dries's avatar
   
Dries committed
971

972
  if (!isset($theme_path)) {
973
    drupal_theme_initialize();
974
975
  }

976
  return $theme_path;
977
978
}

979
/**
980
 * Allow themes and/or theme engines to easily discover overridden theme functions.
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $prefixes
 *   An array of prefixes to test, in reverse order of importance.
 *
 * @return $templates
 *   The functions found, suitable for returning from hook_theme;
 */
function drupal_find_theme_functions($cache, $prefixes) {
  $templates = array();
  $functions = get_defined_functions();

  foreach ($cache as $hook => $info) {
    foreach ($prefixes as $prefix) {
      if (!empty($info['pattern'])) {
997
        $matches = preg_grep('/^' . $prefix . '_' . $info['pattern'] . '/', $functions['user']);
998
999
        if ($matches) {
          foreach ($matches as $match) {
1000
            $new_hook = str_replace($prefix . '_', '', $match);
1001
            $arg_name = isset($info['variables']) ? 'variables' : 'render element';
1002
1003
            $templates[$new_hook] = array(
              'function' => $match,
1004
              $arg_name => $info[$arg_name],
1005
1006
1007
1008
            );
          }
        }
      }
1009
      if (function_exists($prefix . '_' . $hook)) {
1010
        $templates[$hook] = array(
1011
          'function' => $prefix . '_' . $hook,
1012
        );
1013
1014
1015
1016
1017
1018
        // Ensure that the pattern is maintained from base themes to its sub-themes.
        // Each sub-theme will have their functions scanned so the pattern must be
        // held for subsequent runs.
        if (isset($info['pattern'])) {
          $templates[$hook]['pattern'] = $info['pattern'];
        }
1019
1020
1021
1022
1023
1024
1025
1026
      }
    }
  }

  return $templates;
}

/**
1027
 * Allow themes and/or theme engines to easily discover overridden templates.
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $extension
 *   The extension that these templates will have.
 * @param $path
 *   The path to search.
 */
function drupal_find_theme_templates($cache, $extension, $path) {
  $templates = array();

1039
1040
1041
1042
  // Collect paths to all sub-themes grouped by base themes. These will be
  // used for filtering. This allows base themes to have sub-themes in its
  // folder hierarchy without affecting the base themes template discovery.
  $theme_paths = array();
1043
  foreach (list_themes() as $theme_info) {
1044
1045
1046
1047
1048
1049
1050
1051
1052
    if (!empty($theme_info->base_theme)) {
      $theme_paths[$theme_info->base_theme][$theme_info->name] = dirname($theme_info->filename);
    }
  }
  foreach ($theme_paths as $basetheme => $subthemes) {
    foreach ($subthemes as $subtheme => $subtheme_path) {
      if (isset($theme_paths[$subtheme])) {
        $theme_paths[$basetheme] = array_merge($theme_paths[$basetheme], $theme_paths[$subtheme]);
      }
1053
1054
    }
  }
1055
1056
  global $theme;
  $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
1057

1058
  // Escape the periods in the extension.
1059
  $regex = '/' . str_replace('.', '\.', $extension) . '$/';
1060
1061
1062
1063
  // Because drupal_system_listing works the way it does, we check for real
  // templates separately from checking for patterns.
  $files = drupal_system_listing($regex, $path, 'name', 0);
  foreach ($files as $template => $file) {
1064
    // Ignore sub-theme templates for the current theme.
1065
    if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
1066
1067
      continue;
    }
1068
1069
1070
1071
1072
1073
    // Chop off the remaining extensions if there are any. $template already
    // has the rightmost extension removed, but there might still be more,
    // such as with .tpl.php, which still has .tpl in $template at this point.
    if (($pos = strpos($template, '.')) !== FALSE) {
      $template = substr($template, 0, $pos);
    }
1074
1075
1076
1077
1078
    // Transform - in filenames to _ to match function naming scheme
    // for the purposes of searching.
    $hook = strtr($template, '-', '_');
    if (isset($cache[$hook])) {
      $templates[$hook] = array(
1079
        'template' => $template,
1080
        'path' => dirname($file->uri),
1081
1082
      );
    }
1083
1084
1085
1086
1087
1088
    // Ensure that the pattern is maintained from base themes to its sub-themes.
    // Each sub-theme will have their templates scanned so the pattern must be
    // held for subsequent runs.
    if (isset($cache[$hook]['pattern'])) {
      $templates[$hook]['pattern'] = $cache[$hook]['pattern'];
    }
1089
1090
1091
1092
1093
1094
  }

  $patterns = array_keys($files);

  foreach ($cache as $hook => $info) {
    if (!empty($info['pattern'])) {
1095
1096
1097
1098
      // Transform _ in pattern to - to match file naming scheme
      // for the purposes of searching.
      $pattern = strtr($info['pattern'], '_', '-');

1099
      $matches = preg_grep('/^' . $pattern . '/', $patterns);
1100
1101
1102
      if ($matches) {
        foreach ($matches as $match) {
          $file = substr($match, 0, strpos($match, '.'));
1103
          // Put the underscores back in for the hook name and register this pattern.
1104
          $arg_name = isset($info['variables']) ? 'variables' : 'render element';
1105
          $templates[strtr($file, '-', '_')] = array(
1106
            'template' => $file,
1107
            'path' => dirname($files[$match]->uri),
1108
            $arg_name => $info[$arg_name],
1109
1110
1111
1112
1113
1114
1115
1116
          );
        }
      }
    }
  }
  return $templates;
}

Dries's avatar
   
Dries committed
1117
/**
1118
 * Retrieve a setting for the current theme or for a given theme.
Dries's avatar
   
Dries committed
1119
 *
1120
1121
1122
1123
 * The final setting is arrived at by merging the default settings, the custom
 * theme settings defined in the theme's .info file, the site-wide settings, and
 * the settings defined for the specific theme. If an empty string is given for
 * $key, only the site-wide theme defaults are retrieved.
Dries's avatar
   
Dries committed
1124
 *
1125
1126
1127
 * The default values for each setting is defined in this function. To add new
 * settings, add their default values here, and then add form elements to
 * system_theme_settings() in system.admin.inc.
Dries's avatar
   
Dries committed
1128
1129
1130
 *
 * @param $setting_name
 *  The name of the setting to be retrieved.
1131
1132
 * @param $theme
 *  The name of a given theme; defaults to the current theme.
Dries's avatar
   
Dries committed
1133
1134
1135
 * @return
 *   The value of the requested setting, NULL if the setting does not exist.
 */
1136
1137
function theme_get_setting($setting_name, $theme = NULL) {
  $cache = &drupal_static(__FUNCTION__, array());
Dries's avatar
   
Dries committed
1138

1139
1140
  // If no key is given, use the current theme if we can determine it.
  if (is_null($theme)) {
1141
    $theme = !empty($GLOBALS['theme_key']) ? $GLOBALS['theme_key'] : '';
1142
  }
Dries's avatar
   
Dries committed
1143

1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158