1. 7 includes/theme.inc
  2. 4.6 includes/theme.inc
  3. 4.7 includes/theme.inc
  4. 5 includes/theme.inc
  5. 6 includes/theme.inc
  6. 8 core/includes/theme.inc

The theme system, which controls the output of Drupal.

The theme system allows for nearly all output of the Drupal system to be customized by user themes.

File

includes/theme.inc
View source
  1. <?php
  2. /**
  3. * @file
  4. * The theme system, which controls the output of Drupal.
  5. *
  6. * The theme system allows for nearly all output of the Drupal system to be
  7. * customized by user themes.
  8. */
  9. /**
  10. * @defgroup content_flags Content markers
  11. * @{
  12. * Markers used by theme_mark() and node_mark() to designate content.
  13. * @see theme_mark(), node_mark()
  14. */
  15. /**
  16. * Mark content as read.
  17. */
  18. define('MARK_READ', 0);
  19. /**
  20. * Mark content as being new.
  21. */
  22. define('MARK_NEW', 1);
  23. /**
  24. * Mark content as being updated.
  25. */
  26. define('MARK_UPDATED', 2);
  27. /**
  28. * @} End of "Content markers".
  29. */
  30. /**
  31. * Determines if a theme is available to use.
  32. *
  33. * @param $theme
  34. * Either the name of a theme or a full theme object.
  35. *
  36. * @return
  37. * Boolean TRUE if the theme is enabled or is the site administration theme;
  38. * FALSE otherwise.
  39. */
  40. function drupal_theme_access($theme) {
  41. if (is_object($theme)) {
  42. return _drupal_theme_access($theme);
  43. }
  44. else {
  45. $themes = list_themes();
  46. return isset($themes[$theme]) && _drupal_theme_access($themes[$theme]);
  47. }
  48. }
  49. /**
  50. * Helper function for determining access to a theme.
  51. *
  52. * @see drupal_theme_access()
  53. */
  54. function _drupal_theme_access($theme) {
  55. $admin_theme = variable_get('admin_theme');
  56. return !empty($theme->status) || ($admin_theme && $theme->name == $admin_theme);
  57. }
  58. /**
  59. * Initializes the theme system by loading the theme.
  60. */
  61. function drupal_theme_initialize() {
  62. global $theme, $user, $theme_key;
  63. // If $theme is already set, assume the others are set, too, and do nothing
  64. if (isset($theme)) {
  65. return;
  66. }
  67. drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
  68. $themes = list_themes();
  69. // Only select the user selected theme if it is available in the
  70. // list of themes that can be accessed.
  71. $theme = !empty($user->theme) && drupal_theme_access($user->theme) ? $user->theme : variable_get('theme_default', 'bartik');
  72. // Allow modules to override the theme. Validation has already been performed
  73. // inside menu_get_custom_theme(), so we do not need to check it again here.
  74. $custom_theme = menu_get_custom_theme();
  75. $theme = !empty($custom_theme) ? $custom_theme : $theme;
  76. // Store the identifier for retrieving theme settings with.
  77. $theme_key = $theme;
  78. // Find all our ancestor themes and put them in an array.
  79. $base_theme = array();
  80. $ancestor = $theme;
  81. while ($ancestor && isset($themes[$ancestor]->base_theme)) {
  82. $ancestor = $themes[$ancestor]->base_theme;
  83. $base_theme[] = $themes[$ancestor];
  84. }
  85. _drupal_theme_initialize($themes[$theme], array_reverse($base_theme));
  86. // Themes can have alter functions, so reset the drupal_alter() cache.
  87. drupal_static_reset('drupal_alter');
  88. // Provide the page with information about the theme that's used, so that a
  89. // later Ajax request can be rendered using the same theme.
  90. // @see ajax_base_page_theme()
  91. $setting['ajaxPageState'] = array(
  92. 'theme' => $theme_key,
  93. 'theme_token' => drupal_get_token($theme_key),
  94. );
  95. drupal_add_js($setting, 'setting');
  96. }
  97. /**
  98. * Initializes the theme system given already loaded information.
  99. *
  100. * This function is useful to initialize a theme when no database is present.
  101. *
  102. * @param $theme
  103. * An object with the following information:
  104. * filename
  105. * The .info file for this theme. The 'path' to
  106. * the theme will be in this file's directory. (Required)
  107. * owner
  108. * The path to the .theme file or the .engine file to load for
  109. * the theme. (Required)
  110. * stylesheet
  111. * The primary stylesheet for the theme. (Optional)
  112. * engine
  113. * The name of theme engine to use. (Optional)
  114. * @param $base_theme
  115. * An optional array of objects that represent the 'base theme' if the
  116. * theme is meant to be derivative of another theme. It requires
  117. * the same information as the $theme object. It should be in
  118. * 'oldest first' order, meaning the top level of the chain will
  119. * be first.
  120. * @param $registry_callback
  121. * 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. global $theme_info, $base_theme_info, $theme_engine, $theme_path;
  125. $theme_info = $theme;
  126. $base_theme_info = $base_theme;
  127. $theme_path = dirname($theme->filename);
  128. // Prepare stylesheets from this theme as well as all ancestor themes.
  129. // We work it this way so that we can have child themes override parent
  130. // theme stylesheets easily.
  131. $final_stylesheets = array();
  132. // Grab stylesheets from base theme
  133. foreach ($base_theme as $base) {
  134. if (!empty($base->stylesheets)) {
  135. foreach ($base->stylesheets as $media => $stylesheets) {
  136. foreach ($stylesheets as $name => $stylesheet) {
  137. $final_stylesheets[$media][$name] = $stylesheet;
  138. }
  139. }
  140. }
  141. }
  142. // Add stylesheets used by this theme.
  143. if (!empty($theme->stylesheets)) {
  144. foreach ($theme->stylesheets as $media => $stylesheets) {
  145. foreach ($stylesheets as $name => $stylesheet) {
  146. $final_stylesheets[$media][$name] = $stylesheet;
  147. }
  148. }
  149. }
  150. // And now add the stylesheets properly
  151. foreach ($final_stylesheets as $media => $stylesheets) {
  152. foreach ($stylesheets as $stylesheet) {
  153. drupal_add_css($stylesheet, array('group' => CSS_THEME, 'every_page' => TRUE, 'media' => $media));
  154. }
  155. }
  156. // Do basically the same as the above for scripts
  157. $final_scripts = array();
  158. // Grab scripts from base theme
  159. foreach ($base_theme as $base) {
  160. if (!empty($base->scripts)) {
  161. foreach ($base->scripts as $name => $script) {
  162. $final_scripts[$name] = $script;
  163. }
  164. }
  165. }
  166. // Add scripts used by this theme.
  167. if (!empty($theme->scripts)) {
  168. foreach ($theme->scripts as $name => $script) {
  169. $final_scripts[$name] = $script;
  170. }
  171. }
  172. // Add scripts used by this theme.
  173. foreach ($final_scripts as $script) {
  174. drupal_add_js($script, array('group' => JS_THEME, 'every_page' => TRUE));
  175. }
  176. $theme_engine = NULL;
  177. // Initialize the theme.
  178. if (isset($theme->engine)) {
  179. // Include the engine.
  180. include_once DRUPAL_ROOT . '/' . $theme->owner;
  181. $theme_engine = $theme->engine;
  182. if (function_exists($theme_engine . '_init')) {
  183. foreach ($base_theme as $base) {
  184. call_user_func($theme_engine . '_init', $base);
  185. }
  186. call_user_func($theme_engine . '_init', $theme);
  187. }
  188. }
  189. else {
  190. // include non-engine theme files
  191. foreach ($base_theme as $base) {
  192. // Include the theme file or the engine.
  193. if (!empty($base->owner)) {
  194. include_once DRUPAL_ROOT . '/' . $base->owner;
  195. }
  196. }
  197. // and our theme gets one too.
  198. if (!empty($theme->owner)) {
  199. include_once DRUPAL_ROOT . '/' . $theme->owner;
  200. }
  201. }
  202. if (isset($registry_callback)) {
  203. _theme_registry_callback($registry_callback, array($theme, $base_theme, $theme_engine));
  204. }
  205. }
  206. /**
  207. * Gets the theme registry.
  208. *
  209. * @param $complete
  210. * Optional boolean to indicate whether to return the complete theme registry
  211. * array or an instance of the ThemeRegistry class. If TRUE, the complete
  212. * theme registry array will be returned. This is useful if you want to
  213. * foreach over the whole registry, use array_* functions or inspect it in a
  214. * debugger. If FALSE, an instance of the ThemeRegistry class will be
  215. * returned, this provides an ArrayObject which allows it to be accessed
  216. * with array syntax and isset(), and should be more lightweight
  217. * than the full registry. Defaults to TRUE.
  218. *
  219. * @return
  220. * The complete theme registry array, or an instance of the ThemeRegistry
  221. * class.
  222. */
  223. function theme_get_registry($complete = TRUE) {
  224. // Use the advanced drupal_static() pattern, since this is called very often.
  225. static $drupal_static_fast;
  226. if (!isset($drupal_static_fast)) {
  227. $drupal_static_fast['registry'] = &drupal_static('theme_get_registry');
  228. }
  229. $theme_registry = &$drupal_static_fast['registry'];
  230. // Initialize the theme, if this is called early in the bootstrap, or after
  231. // static variables have been reset.
  232. if (!is_array($theme_registry)) {
  233. drupal_theme_initialize();
  234. $theme_registry = array();
  235. }
  236. $key = (int) $complete;
  237. if (!isset($theme_registry[$key])) {
  238. list($callback, $arguments) = _theme_registry_callback();
  239. if (!$complete) {
  240. $arguments[] = FALSE;
  241. }
  242. $theme_registry[$key] = call_user_func_array($callback, $arguments);
  243. }
  244. return $theme_registry[$key];
  245. }
  246. /**
  247. * Sets the callback that will be used by theme_get_registry().
  248. *
  249. * @param $callback
  250. * The name of the callback function.
  251. * @param $arguments
  252. * The arguments to pass to the function.
  253. */
  254. function _theme_registry_callback($callback = NULL, array $arguments = array()) {
  255. static $stored;
  256. if (isset($callback)) {
  257. $stored = array($callback, $arguments);
  258. }
  259. return $stored;
  260. }
  261. /**
  262. * Gets the theme_registry cache; if it doesn't exist, builds it.
  263. *
  264. * @param $theme
  265. * The loaded $theme object as returned by list_themes().
  266. * @param $base_theme
  267. * An array of loaded $theme objects representing the ancestor themes in
  268. * oldest first order.
  269. * @param $theme_engine
  270. * The name of the theme engine.
  271. * @param $complete
  272. * Whether to load the complete theme registry or an instance of the
  273. * ThemeRegistry class.
  274. *
  275. * @return
  276. * The theme registry array, or an instance of the ThemeRegistry class.
  277. */
  278. function _theme_load_registry($theme, $base_theme = NULL, $theme_engine = NULL, $complete = TRUE) {
  279. if ($complete) {
  280. // Check the theme registry cache; if it exists, use it.
  281. $cached = cache_get("theme_registry:$theme->name");
  282. if (isset($cached->data)) {
  283. $registry = $cached->data;
  284. }
  285. else {
  286. // If not, build one and cache it.
  287. $registry = _theme_build_registry($theme, $base_theme, $theme_engine);
  288. // Only persist this registry if all modules are loaded. This assures a
  289. // complete set of theme hooks.
  290. if (module_load_all(NULL)) {
  291. _theme_save_registry($theme, $registry);
  292. }
  293. }
  294. return $registry;
  295. }
  296. else {
  297. return new ThemeRegistry('theme_registry:runtime:' . $theme->name, 'cache');
  298. }
  299. }
  300. /**
  301. * Writes the theme_registry cache into the database.
  302. */
  303. function _theme_save_registry($theme, $registry) {
  304. cache_set("theme_registry:$theme->name", $registry);
  305. }
  306. /**
  307. * Forces the system to rebuild the theme registry.
  308. *
  309. * This function should be called when modules are added to the system, or when
  310. * a dynamic system needs to add more theme hooks.
  311. */
  312. function drupal_theme_rebuild() {
  313. drupal_static_reset('theme_get_registry');
  314. cache_clear_all('theme_registry', 'cache', TRUE);
  315. }
  316. /**
  317. * Builds the run-time theme registry.
  318. *
  319. * Extends DrupalCacheArray to allow the theme registry to be accessed as a
  320. * complete registry, while internally caching only the parts of the registry
  321. * that are actually in use on the site. On cache misses the complete
  322. * theme registry is loaded and used to update the run-time cache.
  323. */
  324. class ThemeRegistry Extends DrupalCacheArray {
  325. /**
  326. * Whether the partial registry can be persisted to the cache.
  327. *
  328. * This is only allowed if all modules and the request method is GET. theme()
  329. * should be very rarely called on POST requests and this avoids polluting
  330. * the runtime cache.
  331. */
  332. protected $persistable;
  333. /**
  334. * The complete theme registry array.
  335. */
  336. protected $completeRegistry;
  337. function __construct($cid, $bin) {
  338. $this->cid = $cid;
  339. $this->bin = $bin;
  340. $this->persistable = module_load_all(NULL) && $_SERVER['REQUEST_METHOD'] == 'GET';
  341. $data = array();
  342. if ($this->persistable && $cached = cache_get($this->cid, $this->bin)) {
  343. $data = $cached->data;
  344. }
  345. else {
  346. // If there is no runtime cache stored, fetch the full theme registry,
  347. // but then initialize each value to NULL. This allows offsetExists()
  348. // to function correctly on non-registered theme hooks without triggering
  349. // a call to resolveCacheMiss().
  350. $data = $this->initializeRegistry();
  351. if ($this->persistable) {
  352. $this->set($data);
  353. }
  354. }
  355. $this->storage = $data;
  356. }
  357. /**
  358. * Initializes the full theme registry.
  359. *
  360. * @return
  361. * An array with the keys of the full theme registry, but the values
  362. * initialized to NULL.
  363. */
  364. function initializeRegistry() {
  365. $this->completeRegistry = theme_get_registry();
  366. return array_fill_keys(array_keys($this->completeRegistry), NULL);
  367. }
  368. public function offsetExists($offset) {
  369. // Since the theme registry allows for theme hooks to be requested that
  370. // are not registered, just check the existence of the key in the registry.
  371. // Use array_key_exists() here since a NULL value indicates that the theme
  372. // hook exists but has not yet been requested.
  373. return array_key_exists($offset, $this->storage);
  374. }
  375. public function offsetGet($offset) {
  376. // If the offset is set but empty, it is a registered theme hook that has
  377. // not yet been requested. Offsets that do not exist at all were not
  378. // registered in hook_theme().
  379. if (isset($this->storage[$offset])) {
  380. return $this->storage[$offset];
  381. }
  382. elseif (array_key_exists($offset, $this->storage)) {
  383. return $this->resolveCacheMiss($offset);
  384. }
  385. }
  386. public function resolveCacheMiss($offset) {
  387. if (!isset($this->completeRegistry)) {
  388. $this->completeRegistry = theme_get_registry();
  389. }
  390. $this->storage[$offset] = $this->completeRegistry[$offset];
  391. if ($this->persistable) {
  392. $this->persist($offset);
  393. }
  394. return $this->storage[$offset];
  395. }
  396. public function set($data, $lock = TRUE) {
  397. $lock_name = $this->cid . ':' . $this->bin;
  398. if (!$lock || lock_acquire($lock_name)) {
  399. if ($cached = cache_get($this->cid, $this->bin)) {
  400. // Use array merge instead of union so that filled in values in $data
  401. // overwrite empty values in the current cache.
  402. $data = array_merge($cached->data, $data);
  403. }
  404. else {
  405. $registry = $this->initializeRegistry();
  406. $data = array_merge($registry, $data);
  407. }
  408. cache_set($this->cid, $data, $this->bin);
  409. if ($lock) {
  410. lock_release($lock_name);
  411. }
  412. }
  413. }
  414. }
  415. /**
  416. * Process a single implementation of hook_theme().
  417. *
  418. * @param $cache
  419. * The theme registry that will eventually be cached; It is an associative
  420. * array keyed by theme hooks, whose values are associative arrays describing
  421. * the hook:
  422. * - 'type': The passed-in $type.
  423. * - 'theme path': The passed-in $path.
  424. * - 'function': The name of the function generating output for this theme
  425. * hook. Either defined explicitly in hook_theme() or, if neither 'function'
  426. * nor 'template' is defined, then the default theme function name is used.
  427. * The default theme function name is the theme hook prefixed by either
  428. * 'theme_' for modules or '$name_' for everything else. If 'function' is
  429. * defined, 'template' is not used.
  430. * - 'template': The filename of the template generating output for this
  431. * theme hook. The template is in the directory defined by the 'path' key of
  432. * hook_theme() or defaults to $path.
  433. * - 'variables': The variables for this theme hook as defined in
  434. * hook_theme(). If there is more than one implementation and 'variables' is
  435. * not specified in a later one, then the previous definition is kept.
  436. * - 'render element': The renderable element for this theme hook as defined
  437. * in hook_theme(). If there is more than one implementation and
  438. * 'render element' is not specified in a later one, then the previous
  439. * definition is kept.
  440. * - 'preprocess functions': See theme() for detailed documentation.
  441. * - 'process functions': See theme() for detailed documentation.
  442. * @param $name
  443. * The name of the module, theme engine, base theme engine, theme or base
  444. * theme implementing hook_theme().
  445. * @param $type
  446. * One of 'module', 'theme_engine', 'base_theme_engine', 'theme', or
  447. * 'base_theme'. Unlike regular hooks that can only be implemented by modules,
  448. * each of these can implement hook_theme(). _theme_process_registry() is
  449. * called in aforementioned order and new entries override older ones. For
  450. * example, if a theme hook is both defined by a module and a theme, then the
  451. * definition in the theme will be used.
  452. * @param $theme
  453. * The loaded $theme object as returned from list_themes().
  454. * @param $path
  455. * The directory where $name is. For example, modules/system or
  456. * themes/bartik.
  457. *
  458. * @see theme()
  459. * @see _theme_build_registry()
  460. * @see hook_theme()
  461. * @see list_themes()
  462. */
  463. function _theme_process_registry(&$cache, $name, $type, $theme, $path) {
  464. $result = array();
  465. // Processor functions work in two distinct phases with the process
  466. // functions always being executed after the preprocess functions.
  467. $variable_process_phases = array(
  468. 'preprocess functions' => 'preprocess',
  469. 'process functions' => 'process',
  470. );
  471. $hook_defaults = array(
  472. 'variables' => TRUE,
  473. 'render element' => TRUE,
  474. 'pattern' => TRUE,
  475. 'base hook' => TRUE,
  476. );
  477. // Invoke the hook_theme() implementation, process what is returned, and
  478. // merge it into $cache.
  479. $function = $name . '_theme';
  480. if (function_exists($function)) {
  481. $result = $function($cache, $type, $theme, $path);
  482. foreach ($result as $hook => $info) {
  483. // When a theme or engine overrides a module's theme function
  484. // $result[$hook] will only contain key/value pairs for information being
  485. // overridden. Pull the rest of the information from what was defined by
  486. // an earlier hook.
  487. // Fill in the type and path of the module, theme, or engine that
  488. // implements this theme function.
  489. $result[$hook]['type'] = $type;
  490. $result[$hook]['theme path'] = $path;
  491. // If function and file are omitted, default to standard naming
  492. // conventions.
  493. if (!isset($info['template']) && !isset($info['function'])) {
  494. $result[$hook]['function'] = ($type == 'module' ? 'theme_' : $name . '_') . $hook;
  495. }
  496. if (isset($cache[$hook]['includes'])) {
  497. $result[$hook]['includes'] = $cache[$hook]['includes'];
  498. }
  499. // If the theme implementation defines a file, then also use the path
  500. // that it defined. Otherwise use the default path. This allows
  501. // system.module to declare theme functions on behalf of core .include
  502. // files.
  503. if (isset($info['file'])) {
  504. $include_file = isset($info['path']) ? $info['path'] : $path;
  505. $include_file .= '/' . $info['file'];
  506. include_once DRUPAL_ROOT . '/' . $include_file;
  507. $result[$hook]['includes'][] = $include_file;
  508. }
  509. // If the default keys are not set, use the default values registered
  510. // by the module.
  511. if (isset($cache[$hook])) {
  512. $result[$hook] += array_intersect_key($cache[$hook], $hook_defaults);
  513. }
  514. // The following apply only to theming hooks implemented as templates.
  515. if (isset($info['template'])) {
  516. // Prepend the current theming path when none is set.
  517. if (!isset($info['path'])) {
  518. $result[$hook]['template'] = $path . '/' . $info['template'];
  519. }
  520. }
  521. // Allow variable processors for all theming hooks, whether the hook is
  522. // implemented as a template or as a function.
  523. foreach ($variable_process_phases as $phase_key => $phase) {
  524. // Check for existing variable processors. Ensure arrayness.
  525. if (!isset($info[$phase_key]) || !is_array($info[$phase_key])) {
  526. $info[$phase_key] = array();
  527. $prefixes = array();
  528. if ($type == 'module') {
  529. // Default variable processor prefix.
  530. $prefixes[] = 'template';
  531. // Add all modules so they can intervene with their own variable
  532. // processors. This allows them to provide variable processors even
  533. // if they are not the owner of the current hook.
  534. $prefixes += module_list();
  535. }
  536. elseif ($type == 'theme_engine' || $type == 'base_theme_engine') {
  537. // Theme engines get an extra set that come before the normally
  538. // named variable processors.
  539. $prefixes[] = $name . '_engine';
  540. // The theme engine registers on behalf of the theme using the
  541. // theme's name.
  542. $prefixes[] = $theme;
  543. }
  544. else {
  545. // This applies when the theme manually registers their own variable
  546. // processors.
  547. $prefixes[] = $name;
  548. }
  549. foreach ($prefixes as $prefix) {
  550. // Only use non-hook-specific variable processors for theming hooks
  551. // implemented as templates. See theme().
  552. if (isset($info['template']) && function_exists($prefix . '_' . $phase)) {
  553. $info[$phase_key][] = $prefix . '_' . $phase;
  554. }
  555. if (function_exists($prefix . '_' . $phase . '_' . $hook)) {
  556. $info[$phase_key][] = $prefix . '_' . $phase . '_' . $hook;
  557. }
  558. }
  559. }
  560. // Check for the override flag and prevent the cached variable
  561. // processors from being used. This allows themes or theme engines to
  562. // remove variable processors set earlier in the registry build.
  563. if (!empty($info['override ' . $phase_key])) {
  564. // Flag not needed inside the registry.
  565. unset($result[$hook]['override ' . $phase_key]);
  566. }
  567. elseif (isset($cache[$hook][$phase_key]) && is_array($cache[$hook][$phase_key])) {
  568. $info[$phase_key] = array_merge($cache[$hook][$phase_key], $info[$phase_key]);
  569. }
  570. $result[$hook][$phase_key] = $info[$phase_key];
  571. }
  572. }
  573. // Merge the newly created theme hooks into the existing cache.
  574. $cache = $result + $cache;
  575. }
  576. // Let themes have variable processors even if they didn't register a
  577. // template.
  578. if ($type == 'theme' || $type == 'base_theme') {
  579. foreach ($cache as $hook => $info) {
  580. // Check only if not registered by the theme or engine.
  581. if (empty($result[$hook])) {
  582. foreach ($variable_process_phases as $phase_key => $phase) {
  583. if (!isset($info[$phase_key])) {
  584. $cache[$hook][$phase_key] = array();
  585. }
  586. // Only use non-hook-specific variable processors for theming hooks
  587. // implemented as templates. See theme().
  588. if (isset($info['template']) && function_exists($name . '_' . $phase)) {
  589. $cache[$hook][$phase_key][] = $name . '_' . $phase;
  590. }
  591. if (function_exists($name . '_' . $phase . '_' . $hook)) {
  592. $cache[$hook][$phase_key][] = $name . '_' . $phase . '_' . $hook;
  593. $cache[$hook]['theme path'] = $path;
  594. }
  595. // Ensure uniqueness.
  596. $cache[$hook][$phase_key] = array_unique($cache[$hook][$phase_key]);
  597. }
  598. }
  599. }
  600. }
  601. }
  602. /**
  603. * Builds the theme registry cache.
  604. *
  605. * @param $theme
  606. * The loaded $theme object as returned by list_themes().
  607. * @param $base_theme
  608. * An array of loaded $theme objects representing the ancestor themes in
  609. * oldest first order.
  610. * @param $theme_engine
  611. * The name of the theme engine.
  612. */
  613. function _theme_build_registry($theme, $base_theme, $theme_engine) {
  614. $cache = array();
  615. // First, process the theme hooks advertised by modules. This will
  616. // serve as the basic registry. Since the list of enabled modules is the same
  617. // regardless of the theme used, this is cached in its own entry to save
  618. // building it for every theme.
  619. if ($cached = cache_get('theme_registry:build:modules')) {
  620. $cache = $cached->data;
  621. }
  622. else {
  623. foreach (module_implements('theme') as $module) {
  624. _theme_process_registry($cache, $module, 'module', $module, drupal_get_path('module', $module));
  625. }
  626. // Only cache this registry if all modules are loaded.
  627. if (module_load_all(NULL)) {
  628. cache_set('theme_registry:build:modules', $cache);
  629. }
  630. }
  631. // Process each base theme.
  632. foreach ($base_theme as $base) {
  633. // If the base theme uses a theme engine, process its hooks.
  634. $base_path = dirname($base->filename);
  635. if ($theme_engine) {
  636. _theme_process_registry($cache, $theme_engine, 'base_theme_engine', $base->name, $base_path);
  637. }
  638. _theme_process_registry($cache, $base->name, 'base_theme', $base->name, $base_path);
  639. }
  640. // And then the same thing, but for the theme.
  641. if ($theme_engine) {
  642. _theme_process_registry($cache, $theme_engine, 'theme_engine', $theme->name, dirname($theme->filename));
  643. }
  644. // Finally, hooks provided by the theme itself.
  645. _theme_process_registry($cache, $theme->name, 'theme', $theme->name, dirname($theme->filename));
  646. // Let modules alter the registry.
  647. drupal_alter('theme_registry', $cache);
  648. // Optimize the registry to not have empty arrays for functions.
  649. foreach ($cache as $hook => $info) {
  650. foreach (array('preprocess functions', 'process functions') as $phase) {
  651. if (empty($info[$phase])) {
  652. unset($cache[$hook][$phase]);
  653. }
  654. }
  655. }
  656. return $cache;
  657. }
  658. /**
  659. * Returns a list of all currently available themes.
  660. *
  661. * Retrieved from the database, if available and the site is not in maintenance
  662. * mode; otherwise compiled freshly from the filesystem.
  663. *
  664. * @param $refresh
  665. * Whether to reload the list of themes from the database. Defaults to FALSE.
  666. *
  667. * @return
  668. * An associative array of the currently available themes. The keys are the
  669. * themes' machine names and the values are objects having the following
  670. * properties:
  671. * - filename: The filepath and name of the .info file.
  672. * - name: The machine name of the theme.
  673. * - status: 1 for enabled, 0 for disabled themes.
  674. * - info: The contents of the .info file.
  675. * - stylesheets: A two dimensional array, using the first key for the
  676. * media attribute (e.g. 'all'), the second for the name of the file
  677. * (e.g. style.css). The value is a complete filepath (e.g.
  678. * themes/bartik/style.css). Not set if no stylesheets are defined in the
  679. * .info file.
  680. * - scripts: An associative array of JavaScripts, using the filename as key
  681. * and the complete filepath as value. Not set if no scripts are defined in
  682. * the .info file.
  683. * - prefix: The base theme engine prefix.
  684. * - engine: The machine name of the theme engine.
  685. * - base_theme: If this is a sub-theme, the machine name of the base theme
  686. * defined in the .info file. Otherwise, the element is not set.
  687. * - base_themes: If this is a sub-theme, an associative array of the
  688. * base-theme ancestors of this theme, starting with this theme's base
  689. * theme, then the base theme's own base theme, etc. Each entry has an
  690. * array key equal to the theme's machine name, and a value equal to the
  691. * human-readable theme name; if a theme with matching machine name does
  692. * not exist in the system, the value will instead be NULL (and since the
  693. * system would not know whether that theme itself has a base theme, that
  694. * will end the array of base themes). This is not set if the theme is not
  695. * a sub-theme.
  696. * - sub_themes: An associative array of themes on the system that are
  697. * either direct sub-themes (that is, they declare this theme to be
  698. * their base theme), direct sub-themes of sub-themes, etc. The keys are
  699. * the themes' machine names, and the values are the themes' human-readable
  700. * names. This element is not set if there are no themes on the system that
  701. * declare this theme as their base theme.
  702. */
  703. function list_themes($refresh = FALSE) {
  704. $list = &drupal_static(__FUNCTION__, array());
  705. if ($refresh) {
  706. $list = array();
  707. system_list_reset();
  708. }
  709. if (empty($list)) {
  710. $list = array();
  711. $themes = array();
  712. // Extract from the database only when it is available.
  713. // Also check that the site is not in the middle of an install or update.
  714. if (!defined('MAINTENANCE_MODE')) {
  715. try {
  716. $themes = system_list('theme');
  717. }
  718. catch (Exception $e) {
  719. // If the database is not available, rebuild the theme data.
  720. $themes = _system_rebuild_theme_data();
  721. }
  722. }
  723. else {
  724. // Scan the installation when the database should not be read.
  725. $themes = _system_rebuild_theme_data();
  726. }
  727. foreach ($themes as $theme) {
  728. foreach ($theme->info['stylesheets'] as $media => $stylesheets) {
  729. foreach ($stylesheets as $stylesheet => $path) {
  730. $theme->stylesheets[$media][$stylesheet] = $path;
  731. }
  732. }
  733. foreach ($theme->info['scripts'] as $script => $path) {
  734. $theme->scripts[$script] = $path;
  735. }
  736. if (isset($theme->info['engine'])) {
  737. $theme->engine = $theme->info['engine'];
  738. }
  739. if (isset($theme->info['base theme'])) {
  740. $theme->base_theme = $theme->info['base theme'];
  741. }
  742. // Status is normally retrieved from the database. Add zero values when
  743. // read from the installation directory to prevent notices.
  744. if (!isset($theme->status)) {
  745. $theme->status = 0;
  746. }
  747. $list[$theme->name] = $theme;
  748. }
  749. }
  750. return $list;
  751. }
  752. /**
  753. * Find all the base themes for the specified theme.
  754. *
  755. * Themes can inherit templates and function implementations from earlier themes.
  756. *
  757. * @param $themes
  758. * An array of available themes.
  759. * @param $key
  760. * The name of the theme whose base we are looking for.
  761. * @param $used_keys
  762. * A recursion parameter preventing endless loops.
  763. * @return
  764. * Returns an array of all of the theme's ancestors; the first element's value
  765. * will be NULL if an error occurred.
  766. */
  767. function drupal_find_base_themes($themes, $key, $used_keys = array()) {
  768. $base_key = $themes[$key]->info['base theme'];
  769. // Does the base theme exist?
  770. if (!isset($themes[$base_key])) {
  771. return array($base_key => NULL);
  772. }
  773. $current_base_theme = array($base_key => $themes[$base_key]->info['name']);
  774. // Is the base theme itself a child of another theme?
  775. if (isset($themes[$base_key]->info['base theme'])) {
  776. // Do we already know the base themes of this theme?
  777. if (isset($themes[$base_key]->base_themes)) {
  778. return $themes[$base_key]->base_themes + $current_base_theme;
  779. }
  780. // Prevent loops.
  781. if (!empty($used_keys[$base_key])) {
  782. return array($base_key => NULL);
  783. }
  784. $used_keys[$base_key] = TRUE;
  785. return drupal_find_base_themes($themes, $base_key, $used_keys) + $current_base_theme;
  786. }
  787. // If we get here, then this is our parent theme.
  788. return $current_base_theme;
  789. }
  790. /**
  791. * Generates themed output.
  792. *
  793. * All requests for themed output must go through this function (however,
  794. * calling the theme() function directly is strongly discouraged - see next
  795. * paragraph). It examines the request and routes it to the appropriate
  796. * @link themeable theme function or template @endlink, by checking the theme
  797. * registry.
  798. *
  799. * Avoid calling this function directly. It is preferable to replace direct
  800. * calls to the theme() function with calls to drupal_render() by passing a
  801. * render array with a #theme key to drupal_render(), which in turn calls
  802. * theme().
  803. *
  804. * @section sec_theme_hooks Theme Hooks
  805. * Most commonly, the first argument to this function is the name of the theme
  806. * hook. For instance, to theme a taxonomy term, the theme hook name is
  807. * 'taxonomy_term'. Modules register theme hooks within a hook_theme()
  808. * implementation and provide a default implementation via a function named
  809. * theme_HOOK() (e.g., theme_taxonomy_term()) or via a template file named
  810. * according to the value of the 'template' key registered with the theme hook
  811. * (see hook_theme() for details). Default templates are implemented with the
  812. * PHPTemplate rendering engine and are named the same as the theme hook, with
  813. * underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
  814. * default template is 'taxonomy-term.tpl.php'.
  815. *
  816. * @subsection sub_overriding_theme_hooks Overriding Theme Hooks
  817. * Themes may also register new theme hooks within a hook_theme()
  818. * implementation, but it is more common for themes to override default
  819. * implementations provided by modules than to register entirely new theme
  820. * hooks. Themes can override a default implementation by implementing a
  821. * function named THEME_HOOK() (for example, the 'bartik' theme overrides the
  822. * default implementation of the 'menu_tree' theme hook by implementing a
  823. * bartik_menu_tree() function), or by adding a template file within its folder
  824. * structure that follows the template naming structure used by the theme's
  825. * rendering engine (for example, since the Bartik theme uses the PHPTemplate
  826. * rendering engine, it overrides the default implementation of the 'page' theme
  827. * hook by containing a 'page.tpl.php' file within its folder structure).
  828. *
  829. * @subsection sub_preprocess_templates Preprocessing for Template Files
  830. * If the implementation is a template file, several functions are called
  831. * before the template file is invoked, to modify the $variables array. These
  832. * fall into the "preprocessing" phase and the "processing" phase, and are
  833. * executed (if they exist), in the following order (note that in the following
  834. * list, HOOK indicates the theme hook name, MODULE indicates a module name,
  835. * THEME indicates a theme name, and ENGINE indicates a theme engine name):
  836. * - template_preprocess(&$variables, $hook): Creates a default set of
  837. * variables for all theme hooks with template implementations.
  838. * - template_preprocess_HOOK(&$variables): Should be implemented by the module
  839. * that registers the theme hook, to set up default variables.
  840. * - MODULE_preprocess(&$variables, $hook): hook_preprocess() is invoked on all
  841. * implementing modules.
  842. * - MODULE_preprocess_HOOK(&$variables): hook_preprocess_HOOK() is invoked on
  843. * all implementing modules, so that modules that didn't define the theme
  844. * hook can alter the variables.
  845. * - ENGINE_engine_preprocess(&$variables, $hook): Allows the theme engine to
  846. * set necessary variables for all theme hooks with template implementations.
  847. * - ENGINE_engine_preprocess_HOOK(&$variables): Allows the theme engine to set
  848. * necessary variables for the particular theme hook.
  849. * - THEME_preprocess(&$variables, $hook): Allows the theme to set necessary
  850. * variables for all theme hooks with template implementations.
  851. * - THEME_preprocess_HOOK(&$variables): Allows the theme to set necessary
  852. * variables specific to the particular theme hook.
  853. * - template_process(&$variables, $hook): Creates an additional set of default
  854. * variables for all theme hooks with template implementations. The variables
  855. * created in this function are derived from ones created by
  856. * template_preprocess(), but potentially altered by the other preprocess
  857. * functions listed above. For example, any preprocess function can add to or
  858. * modify the $variables['attributes_array'] variable, and after all of them
  859. * have finished executing, template_process() flattens it into a
  860. * $variables['attributes'] string for convenient use by templates.
  861. * - template_process_HOOK(&$variables): Should be implemented by the module
  862. * that registers the theme hook, if it needs to perform additional variable
  863. * processing after all preprocess functions have finished.
  864. * - MODULE_process(&$variables, $hook): hook_process() is invoked on all
  865. * implementing modules.
  866. * - MODULE_process_HOOK(&$variables): hook_process_HOOK() is invoked on
  867. * on all implementing modules, so that modules that didn't define the theme
  868. * hook can alter the variables.
  869. * - ENGINE_engine_process(&$variables, $hook): Allows the theme engine to
  870. * process variables for all theme hooks with template implementations.
  871. * - ENGINE_engine_process_HOOK(&$variables): Allows the theme engine to process
  872. * the variables specific to the theme hook.
  873. * - THEME_process(&$variables, $hook): Allows the theme to process the
  874. * variables for all theme hooks with template implementations.
  875. * - THEME_process_HOOK(&$variables): Allows the theme to process the
  876. * variables specific to the theme hook.
  877. *
  878. * @subsection sub_preprocess_theme_funcs Preprocessing for Theme Functions
  879. * If the implementation is a function, only the theme-hook-specific preprocess
  880. * and process functions (the ones ending in _HOOK) are called from the
  881. * list above. This is because theme hooks with function implementations
  882. * need to be fast, and calling the non-theme-hook-specific preprocess and
  883. * process functions for them would incur a noticeable performance penalty.
  884. *
  885. * @subsection sub_alternate_suggestions Suggesting Alternate Hooks
  886. * There are two special variables that these preprocess and process functions
  887. * can set: 'theme_hook_suggestion' and 'theme_hook_suggestions'. These will be
  888. * merged together to form a list of 'suggested' alternate theme hooks to use,
  889. * in reverse order of priority. theme_hook_suggestion will always be a higher
  890. * priority than items in theme_hook_suggestions. theme() will use the
  891. * highest priority implementation that exists. If none exists, theme() will
  892. * use the implementation for the theme hook it was called with. These
  893. * suggestions are similar to and are used for similar reasons as calling
  894. * theme() with an array as the $hook parameter (see below). The difference
  895. * is whether the suggestions are determined by the code that calls theme() or
  896. * by a preprocess or process function.
  897. *
  898. * @param $hook
  899. * The name of the theme hook to call. If the name contains a
  900. * double-underscore ('__') and there isn't an implementation for the full
  901. * name, the part before the '__' is checked. This allows a fallback to a
  902. * more generic implementation. For example, if theme('links__node', ...) is
  903. * called, but there is no implementation of that theme hook, then the
  904. * 'links' implementation is used. This process is iterative, so if
  905. * theme('links__contextual__node', ...) is called, theme() checks for the
  906. * following implementations, and uses the first one that exists:
  907. * - links__contextual__node
  908. * - links__contextual
  909. * - links
  910. * This allows themes to create specific theme implementations for named
  911. * objects and contexts of otherwise generic theme hooks. The $hook parameter
  912. * may also be an array, in which case the first theme hook that has an
  913. * implementation is used. This allows for the code that calls theme() to
  914. * explicitly specify the fallback order in a situation where using the '__'
  915. * convention is not desired or is insufficient.
  916. * @param $variables
  917. * An associative array of variables to merge with defaults from the theme
  918. * registry, pass to preprocess and process functions for modification, and
  919. * finally, pass to the function or template implementing the theme hook.
  920. * Alternatively, this can be a renderable array, in which case, its
  921. * properties are mapped to variables expected by the theme hook
  922. * implementations.
  923. *
  924. * @return
  925. * An HTML string representing the themed output.
  926. *
  927. * @see drupal_render()
  928. * @see themeable
  929. * @see hook_theme()
  930. * @see template_preprocess()
  931. * @see template_process()
  932. */
  933. function theme($hook, $variables = array()) {
  934. // If called before all modules are loaded, we do not necessarily have a full
  935. // theme registry to work with, and therefore cannot process the theme
  936. // request properly. See also _theme_load_registry().
  937. if (!module_load_all(NULL) && !defined('MAINTENANCE_MODE')) {
  938. throw new Exception(t('theme() may not be called until all modules are loaded.'));
  939. }
  940. $hooks = theme_get_registry(FALSE);
  941. // If an array of hook candidates were passed, use the first one that has an
  942. // implementation.
  943. if (is_array($hook)) {
  944. foreach ($hook as $candidate) {
  945. if (isset($hooks[$candidate])) {
  946. break;
  947. }
  948. }
  949. $hook = $candidate;
  950. }
  951. $theme_hook_original = $hook;
  952. // If there's no implementation, check for more generic fallbacks. If there's
  953. // still no implementation, log an error and return an empty string.
  954. if (!isset($hooks[$hook])) {
  955. // Iteratively strip everything after the last '__' delimiter, until an
  956. // implementation is found.
  957. while ($pos = strrpos($hook, '__')) {
  958. $hook = substr($hook, 0, $pos);
  959. if (isset($hooks[$hook])) {
  960. break;
  961. }
  962. }
  963. if (!isset($hooks[$hook])) {
  964. // Only log a message when not trying theme suggestions ($hook being an
  965. // array).
  966. if (!isset($candidate)) {
  967. watchdog('theme', 'Theme hook %hook not found.', array('%hook' => $hook), WATCHDOG_WARNING);
  968. }
  969. return '';
  970. }
  971. }
  972. $info = $hooks[$hook];
  973. global $theme_path;
  974. $temp = $theme_path;
  975. // point path_to_theme() to the currently used theme path:
  976. $theme_path = $info['theme path'];
  977. // Include a file if the theme function or variable processor is held
  978. // elsewhere.
  979. if (!empty($info['includes'])) {
  980. foreach ($info['includes'] as $include_file) {
  981. include_once DRUPAL_ROOT . '/' . $include_file;
  982. }
  983. }
  984. // If a renderable array is passed as $variables, then set $variables to
  985. // the arguments expected by the theme function.
  986. if (isset($variables['#theme']) || isset($variables['#theme_wrappers'])) {
  987. $element = $variables;
  988. $variables = array();
  989. if (isset($info['variables'])) {
  990. foreach (array_keys($info['variables']) as $name) {
  991. if (isset($element["#$name"])) {
  992. $variables[$name] = $element["#$name"];
  993. }
  994. }
  995. }
  996. else {
  997. $variables[$info['render element']] = $element;
  998. }
  999. }
  1000. // Merge in argument defaults.
  1001. if (!empty($info['variables'])) {
  1002. $variables += $info['variables'];
  1003. }
  1004. elseif (!empty($info['render element'])) {
  1005. $variables += array($info['render element'] => array());
  1006. }
  1007. $variables['theme_hook_original'] = $theme_hook_original;
  1008. // Invoke the variable processors, if any. The processors may specify
  1009. // alternate suggestions for which hook's template/function to use. If the
  1010. // hook is a suggestion of a base hook, invoke the variable processors of
  1011. // the base hook, but retain the suggestion as a high priority suggestion to
  1012. // be used unless overridden by a variable processor function.
  1013. if (isset($info['base hook'])) {
  1014. $base_hook = $info['base hook'];
  1015. $base_hook_info = $hooks[$base_hook];
  1016. // Include files required by the base hook, since its variable processors
  1017. // might reside there.
  1018. if (!empty($base_hook_info['includes'])) {
  1019. foreach ($base_hook_info['includes'] as $include_file) {
  1020. include_once DRUPAL_ROOT . '/' . $include_file;
  1021. }
  1022. }
  1023. if (isset($base_hook_info['preprocess functions']) || isset($base_hook_info['process functions'])) {
  1024. $variables['theme_hook_suggestion'] = $hook;
  1025. $hook = $base_hook;
  1026. $info = $base_hook_info;
  1027. }
  1028. }
  1029. if (isset($info['preprocess functions']) || isset($info['process functions'])) {
  1030. $variables['theme_hook_suggestions'] = array();
  1031. foreach (array('preprocess functions', 'process functions') as $phase) {
  1032. if (!empty($info[$phase])) {
  1033. foreach ($info[$phase] as $processor_function) {
  1034. if (function_exists($processor_function)) {
  1035. // We don't want a poorly behaved process function changing $hook.
  1036. $hook_clone = $hook;
  1037. $processor_function($variables, $hook_clone);
  1038. }
  1039. }
  1040. }
  1041. }
  1042. // If the preprocess/process functions specified hook suggestions, and the
  1043. // suggestion exists in the theme registry, use it instead of the hook that
  1044. // theme() was called with. This allows the preprocess/process step to
  1045. // route to a more specific theme hook. For example, a function may call
  1046. // theme('node', ...), but a preprocess function can add 'node__article' as
  1047. // a suggestion, enabling a theme to have an alternate template file for
  1048. // article nodes. Suggestions are checked in the following order:
  1049. // - The 'theme_hook_suggestion' variable is checked first. It overrides
  1050. // all others.
  1051. // - The 'theme_hook_suggestions' variable is checked in FILO order, so the
  1052. // last suggestion added to the array takes precedence over suggestions
  1053. // added earlier.
  1054. $suggestions = array();
  1055. if (!empty($variables['theme_hook_suggestions'])) {
  1056. $suggestions = $variables['theme_hook_suggestions'];
  1057. }
  1058. if (!empty($variables['theme_hook_suggestion'])) {
  1059. $suggestions[] = $variables['theme_hook_suggestion'];
  1060. }
  1061. foreach (array_reverse($suggestions) as $suggestion) {
  1062. if (isset($hooks[$suggestion])) {
  1063. $info = $hooks[$suggestion];
  1064. break;
  1065. }
  1066. }
  1067. }
  1068. // Generate the output using either a function or a template.
  1069. $output = '';
  1070. if (isset($info['function'])) {
  1071. if (function_exists($info['function'])) {
  1072. $output = $info['function']($variables);
  1073. }
  1074. }
  1075. else {
  1076. // Default render function and extension.
  1077. $render_function = 'theme_render_template';
  1078. $extension = '.tpl.php';
  1079. // The theme engine may use a different extension and a different renderer.
  1080. global $theme_engine;
  1081. if (isset($theme_engine)) {
  1082. if ($info['type'] != 'module') {
  1083. if (function_exists($theme_engine . '_render_template')) {
  1084. $render_function = $theme_engine . '_render_template';
  1085. }
  1086. $extension_function = $theme_engine . '_extension';
  1087. if (function_exists($extension_function)) {
  1088. $extension = $extension_function();
  1089. }
  1090. }
  1091. }
  1092. // In some cases, a template implementation may not have had
  1093. // template_preprocess() run (for example, if the default implementation is
  1094. // a function, but a template overrides that default implementation). In
  1095. // these cases, a template should still be able to expect to have access to
  1096. // the variables provided by template_preprocess(), so we add them here if
  1097. // they don't already exist. We don't want to run template_preprocess()
  1098. // twice (it would be inefficient and mess up zebra striping), so we use the
  1099. // 'directory' variable to determine if it has already run, which while not
  1100. // completely intuitive, is reasonably safe, and allows us to save on the
  1101. // overhead of adding some new variable to track that.
  1102. if (!isset($variables['directory'])) {
  1103. $default_template_variables = array();
  1104. template_preprocess($default_template_variables, $hook);
  1105. $variables += $default_template_variables;
  1106. }
  1107. // Render the output using the template file.
  1108. $template_file = $info['template'] . $extension;
  1109. if (isset($info['path'])) {
  1110. $template_file = $info['path'] . '/' . $template_file;
  1111. }
  1112. if (variable_get('theme_debug', FALSE)) {
  1113. $output = _theme_render_template_debug($render_function, $template_file, $variables, $extension);
  1114. }
  1115. else {
  1116. $output = $render_function($template_file, $variables);
  1117. }
  1118. }
  1119. // restore path_to_theme()
  1120. $theme_path = $temp;
  1121. return $output;
  1122. }
  1123. /**
  1124. * Returns the path to the current themed element.
  1125. *
  1126. * It can point to the active theme or the module handling a themed
  1127. * implementation. For example, when invoked within the scope of a theming call
  1128. * it will depend on where the theming function is handled. If implemented from
  1129. * a module, it will point to the module. If implemented from the active theme,
  1130. * it will point to the active theme. When called outside the scope of a
  1131. * theming call, it will always point to the active theme.
  1132. */
  1133. function path_to_theme() {
  1134. global $theme_path;
  1135. if (!isset($theme_path)) {
  1136. drupal_theme_initialize();
  1137. }
  1138. return $theme_path;
  1139. }
  1140. /**
  1141. * Allows themes and/or theme engines to discover overridden theme functions.
  1142. *
  1143. * @param $cache
  1144. * The existing cache of theme hooks to test against.
  1145. * @param $prefixes
  1146. * An array of prefixes to test, in reverse order of importance.
  1147. *
  1148. * @return $implementations
  1149. * The functions found, suitable for returning from hook_theme;
  1150. */
  1151. function drupal_find_theme_functions($cache, $prefixes) {
  1152. $implementations = array();
  1153. $functions = get_defined_functions();
  1154. foreach ($cache as $hook => $info) {
  1155. foreach ($prefixes as $prefix) {
  1156. // Find theme functions that implement possible "suggestion" variants of
  1157. // registered theme hooks and add those as new registered theme hooks.
  1158. // The 'pattern' key defines a common prefix that all suggestions must
  1159. // start with. The default is the name of the hook followed by '__'. An
  1160. // 'base hook' key is added to each entry made for a found suggestion,
  1161. // so that common functionality can be implemented for all suggestions of
  1162. // the same base hook. To keep things simple, deep hierarchy of
  1163. // suggestions is not supported: each suggestion's 'base hook' key
  1164. // refers to a base hook, not to another suggestion, and all suggestions
  1165. // are found using the base hook's pattern, not a pattern from an
  1166. // intermediary suggestion.
  1167. $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
  1168. if (!isset($info['base hook']) && !empty($pattern)) {
  1169. $matches = preg_grep('/^' . $prefix . '_' . $pattern . '/', $functions['user']);
  1170. if ($matches) {
  1171. foreach ($matches as $match) {
  1172. $new_hook = substr($match, strlen($prefix) + 1);
  1173. $arg_name = isset($info['variables']) ? 'variables' : 'render element';
  1174. $implementations[$new_hook] = array(
  1175. 'function' => $match,
  1176. $arg_name => $info[$arg_name],
  1177. 'base hook' => $hook,
  1178. );
  1179. }
  1180. }
  1181. }
  1182. // Find theme functions that implement registered theme hooks and include
  1183. // that in what is returned so that the registry knows that the theme has
  1184. // this implementation.
  1185. if (function_exists($prefix . '_' . $hook)) {
  1186. $implementations[$hook] = array(
  1187. 'function' => $prefix . '_' . $hook,
  1188. );
  1189. }
  1190. }
  1191. }
  1192. return $implementations;
  1193. }
  1194. /**
  1195. * Allows themes and/or theme engines to easily discover overridden templates.
  1196. *
  1197. * @param $cache
  1198. * The existing cache of theme hooks to test against.
  1199. * @param $extension
  1200. * The extension that these templates will have.
  1201. * @param $path
  1202. * The path to search.
  1203. */
  1204. function drupal_find_theme_templates($cache, $extension, $path) {
  1205. $implementations = array();
  1206. // Collect paths to all sub-themes grouped by base themes. These will be
  1207. // used for filtering. This allows base themes to have sub-themes in its
  1208. // folder hierarchy without affecting the base themes template discovery.
  1209. $theme_paths = array();
  1210. foreach (list_themes() as $theme_info) {
  1211. if (!empty($theme_info->base_theme)) {
  1212. $theme_paths[$theme_info->base_theme][$theme_info->name] = dirname($theme_info->filename);
  1213. }
  1214. }
  1215. foreach ($theme_paths as $basetheme => $subthemes) {
  1216. foreach ($subthemes as $subtheme => $subtheme_path) {
  1217. if (isset($theme_paths[$subtheme])) {
  1218. $theme_paths[$basetheme] = array_merge($theme_paths[$basetheme], $theme_paths[$subtheme]);
  1219. }
  1220. }
  1221. }
  1222. global $theme;
  1223. $subtheme_paths = isset($theme_paths[$theme]) ? $theme_paths[$theme] : array();
  1224. // Escape the periods in the extension.
  1225. $regex = '/' . str_replace('.', '\.', $extension) . '$/';
  1226. // Get a listing of all template files in the path to search.
  1227. $files = drupal_system_listing($regex, $path, 'name', 0);
  1228. // Find templates that implement registered theme hooks and include that in
  1229. // what is returned so that the registry knows that the theme has this
  1230. // implementation.
  1231. foreach ($files as $template => $file) {
  1232. // Ignore sub-theme templates for the current theme.
  1233. if (strpos($file->uri, str_replace($subtheme_paths, '', $file->uri)) !== 0) {
  1234. continue;
  1235. }
  1236. // Chop off the remaining extensions if there are any. $template already
  1237. // has the rightmost extension removed, but there might still be more,
  1238. // such as with .tpl.php, which still has .tpl in $template at this point.
  1239. if (($pos = strpos($template, '.')) !== FALSE) {
  1240. $template = substr($template, 0, $pos);
  1241. }
  1242. // Transform - in filenames to _ to match function naming scheme
  1243. // for the purposes of searching.
  1244. $hook = strtr($template, '-', '_');
  1245. if (isset($cache[$hook])) {
  1246. $implementations[$hook] = array(
  1247. 'template' => $template,
  1248. 'path' => dirname($file->uri),
  1249. );
  1250. }
  1251. }
  1252. // Find templates that implement possible "suggestion" variants of registered
  1253. // theme hooks and add those as new registered theme hooks. See
  1254. // drupal_find_theme_functions() for more information about suggestions and
  1255. // the use of 'pattern' and 'base hook'.
  1256. $patterns = array_keys($files);
  1257. foreach ($cache as $hook => $info) {
  1258. $pattern = isset($info['pattern']) ? $info['pattern'] : ($hook . '__');
  1259. if (!isset($info['base hook']) && !empty($pattern)) {
  1260. // Transform _ in pattern to - to match file naming scheme
  1261. // for the purposes of searching.
  1262. $pattern = strtr($pattern, '_', '-');
  1263. $matches = preg_grep('/^' . $pattern . '/', $patterns);
  1264. if ($matches) {
  1265. foreach ($matches as $match) {
  1266. $file = substr($match, 0, strpos($match, '.'));
  1267. // Put the underscores back in for the hook name and register this
  1268. // pattern.
  1269. $arg_name = isset($info['variables']) ? 'variables' : 'render element';
  1270. $implementations[strtr($file, '-', '_')] = array(
  1271. 'template' => $file,
  1272. 'path' => dirname($files[$match]->uri),
  1273. $arg_name => $info[$arg_name],
  1274. 'base hook' => $hook,
  1275. );
  1276. }
  1277. }
  1278. }
  1279. }
  1280. return $implementations;
  1281. }
  1282. /**
  1283. * Retrieves a setting for the current theme or for a given theme.
  1284. *
  1285. * The final setting is obtained from the last value found in the following
  1286. * sources:
  1287. * - the default global settings specified in this function
  1288. * - the default theme-specific settings defined in any base theme's .info file
  1289. * - the default theme-specific settings defined in the theme's .info file
  1290. * - the saved values from the global theme settings form
  1291. * - the saved values from the theme's settings form
  1292. * To only retrieve the default global theme setting, an empty string should be
  1293. * given for $theme.
  1294. *
  1295. * @param $setting_name
  1296. * The name of the setting to be retrieved.
  1297. * @param $theme
  1298. * The name of a given theme; defaults to the current theme.
  1299. *
  1300. * @return
  1301. * The value of the requested setting, NULL if the setting does not exist.
  1302. */
  1303. function theme_get_setting($setting_name, $theme = NULL) {
  1304. $cache = &drupal_static(__FUNCTION__, array());
  1305. // If no key is given, use the current theme if we can determine it.
  1306. if (!isset($theme)) {
  1307. $theme = !empty($GLOBALS['theme_key']) ? $GLOBALS['theme_key'] : '';
  1308. }
  1309. if (empty($cache[$theme])) {
  1310. // Set the default values for each global setting.
  1311. // To add new global settings, add their default values below, and then
  1312. // add form elements to system_theme_settings() in system.admin.inc.
  1313. $cache[$theme] = array(
  1314. 'default_logo' => 1,
  1315. 'logo_path' => '',
  1316. 'default_favicon' => 1,
  1317. 'favicon_path' => '',
  1318. // Use the IANA-registered MIME type for ICO files as default.
  1319. 'favicon_mimetype' => 'image/vnd.microsoft.icon',
  1320. );
  1321. // Turn on all default features.
  1322. $features = _system_default_theme_features();
  1323. foreach ($features as $feature) {
  1324. $cache[$theme]['toggle_' . $feature] = 1;
  1325. }
  1326. // Get the values for the theme-specific settings from the .info files of
  1327. // the theme and all its base themes.
  1328. if ($theme) {
  1329. $themes = list_themes();
  1330. $theme_object = $themes[$theme];
  1331. // Create a list which includes the current theme and all its base themes.
  1332. if (isset($theme_object->base_themes)) {
  1333. $theme_keys = array_keys($theme_object->base_themes);
  1334. $theme_keys[] = $theme;
  1335. }
  1336. else {
  1337. $theme_keys = array($theme);
  1338. }
  1339. foreach ($theme_keys as $theme_key) {
  1340. if (!empty($themes[$theme_key]->info['settings'])) {
  1341. $cache[$theme] = array_merge($cache[$theme], $themes[$theme_key]->info['settings']);
  1342. }
  1343. }
  1344. }
  1345. // Get the saved global settings from the database.
  1346. $cache[$theme] = array_merge($cache[$theme], variable_get('theme_settings', array()));
  1347. if ($theme) {
  1348. // Get the saved theme-specific settings from the database.
  1349. $cache[$theme] = array_merge($cache[$theme], variable_get('theme_' . $theme . '_settings', array()));
  1350. // If the theme does not support a particular feature, override the global
  1351. // setting and set the value to NULL.
  1352. if (!empty($theme_object->info['features'])) {
  1353. foreach ($features as $feature) {
  1354. if (!in_array($feature, $theme_object->info['features'])) {
  1355. $cache[$theme]['toggle_' . $feature] = NULL;
  1356. }
  1357. }
  1358. }
  1359. // Generate the path to the logo image.
  1360. if ($cache[$theme]['toggle_logo']) {
  1361. if ($cache[$theme]['default_logo']) {
  1362. $cache[$theme]['logo'] = file_create_url(dirname($theme_object->filename) . '/logo.png');
  1363. }
  1364. elseif ($cache[$theme]['logo_path']) {
  1365. $cache[$theme]['logo'] = file_create_url($cache[$theme]['logo_path']);
  1366. }
  1367. }
  1368. // Generate the path to the favicon.
  1369. if ($cache[$theme]['toggle_favicon']) {
  1370. if ($cache[$theme]['default_favicon']) {
  1371. if (file_exists($favicon = dirname($theme_object->filename) . '/favicon.ico')) {
  1372. $cache[$theme]['favicon'] = file_create_url($favicon);
  1373. }
  1374. else {
  1375. $cache[$theme]['favicon'] = file_create_url('misc/favicon.ico');
  1376. }
  1377. }
  1378. elseif ($cache[$theme]['favicon_path']) {
  1379. $cache[$theme]['favicon'] = file_create_url($cache[$theme]['favicon_path']);
  1380. }
  1381. else {
  1382. $cache[$theme]['toggle_favicon'] = FALSE;
  1383. }
  1384. }
  1385. }
  1386. }
  1387. return isset($cache[$theme][$setting_name]) ? $cache[$theme][$setting_name] : NULL;
  1388. }
  1389. /**
  1390. * Renders a system default template, which is essentially a PHP template.
  1391. *
  1392. * @param $template_file
  1393. * The filename of the template to render.
  1394. * @param $variables
  1395. * A keyed array of variables that will appear in the output.
  1396. *
  1397. * @return
  1398. * The output generated by the template.
  1399. */
  1400. function theme_render_template($template_file, $variables) {
  1401. // Extract the variables to a local namespace
  1402. extract($variables, EXTR_SKIP);
  1403. // Start output buffering
  1404. ob_start();
  1405. // Include the template file
  1406. include DRUPAL_ROOT . '/' . $template_file;
  1407. // End buffering and return its contents
  1408. return ob_get_clean();
  1409. }
  1410. /**
  1411. * Renders a template for any engine.
  1412. *
  1413. * Includes the possibility to get debug output by setting the
  1414. * theme_debug variable to TRUE.
  1415. *
  1416. * @param string $template_function
  1417. * The function to call for rendering the template.
  1418. * @param string $template_file
  1419. * The filename of the template to render.
  1420. * @param array $variables
  1421. * A keyed array of variables that will appear in the output.
  1422. * @param string $extension
  1423. * The extension used by the theme engine for template files.
  1424. *
  1425. * @return string
  1426. * The output generated by the template including debug information.
  1427. */
  1428. function _theme_render_template_debug($template_function, $template_file, $variables, $extension) {
  1429. $output = array(
  1430. 'debug_prefix' => '',
  1431. 'debug_info' => '',
  1432. 'rendered_markup' => call_user_func($template_function, $template_file, $variables),
  1433. 'debug_suffix' => '',
  1434. );
  1435. $output['debug_prefix'] .= "\n\n<!-- THEME DEBUG -->";
  1436. $output['debug_prefix'] .= "\n<!-- CALL: theme('" . check_plain($variables['theme_hook_original']) . "') -->";
  1437. // If there are theme suggestions, reverse the array so more specific
  1438. // suggestions are shown first.
  1439. if (!empty($variables['theme_hook_suggestions'])) {
  1440. $variables['theme_hook_suggestions'] = array_reverse($variables['theme_hook_suggestions']);
  1441. }
  1442. // Add debug output for directly called suggestions like
  1443. // '#theme' => 'comment__node__article'.
  1444. if (strpos($variables['theme_hook_original'], '__') !== FALSE) {
  1445. $derived_suggestions[] = $hook = $variables['theme_hook_original'];
  1446. while ($pos = strrpos($hook, '__')) {
  1447. $hook = substr($hook, 0, $pos);
  1448. $derived_suggestions[] = $hook;
  1449. }
  1450. // Get the value of the base hook (last derived suggestion) and append it
  1451. // to the end of all theme suggestions.
  1452. $base_hook = array_pop($derived_suggestions);
  1453. $variables['theme_hook_suggestions'] = array_merge($derived_suggestions, $variables['theme_hook_suggestions']);
  1454. $variables['theme_hook_suggestions'][] = $base_hook;
  1455. }
  1456. if (!empty($variables['theme_hook_suggestions'])) {
  1457. $current_template = basename($template_file);
  1458. $suggestions = $variables['theme_hook_suggestions'];
  1459. // Only add the original theme hook if it wasn't a directly called
  1460. // suggestion.
  1461. if (strpos($variables['theme_hook_original'], '__') === FALSE) {
  1462. $suggestions[] = $variables['theme_hook_original'];
  1463. }
  1464. foreach ($suggestions as &$suggestion) {
  1465. $template = strtr($suggestion, '_', '-') . $extension;
  1466. $prefix = ($template == $current_template) ? 'x' : '*';
  1467. $suggestion = $prefix . ' ' . $template;
  1468. }
  1469. $output['debug_info'] .= "\n<!-- FILE NAME SUGGESTIONS:\n " . check_plain(implode("\n ", $suggestions)) . "\n-->";
  1470. }
  1471. $output['debug_info'] .= "\n<!-- BEGIN OUTPUT from '" . check_plain($template_file) . "' -->\n";
  1472. $output['debug_suffix'] .= "\n<!-- END OUTPUT from '" . check_plain($template_file) . "' -->\n\n";
  1473. return implode('', $output);
  1474. }
  1475. /**
  1476. * Enables a given list of themes.
  1477. *
  1478. * @param $theme_list
  1479. * An array of theme names.
  1480. */
  1481. function theme_enable($theme_list) {
  1482. drupal_clear_css_cache();
  1483. foreach ($theme_list as $key) {
  1484. db_update('system')
  1485. ->fields(array('status' => 1))
  1486. ->condition('type', 'theme')
  1487. ->condition('name', $key)
  1488. ->execute();
  1489. }
  1490. list_themes(TRUE);
  1491. menu_rebuild();
  1492. drupal_theme_rebuild();
  1493. // Invoke hook_themes_enabled() after the themes have been enabled.
  1494. module_invoke_all('themes_enabled', $theme_list);
  1495. }
  1496. /**
  1497. * Disables a given list of themes.
  1498. *
  1499. * @param $theme_list
  1500. * An array of theme names.
  1501. */
  1502. function theme_disable($theme_list) {
  1503. // Don't disable the default theme.
  1504. if ($pos = array_search(variable_get('theme_default', 'bartik'), $theme_list) !== FALSE) {
  1505. unset($theme_list[$pos]);
  1506. if (empty($theme_list)) {
  1507. return;
  1508. }
  1509. }
  1510. drupal_clear_css_cache();
  1511. foreach ($theme_list as $key) {
  1512. db_update('system')
  1513. ->fields(array('status' => 0))
  1514. ->condition('type', 'theme')
  1515. ->condition('name', $key)
  1516. ->execute();
  1517. }
  1518. list_themes(TRUE);
  1519. menu_rebuild();
  1520. drupal_theme_rebuild();
  1521. // Invoke hook_themes_disabled after the themes have been disabled.
  1522. module_invoke_all('themes_disabled', $theme_list);
  1523. }
  1524. /**
  1525. * @addtogroup themeable
  1526. * @{
  1527. */
  1528. /**
  1529. * Returns HTML for status and/or error messages, grouped by type.
  1530. *
  1531. * An invisible heading identifies the messages for assistive technology.
  1532. * Sighted users see a colored box. See http://www.w3.org/TR/WCAG-TECHS/H69.html
  1533. * for info.
  1534. *
  1535. * @param $variables
  1536. * An associative array containing:
  1537. * - display: (optional) Set to 'status' or 'error' to display only messages
  1538. * of that type.
  1539. */
  1540. function theme_status_messages($variables) {
  1541. $display = $variables['display'];
  1542. $output = '';
  1543. $status_heading = array(
  1544. 'status' => t('Status message'),
  1545. 'error' => t('Error message'),
  1546. 'warning' => t('Warning message'),
  1547. );
  1548. foreach (drupal_get_messages($display) as $type => $messages) {
  1549. $output .= "<div class=\"messages $type\">\n";
  1550. if (!empty($status_heading[$type])) {
  1551. $output .= '<h2 class="element-invisible">' . $status_heading[$type] . "</h2>\n";
  1552. }
  1553. if (count($messages) > 1) {
  1554. $output .= " <ul>\n";
  1555. foreach ($messages as $message) {
  1556. $output .= ' <li>' . $message . "</li>\n";
  1557. }
  1558. $output .= " </ul>\n";
  1559. }
  1560. else {
  1561. $output .= reset($messages);
  1562. }
  1563. $output .= "</div>\n";
  1564. }
  1565. return $output;
  1566. }
  1567. /**
  1568. * Returns HTML for a link.
  1569. *
  1570. * All Drupal code that outputs a link should call the l() function. That
  1571. * function performs some initial preprocessing, and then, if necessary, calls
  1572. * theme('link') for rendering the anchor tag.
  1573. *
  1574. * To optimize performance for sites that don't need custom theming of links,
  1575. * the l() function includes an inline copy of this function, and uses that
  1576. * copy if none of the enabled modules or the active theme implement any
  1577. * preprocess or process functions or override this theme implementation.
  1578. *
  1579. * @param $variables
  1580. * An associative array containing the keys 'text', 'path', and 'options'.
  1581. * See the l() function for information about these variables.
  1582. *
  1583. * @see l()
  1584. */
  1585. function theme_link($variables) {
  1586. return '<a href="' . check_plain(url($variables['path'], $variables['options'])) . '"' . drupal_attributes($variables['options']['attributes']) . '>' . ($variables['options']['html'] ? $variables['text'] : check_plain($variables['text'])) . '</a>';
  1587. }
  1588. /**
  1589. * Returns HTML for a set of links.
  1590. *
  1591. * @param $variables
  1592. * An associative array containing:
  1593. * - links: An associative array of links to be themed. The key for each link
  1594. * is used as its CSS class. Each link should be itself an array, with the
  1595. * following elements:
  1596. * - title: The link text.
  1597. * - href: The link URL. If omitted, the 'title' is shown as a plain text
  1598. * item in the links list.
  1599. * - html: (optional) Whether or not 'title' is HTML. If set, the title
  1600. * will not be passed through check_plain().
  1601. * - attributes: (optional) Attributes for the anchor, or for the <span>
  1602. * tag used in its place if no 'href' is supplied. If element 'class' is
  1603. * included, it must be an array of one or more class names.
  1604. * If the 'href' element is supplied, the entire link array is passed to
  1605. * l() as its $options parameter.
  1606. * - attributes: A keyed array of attributes for the UL containing the
  1607. * list of links.
  1608. * - heading: (optional) A heading to precede the links. May be an
  1609. * associative array or a string. If it's an array, it can have the
  1610. * following elements:
  1611. * - text: The heading text.
  1612. * - level: The heading level (e.g. 'h2', 'h3').
  1613. * - class: (optional) An array of the CSS classes for the heading.
  1614. * When using a string it will be used as the text of the heading and the
  1615. * level will default to 'h2'. Headings should be used on navigation menus
  1616. * and any list of links that consistently appears on multiple pages. To
  1617. * make the heading invisible use the 'element-invisible' CSS class. Do not
  1618. * use 'display:none', which removes it from screen-readers and assistive
  1619. * technology. Headings allow screen-reader and keyboard only users to
  1620. * navigate to or skip the links. See
  1621. * http://juicystudio.com/article/screen-readers-display-none.php and
  1622. * http://www.w3.org/TR/WCAG-TECHS/H42.html for more information.
  1623. */
  1624. function theme_links($variables) {
  1625. $links = $variables['links'];
  1626. $attributes = $variables['attributes'];
  1627. $heading = $variables['heading'];
  1628. global $language_url;
  1629. $output = '';
  1630. if (count($links) > 0) {
  1631. // Treat the heading first if it is present to prepend it to the
  1632. // list of links.
  1633. if (!empty($heading)) {
  1634. if (is_string($heading)) {
  1635. // Prepare the array that will be used when the passed heading
  1636. // is a string.
  1637. $heading = array(
  1638. 'text' => $heading,
  1639. // Set the default level of the heading.
  1640. 'level' => 'h2',
  1641. );
  1642. }
  1643. $output .= '<' . $heading['level'];
  1644. if (!empty($heading['class'])) {
  1645. $output .= drupal_attributes(array('class' => $heading['class']));
  1646. }
  1647. $output .= '>' . check_plain($heading['text']) . '</' . $heading['level'] . '>';
  1648. }
  1649. $output .= '<ul' . drupal_attributes($attributes) . '>';
  1650. $num_links = count($links);
  1651. $i = 1;
  1652. foreach ($links as $key => $link) {
  1653. $class = array($key);
  1654. // Add first, last and active classes to the list of links to help out themers.
  1655. if ($i == 1) {
  1656. $class[] = 'first';
  1657. }
  1658. if ($i == $num_links) {
  1659. $class[] = 'last';
  1660. }
  1661. if (isset($link['href']) && ($link['href'] == $_GET['q'] || ($link['href'] == '<front>' && drupal_is_front_page()))
  1662. && (empty($link['language']) || $link['language']->language == $language_url->language)) {
  1663. $class[] = 'active';
  1664. }
  1665. $output .= '<li' . drupal_attributes(array('class' => $class)) . '>';
  1666. if (isset($link['href'])) {
  1667. // Pass in $link as $options, they share the same keys.
  1668. $output .= l($link['title'], $link['href'], $link);
  1669. }
  1670. elseif (!empty($link['title'])) {
  1671. // Some links are actually not links, but we wrap these in <span> for adding title and class attributes.
  1672. if (empty($link['html'])) {
  1673. $link['title'] = check_plain($link['title']);
  1674. }
  1675. $span_attributes = '';
  1676. if (isset($link['attributes'])) {
  1677. $span_attributes = drupal_attributes($link['attributes']);
  1678. }
  1679. $output .= '<span' . $span_attributes . '>' . $link['title'] . '</span>';
  1680. }
  1681. $i++;
  1682. $output .= "</li>\n";
  1683. }
  1684. $output .= '</ul>';
  1685. }
  1686. return $output;
  1687. }
  1688. /**
  1689. * Returns HTML for an image.
  1690. *
  1691. * @param $variables
  1692. * An associative array containing:
  1693. * - path: Either the path of the image file (relative to base_path()) or a
  1694. * full URL.
  1695. * - width: The width of the image (if known).
  1696. * - height: The height of the image (if known).
  1697. * - alt: The alternative text for text-based browsers. HTML 4 and XHTML 1.0
  1698. * always require an alt attribute. The HTML 5 draft allows the alt
  1699. * attribute to be omitted in some cases. Therefore, this variable defaults
  1700. * to an empty string, but can be set to NULL for the attribute to be
  1701. * omitted. Usually, neither omission nor an empty string satisfies
  1702. * accessibility requirements, so it is strongly encouraged for code
  1703. * calling theme('image') to pass a meaningful value for this variable.
  1704. * - http://www.w3.org/TR/REC-html40/struct/objects.html#h-13.8
  1705. * - http://www.w3.org/TR/xhtml1/dtds.html
  1706. * - http://dev.w3.org/html5/spec/Overview.html#alt
  1707. * - title: The title text is displayed when the image is hovered in some
  1708. * popular browsers.
  1709. * - attributes: Associative array of attributes to be placed in the img tag.
  1710. */
  1711. function theme_image($variables) {
  1712. $attributes = $variables['attributes'];
  1713. $attributes['src'] = file_create_url($variables['path']);
  1714. foreach (array('width', 'height', 'alt', 'title') as $key) {
  1715. if (isset($variables[$key])) {
  1716. $attributes[$key] = $variables[$key];
  1717. }
  1718. }
  1719. return '<img' . drupal_attributes($attributes) . ' />';
  1720. }
  1721. /**
  1722. * Returns HTML for a breadcrumb trail.
  1723. *
  1724. * @param $variables
  1725. * An associative array containing:
  1726. * - breadcrumb: An array containing the breadcrumb links.
  1727. */
  1728. function theme_breadcrumb($variables) {
  1729. $breadcrumb = $variables['breadcrumb'];
  1730. if (!empty($breadcrumb)) {
  1731. // Provide a navigational heading to give context for breadcrumb links to
  1732. // screen-reader users. Make the heading invisible with .element-invisible.
  1733. $output = '<h2 class="element-invisible">' . t('You are here') . '</h2>';
  1734. $output .= '<div class="breadcrumb">' . implode(' » ', $breadcrumb) . '</div>';
  1735. return $output;
  1736. }
  1737. }
  1738. /**
  1739. * Returns HTML for a table.
  1740. *
  1741. * @param $variables
  1742. * An associative array containing:
  1743. * - header: An array containing the table headers. Each element of the array
  1744. * can be either a localized string or an associative array with the
  1745. * following keys:
  1746. * - "data": The localized title of the table column.
  1747. * - "field": The database field represented in the table column (required
  1748. * if user is to be able to sort on this column).
  1749. * - "sort": A default sort order for this column ("asc" or "desc"). Only
  1750. * one column should be given a default sort order because table sorting
  1751. * only applies to one column at a time.
  1752. * - Any HTML attributes, such as "colspan", to apply to the column header
  1753. * cell.
  1754. * - rows: An array of table rows. Every row is an array of cells, or an
  1755. * associative array with the following keys:
  1756. * - "data": an array of cells
  1757. * - Any HTML attributes, such as "class", to apply to the table row.
  1758. * - "no_striping": a boolean indicating that the row should receive no
  1759. * 'even / odd' styling. Defaults to FALSE.
  1760. * Each cell can be either a string or an associative array with the
  1761. * following keys:
  1762. * - "data": The string to display in the table cell.
  1763. * - "header": Indicates this cell is a header.
  1764. * - Any HTML attributes, such as "colspan", to apply to the table cell.
  1765. * Here's an example for $rows:
  1766. * @code
  1767. * $rows = array(
  1768. * // Simple row
  1769. * array(
  1770. * 'Cell 1', 'Cell 2', 'Cell 3'
  1771. * ),
  1772. * // Row with attributes on the row and some of its cells.
  1773. * array(
  1774. * 'data' => array('Cell 1', array('data' => 'Cell 2', 'colspan' => 2)), 'class' => array('funky')
  1775. * )
  1776. * );
  1777. * @endcode
  1778. * - attributes: An array of HTML attributes to apply to the table tag.
  1779. * - caption: A localized string to use for the <caption> tag.
  1780. * - colgroups: An array of column groups. Each element of the array can be
  1781. * either:
  1782. * - An array of columns, each of which is an associative array of HTML
  1783. * attributes applied to the COL element.
  1784. * - An array of attributes applied to the COLGROUP element, which must
  1785. * include a "data" attribute. To add attributes to COL elements, set the
  1786. * "data" attribute with an array of columns, each of which is an
  1787. * associative array of HTML attributes.
  1788. * Here's an example for $colgroup:
  1789. * @code
  1790. * $colgroup = array(
  1791. * // COLGROUP with one COL element.
  1792. * array(
  1793. * array(
  1794. * 'class' => array('funky'), // Attribute for the COL element.
  1795. * ),
  1796. * ),
  1797. * // Colgroup with attributes and inner COL elements.
  1798. * array(
  1799. * 'data' => array(
  1800. * array(
  1801. * 'class' => array('funky'), // Attribute for the COL element.
  1802. * ),
  1803. * ),
  1804. * 'class' => array('jazzy'), // Attribute for the COLGROUP element.
  1805. * ),
  1806. * );
  1807. * @endcode
  1808. * These optional tags are used to group and set properties on columns
  1809. * within a table. For example, one may easily group three columns and
  1810. * apply same background style to all.
  1811. * - sticky: Use a "sticky" table header.
  1812. * - empty: The message to display in an extra row if table does not have any
  1813. * rows.
  1814. */
  1815. function theme_table($variables) {
  1816. $header = $variables['header'];
  1817. $rows = $variables['rows'];
  1818. $attributes = $variables['attributes'];
  1819. $caption = $variables['caption'];
  1820. $colgroups = $variables['colgroups'];
  1821. $sticky = $variables['sticky'];
  1822. $empty = $variables['empty'];
  1823. // Add sticky headers, if applicable.
  1824. if (count($header) && $sticky) {
  1825. drupal_add_js('misc/tableheader.js');
  1826. // Add 'sticky-enabled' class to the table to identify it for JS.
  1827. // This is needed to target tables constructed by this function.
  1828. $attributes['class'][] = 'sticky-enabled';
  1829. }
  1830. $output = '<table' . drupal_attributes($attributes) . ">\n";
  1831. if (isset($caption)) {
  1832. $output .= '<caption>' . $caption . "</caption>\n";
  1833. }
  1834. // Format the table columns:
  1835. if (count($colgroups)) {
  1836. foreach ($colgroups as $number => $colgroup) {
  1837. $attributes = array();
  1838. // Check if we're dealing with a simple or complex column
  1839. if (isset($colgroup['data'])) {
  1840. foreach ($colgroup as $key => $value) {
  1841. if ($key == 'data') {
  1842. $cols = $value;
  1843. }
  1844. else {
  1845. $attributes[$key] = $value;
  1846. }
  1847. }
  1848. }
  1849. else {
  1850. $cols = $colgroup;
  1851. }
  1852. // Build colgroup
  1853. if (is_array($cols) && count($cols)) {
  1854. $output .= ' <colgroup' . drupal_attributes($attributes) . '>';
  1855. $i = 0;
  1856. foreach ($cols as $col) {
  1857. $output .= ' <col' . drupal_attributes($col) . ' />';
  1858. }
  1859. $output .= " </colgroup>\n";
  1860. }
  1861. else {
  1862. $output .= ' <colgroup' . drupal_attributes($attributes) . " />\n";
  1863. }
  1864. }
  1865. }
  1866. // Add the 'empty' row message if available.
  1867. if (!count($rows) && $empty) {
  1868. $header_count = 0;
  1869. foreach ($header as $header_cell) {
  1870. if (is_array($header_cell)) {
  1871. $header_count += isset($header_cell['colspan']) ? $header_cell['colspan'] : 1;
  1872. }
  1873. else {
  1874. $header_count++;
  1875. }
  1876. }
  1877. $rows[] = array(array('data' => $empty, 'colspan' => $header_count, 'class' => array('empty', 'message')));
  1878. }
  1879. // Format the table header:
  1880. if (count($header)) {
  1881. $ts = tablesort_init($header);
  1882. // HTML requires that the thead tag has tr tags in it followed by tbody
  1883. // tags. Using ternary operator to check and see if we have any rows.
  1884. $output .= (count($rows) ? ' <thead><tr>' : ' <tr>');
  1885. foreach ($header as $cell) {
  1886. $cell = tablesort_header($cell, $header, $ts);
  1887. $output .= _theme_table_cell($cell, TRUE);
  1888. }
  1889. // Using ternary operator to close the tags based on whether or not there are rows
  1890. $output .= (count($rows) ? " </tr></thead>\n" : "</tr>\n");
  1891. }
  1892. else {
  1893. $ts = array();
  1894. }
  1895. // Format the table rows:
  1896. if (count($rows)) {
  1897. $output .= "<tbody>\n";
  1898. $flip = array('even' => 'odd', 'odd' => 'even');
  1899. $class = 'even';
  1900. foreach ($rows as $number => $row) {
  1901. // Check if we're dealing with a simple or complex row
  1902. if (isset($row['data'])) {
  1903. $cells = $row['data'];
  1904. $no_striping = isset($row['no_striping']) ? $row['no_striping'] : FALSE;
  1905. // Set the attributes array and exclude 'data' and 'no_striping'.
  1906. $attributes = $row;
  1907. unset($attributes['data']);
  1908. unset($attributes['no_striping']);
  1909. }
  1910. else {
  1911. $cells = $row;
  1912. $attributes = array();
  1913. $no_striping = FALSE;
  1914. }
  1915. if (count($cells)) {
  1916. // Add odd/even class
  1917. if (!$no_striping) {
  1918. $class = $flip[$class];
  1919. $attributes['class'][] = $class;
  1920. }
  1921. // Build row
  1922. $output .= ' <tr' . drupal_attributes($attributes) . '>';
  1923. $i = 0;
  1924. foreach ($cells as $cell) {
  1925. $cell = tablesort_cell($cell, $header, $ts, $i++);
  1926. $output .= _theme_table_cell($cell);
  1927. }
  1928. $output .= " </tr>\n";
  1929. }
  1930. }
  1931. $output .= "</tbody>\n";
  1932. }
  1933. $output .= "</table>\n";
  1934. return $output;
  1935. }
  1936. /**
  1937. * Returns HTML for a sort icon.
  1938. *
  1939. * @param $variables
  1940. * An associative array containing:
  1941. * - style: Set to either 'asc' or 'desc', this determines which icon to
  1942. * show.
  1943. */
  1944. function theme_tablesort_indicator($variables) {
  1945. if ($variables['style'] == "asc") {
  1946. return theme('image', array('path' => 'misc/arrow-asc.png', 'width' => 13, 'height' => 13, 'alt' => t('sort ascending'), 'title' => t('sort ascending')));
  1947. }
  1948. else {
  1949. return theme('image', array('path' => 'misc/arrow-desc.png', 'width' => 13, 'height' => 13, 'alt' => t('sort descending'), 'title' => t('sort descending')));
  1950. }
  1951. }
  1952. /**
  1953. * Returns HTML for a marker for new or updated content.
  1954. *
  1955. * @param $variables
  1956. * An associative array containing:
  1957. * - type: Number representing the marker type to display. See MARK_NEW,
  1958. * MARK_UPDATED, MARK_READ.
  1959. */
  1960. function theme_mark($variables) {
  1961. $type = $variables['type'];
  1962. global $user;
  1963. if ($user->uid) {
  1964. if ($type == MARK_NEW) {
  1965. return ' <span class="marker">' . t('new') . '</span>';
  1966. }
  1967. elseif ($type == MARK_UPDATED) {
  1968. return ' <span class="marker">' . t('updated') . '</span>';
  1969. }
  1970. }
  1971. }
  1972. /**
  1973. * Returns HTML for a list or nested list of items.
  1974. *
  1975. * @param $variables
  1976. * An associative array containing:
  1977. * - items: An array of items to be displayed in the list. If an item is a
  1978. * string, then it is used as is. If an item is an array, then the "data"
  1979. * element of the array is used as the contents of the list item. If an item
  1980. * is an array with a "children" element, those children are displayed in a
  1981. * nested list. All other elements are treated as attributes of the list
  1982. * item element.
  1983. * - title: The title of the list.
  1984. * - type: The type of list to return (e.g. "ul", "ol").
  1985. * - attributes: The attributes applied to the list element.
  1986. */
  1987. function theme_item_list($variables) {
  1988. $items = $variables['items'];
  1989. $title = $variables['title'];
  1990. $type = $variables['type'];
  1991. $attributes = $variables['attributes'];
  1992. // Only output the list container and title, if there are any list items.
  1993. // Check to see whether the block title exists before adding a header.
  1994. // Empty headers are not semantic and present accessibility challenges.
  1995. $output = '<div class="item-list">';
  1996. if (isset($title) && $title !== '') {
  1997. $output .= '<h3>' . $title . '</h3>';
  1998. }
  1999. if (!empty($items)) {
  2000. $output .= "<$type" . drupal_attributes($attributes) . '>';
  2001. $num_items = count($items);
  2002. $i = 0;
  2003. foreach ($items as $item) {
  2004. $attributes = array();
  2005. $children = array();
  2006. $data = '';
  2007. $i++;
  2008. if (is_array($item)) {
  2009. foreach ($item as $key => $value) {
  2010. if ($key == 'data') {
  2011. $data = $value;
  2012. }
  2013. elseif ($key == 'children') {
  2014. $children = $value;
  2015. }
  2016. else {
  2017. $attributes[$key] = $value;
  2018. }
  2019. }
  2020. }
  2021. else {
  2022. $data = $item;
  2023. }
  2024. if (count($children) > 0) {
  2025. // Render nested list.
  2026. $data .= theme_item_list(array('items' => $children, 'title' => NULL, 'type' => $type, 'attributes' => $attributes));
  2027. }
  2028. if ($i == 1) {
  2029. $attributes['class'][] = 'first';
  2030. }
  2031. if ($i == $num_items) {
  2032. $attributes['class'][] = 'last';
  2033. }
  2034. $output .= '<li' . drupal_attributes($attributes) . '>' . $data . "</li>\n";
  2035. }
  2036. $output .= "</$type>";
  2037. }
  2038. $output .= '</div>';
  2039. return $output;
  2040. }
  2041. /**
  2042. * Returns HTML for a "more help" link.
  2043. *
  2044. * @param $variables
  2045. * An associative array containing:
  2046. * - url: The URL for the link.
  2047. */
  2048. function theme_more_help_link($variables) {
  2049. return '<div class="more-help-link">' . l(t('More help'), $variables['url']) . '</div>';
  2050. }
  2051. /**
  2052. * Returns HTML for a feed icon.
  2053. *
  2054. * @param $variables
  2055. * An associative array containing:
  2056. * - url: An internal system path or a fully qualified external URL of the
  2057. * feed.
  2058. * - title: A descriptive title of the feed.
  2059. */
  2060. function theme_feed_icon($variables) {
  2061. $text = t('Subscribe to !feed-title', array('!feed-title' => $variables['title']));
  2062. if ($image = theme('image', array('path' => 'misc/feed.png', 'width' => 16, 'height' => 16, 'alt' => $text))) {
  2063. return l($image, $variables['url'], array('html' => TRUE, 'attributes' => array('class' => array('feed-icon'), 'title' => $text)));
  2064. }
  2065. }
  2066. /**
  2067. * Returns HTML for a generic HTML tag with attributes.
  2068. *
  2069. * @param $variables
  2070. * An associative array containing:
  2071. * - element: An associative array describing the tag:
  2072. * - #tag: The tag name to output. Typical tags added to the HTML HEAD:
  2073. * - meta: To provide meta information, such as a page refresh.
  2074. * - link: To refer to stylesheets and other contextual information.
  2075. * - script: To load JavaScript.
  2076. * - #attributes: (optional) An array of HTML attributes to apply to the
  2077. * tag.
  2078. * - #value: (optional) A string containing tag content, such as inline
  2079. * CSS.
  2080. * - #value_prefix: (optional) A string to prepend to #value, e.g. a CDATA
  2081. * wrapper prefix.
  2082. * - #value_suffix: (optional) A string to append to #value, e.g. a CDATA
  2083. * wrapper suffix.
  2084. */
  2085. function theme_html_tag($variables) {
  2086. $element = $variables['element'];
  2087. $attributes = isset($element['#attributes']) ? drupal_attributes($element['#attributes']) : '';
  2088. if (!isset($element['#value'])) {
  2089. return '<' . $element['#tag'] . $attributes . " />\n";
  2090. }
  2091. else {
  2092. $output = '<' . $element['#tag'] . $attributes . '>';
  2093. if (isset($element['#value_prefix'])) {
  2094. $output .= $element['#value_prefix'];
  2095. }
  2096. $output .= $element['#value'];
  2097. if (isset($element['#value_suffix'])) {
  2098. $output .= $element['#value_suffix'];
  2099. }
  2100. $output .= '</' . $element['#tag'] . ">\n";
  2101. return $output;
  2102. }
  2103. }
  2104. /**
  2105. * Returns HTML for a "more" link, like those used in blocks.
  2106. *
  2107. * @param $variables
  2108. * An associative array containing:
  2109. * - url: The URL of the main page.
  2110. * - title: A descriptive verb for the link, like 'Read more'.
  2111. */
  2112. function theme_more_link($variables) {
  2113. return '<div class="more-link">' . l(t('More'), $variables['url'], array('attributes' => array('title' => $variables['title']))) . '</div>';
  2114. }
  2115. /**
  2116. * Returns HTML for a username, potentially linked to the user's page.
  2117. *
  2118. * @param $variables
  2119. * An associative array containing:
  2120. * - account: The user object to format.
  2121. * - name: The user's name, sanitized.
  2122. * - extra: Additional text to append to the user's name, sanitized.
  2123. * - link_path: The path or URL of the user's profile page, home page, or
  2124. * other desired page to link to for more information about the user.
  2125. * - link_options: An array of options to pass to the l() function's $options
  2126. * parameter if linking the user's name to the user's page.
  2127. * - attributes_array: An array of attributes to pass to the
  2128. * drupal_attributes() function if not linking to the user's page.
  2129. *
  2130. * @see template_preprocess_username()
  2131. * @see template_process_username()
  2132. */
  2133. function theme_username($variables) {
  2134. if (isset($variables['link_path'])) {
  2135. // We have a link path, so we should generate a link using l().
  2136. // Additional classes may be added as array elements like
  2137. // $variables['link_options']['attributes']['class'][] = 'myclass';
  2138. $output = l($variables['name'] . $variables['extra'], $variables['link_path'], $variables['link_options']);
  2139. }
  2140. else {
  2141. // Modules may have added important attributes so they must be included
  2142. // in the output. Additional classes may be added as array elements like
  2143. // $variables['attributes_array']['class'][] = 'myclass';
  2144. $output = '<span' . drupal_attributes($variables['attributes_array']) . '>' . $variables['name'] . $variables['extra'] . '</span>';
  2145. }
  2146. return $output;
  2147. }
  2148. /**
  2149. * Returns HTML for a progress bar.
  2150. *
  2151. * Note that the core Batch API uses this only for non-JavaScript batch jobs.
  2152. *
  2153. * @param $variables
  2154. * An associative array containing:
  2155. * - percent: The percentage of the progress.
  2156. * - message: A string containing information to be displayed.
  2157. */
  2158. function theme_progress_bar($variables) {
  2159. $output = '<div id="progress" class="progress">';
  2160. $output .= '<div class="bar"><div class="filled" style="width: ' . $variables['percent'] . '%"></div></div>';
  2161. $output .= '<div class="percentage">' . $variables['percent'] . '%</div>';
  2162. $output .= '<div class="message">' . $variables['message'] . '</div>';
  2163. $output .= '</div>';
  2164. return $output;
  2165. }
  2166. /**
  2167. * Returns HTML for an indentation div; used for drag and drop tables.
  2168. *
  2169. * @param $variables
  2170. * An associative array containing:
  2171. * - size: Optional. The number of indentations to create.
  2172. */
  2173. function theme_indentation($variables) {
  2174. $output = '';
  2175. for ($n = 0; $n < $variables['size']; $n++) {
  2176. $output .= '<div class="indentation">&nbsp;</div>';
  2177. }
  2178. return $output;
  2179. }
  2180. /**
  2181. * @} End of "addtogroup themeable".
  2182. */
  2183. /**
  2184. * Returns HTML output for a single table cell for theme_table().
  2185. *
  2186. * @param $cell
  2187. * Array of cell information, or string to display in cell.
  2188. * @param bool $header
  2189. * TRUE if this cell is a table header cell, FALSE if it is an ordinary
  2190. * table cell. If $cell is an array with element 'header' set to TRUE, that
  2191. * will override the $header parameter.
  2192. *
  2193. * @return
  2194. * HTML for the cell.
  2195. */
  2196. function _theme_table_cell($cell, $header = FALSE) {
  2197. $attributes = '';
  2198. if (is_array($cell)) {
  2199. $data = isset($cell['data']) ? $cell['data'] : '';
  2200. // Cell's data property can be a string or a renderable array.
  2201. if (is_array($data)) {
  2202. $data = drupal_render($data);
  2203. }
  2204. $header |= isset($cell['header']);
  2205. unset($cell['data']);
  2206. unset($cell['header']);
  2207. $attributes = drupal_attributes($cell);
  2208. }
  2209. else {
  2210. $data = $cell;
  2211. }
  2212. if ($header) {
  2213. $output = "<th$attributes>$data</th>";
  2214. }
  2215. else {
  2216. $output = "<td$attributes>$data</td>";
  2217. }
  2218. return $output;
  2219. }
  2220. /**
  2221. * Adds a default set of helper variables for variable processors and templates.
  2222. *
  2223. * This function is called for theme hooks implemented as templates only, not
  2224. * for theme hooks implemented as functions. This preprocess function is the
  2225. * first in the sequence of preprocessing and processing functions that is
  2226. * called when preparing variables for a template. See theme() for more details
  2227. * about the full sequence.
  2228. *
  2229. * @see theme()
  2230. * @see template_process()
  2231. */
  2232. function template_preprocess(&$variables, $hook) {
  2233. global $user;
  2234. static $count = array();
  2235. // Track run count for each hook to provide zebra striping. See
  2236. // "template_preprocess_block()" which provides the same feature specific to
  2237. // blocks.
  2238. $count[$hook] = isset($count[$hook]) && is_int($count[$hook]) ? $count[$hook] : 1;
  2239. $variables['zebra'] = ($count[$hook] % 2) ? 'odd' : 'even';
  2240. $variables['id'] = $count[$hook]++;
  2241. // Tell all templates where they are located.
  2242. $variables['directory'] = path_to_theme();
  2243. // Initialize html class attribute for the current hook.
  2244. $variables['classes_array'] = array(drupal_html_class($hook));
  2245. // Merge in variables that don't depend on hook and don't change during a
  2246. // single page request.
  2247. // Use the advanced drupal_static() pattern, since this is called very often.
  2248. static $drupal_static_fast;
  2249. if (!isset($drupal_static_fast)) {
  2250. $drupal_static_fast['default_variables'] = &drupal_static(__FUNCTION__);
  2251. }
  2252. $default_variables = &$drupal_static_fast['default_variables'];
  2253. // Global $user object shouldn't change during a page request once rendering
  2254. // has started, but if there's an edge case where it does, re-fetch the
  2255. // variables appropriate for the new user.
  2256. if (!isset($default_variables) || ($user !== $default_variables['user'])) {
  2257. $default_variables = _template_preprocess_default_variables();
  2258. }
  2259. $variables += $default_variables;
  2260. }
  2261. /**
  2262. * Returns hook-independent variables to template_preprocess().
  2263. */
  2264. function _template_preprocess_default_variables() {
  2265. global $user;
  2266. // Variables that don't depend on a database connection.
  2267. $variables = array(
  2268. 'attributes_array' => array(),
  2269. 'title_attributes_array' => array(),
  2270. 'content_attributes_array' => array(),
  2271. 'title_prefix' => array(),
  2272. 'title_suffix' => array(),
  2273. 'user' => $user,
  2274. 'db_is_active' => !defined('MAINTENANCE_MODE'),
  2275. 'is_admin' => FALSE,
  2276. 'logged_in' => FALSE,
  2277. );
  2278. // The user object has no uid property when the database does not exist during
  2279. // install. The user_access() check deals with issues when in maintenance mode
  2280. // as uid is set but the user.module has not been included.
  2281. if (isset($user->uid) && function_exists('user_access')) {
  2282. $variables['is_admin'] = user_access('access administration pages');
  2283. $variables['logged_in'] = ($user->uid > 0);
  2284. }
  2285. // drupal_is_front_page() might throw an exception.
  2286. try {
  2287. $variables['is_front'] = drupal_is_front_page();
  2288. }
  2289. catch (Exception $e) {
  2290. // If the database is not yet available, set default values for these
  2291. // variables.
  2292. $variables['is_front'] = FALSE;
  2293. $variables['db_is_active'] = FALSE;
  2294. }
  2295. return $variables;
  2296. }
  2297. /**
  2298. * Adds helper variables derived from variables defined during preprocessing.
  2299. *
  2300. * When preparing variables for a theme hook implementation, all 'preprocess'
  2301. * functions run first, then all 'process' functions (see theme() for details
  2302. * about the full sequence).
  2303. *
  2304. * This function serializes array variables manipulated during the preprocessing
  2305. * phase into strings for convenient use by templates. As with
  2306. * template_preprocess(), this function does not get called for theme hooks
  2307. * implemented as functions.
  2308. *
  2309. * @see theme()
  2310. * @see template_preprocess()
  2311. */
  2312. function template_process(&$variables, $hook) {
  2313. // Flatten out classes.
  2314. $variables['classes'] = implode(' ', $variables['classes_array']);
  2315. // Flatten out attributes, title_attributes, and content_attributes.
  2316. // Because this function can be called very often, and often with empty
  2317. // attributes, optimize performance by only calling drupal_attributes() if
  2318. // necessary.
  2319. $variables['attributes'] = $variables['attributes_array'] ? drupal_attributes($variables['attributes_array']) : '';
  2320. $variables['title_attributes'] = $variables['title_attributes_array'] ? drupal_attributes($variables['title_attributes_array']) : '';
  2321. $variables['content_attributes'] = $variables['content_attributes_array'] ? drupal_attributes($variables['content_attributes_array']) : '';
  2322. }
  2323. /**
  2324. * Preprocess variables for html.tpl.php
  2325. *
  2326. * @see system_elements()
  2327. * @see html.tpl.php
  2328. */
  2329. function template_preprocess_html(&$variables) {
  2330. // Compile a list of classes that are going to be applied to the body element.
  2331. // This allows advanced theming based on context (home page, node of certain type, etc.).
  2332. // Add a class that tells us whether we're on the front page or not.
  2333. $variables['classes_array'][] = $variables['is_front'] ? 'front' : 'not-front';
  2334. // Add a class that tells us whether the page is viewed by an authenticated user or not.
  2335. $variables['classes_array'][] = $variables['logged_in'] ? 'logged-in' : 'not-logged-in';
  2336. // Add information about the number of sidebars.
  2337. if (!empty($variables['page']['sidebar_first']) && !empty($variables['page']['sidebar_second'])) {
  2338. $variables['classes_array'][] = 'two-sidebars';
  2339. }
  2340. elseif (!empty($variables['page']['sidebar_first'])) {
  2341. $variables['classes_array'][] = 'one-sidebar sidebar-first';
  2342. }
  2343. elseif (!empty($variables['page']['sidebar_second'])) {
  2344. $variables['classes_array'][] = 'one-sidebar sidebar-second';
  2345. }
  2346. else {
  2347. $variables['classes_array'][] = 'no-sidebars';
  2348. }
  2349. // Populate the body classes.
  2350. if ($suggestions = theme_get_suggestions(arg(), 'page', '-')) {
  2351. foreach ($suggestions as $suggestion) {
  2352. if ($suggestion != 'page-front') {
  2353. // Add current suggestion to page classes to make it possible to theme
  2354. // the page depending on the current page type (e.g. node, admin, user,
  2355. // etc.) as well as more specific data like node-12 or node-edit.
  2356. $variables['classes_array'][] = drupal_html_class($suggestion);
  2357. }
  2358. }
  2359. }
  2360. // If on an individual node page, add the node type to body classes.
  2361. if ($node = menu_get_object()) {
  2362. $variables['classes_array'][] = drupal_html_class('node-type-' . $node->type);
  2363. }
  2364. // RDFa allows annotation of XHTML pages with RDF data, while GRDDL provides
  2365. // mechanisms for extraction of this RDF content via XSLT transformation
  2366. // using an associated GRDDL profile.
  2367. $variables['rdf_namespaces'] = drupal_get_rdf_namespaces();
  2368. $variables['grddl_profile'] = 'http://www.w3.org/1999/xhtml/vocab';
  2369. $variables['language'] = $GLOBALS['language'];
  2370. $variables['language']->dir = $GLOBALS['language']->direction ? 'rtl' : 'ltr';
  2371. // Add favicon.
  2372. if (theme_get_setting('toggle_favicon')) {
  2373. $favicon = theme_get_setting('favicon');
  2374. $type = theme_get_setting('favicon_mimetype');
  2375. drupal_add_html_head_link(array('rel' => 'shortcut icon', 'href' => drupal_strip_dangerous_protocols($favicon), 'type' => $type));
  2376. }
  2377. // Construct page title.
  2378. if (drupal_get_title()) {
  2379. $head_title = array(
  2380. 'title' => strip_tags(drupal_get_title()),
  2381. 'name' => check_plain(variable_get('site_name', 'Drupal')),
  2382. );
  2383. }
  2384. else {
  2385. $head_title = array('name' => check_plain(variable_get('site_name', 'Drupal')));
  2386. if (variable_get('site_slogan', '')) {
  2387. $head_title['slogan'] = filter_xss_admin(variable_get('site_slogan', ''));
  2388. }
  2389. }
  2390. $variables['head_title_array'] = $head_title;
  2391. $variables['head_title'] = implode(' | ', $head_title);
  2392. // Populate the page template suggestions.
  2393. if ($suggestions = theme_get_suggestions(arg(), 'html')) {
  2394. $variables['theme_hook_suggestions'] = $suggestions;
  2395. }
  2396. }
  2397. /**
  2398. * Preprocess variables for page.tpl.php
  2399. *
  2400. * Most themes utilize their own copy of page.tpl.php. The default is located
  2401. * inside "modules/system/page.tpl.php". Look in there for the full list of
  2402. * variables.
  2403. *
  2404. * Uses the arg() function to generate a series of page template suggestions
  2405. * based on the current path.
  2406. *
  2407. * Any changes to variables in this preprocessor should also be changed inside
  2408. * template_preprocess_maintenance_page() to keep all of them consistent.
  2409. *
  2410. * @see drupal_render_page()
  2411. * @see template_process_page()
  2412. * @see page.tpl.php
  2413. */
  2414. function template_preprocess_page(&$variables) {
  2415. // Move some variables to the top level for themer convenience and template cleanliness.
  2416. $variables['show_messages'] = $variables['page']['#show_messages'];
  2417. foreach (system_region_list($GLOBALS['theme']) as $region_key => $region_name) {
  2418. if (!isset($variables['page'][$region_key])) {
  2419. $variables['page'][$region_key] = array();
  2420. }
  2421. if ($region_content = drupal_get_region_content($region_key)) {
  2422. $variables['page'][$region_key][]['#markup'] = $region_content;
  2423. }
  2424. }
  2425. // Set up layout variable.
  2426. $variables['layout'] = 'none';
  2427. if (!empty($variables['page']['sidebar_first'])) {
  2428. $variables['layout'] = 'first';
  2429. }
  2430. if (!empty($variables['page']['sidebar_second'])) {
  2431. $variables['layout'] = ($variables['layout'] == 'first') ? 'both' : 'second';
  2432. }
  2433. $variables['base_path'] = base_path();
  2434. $variables['front_page'] = url();
  2435. $variables['feed_icons'] = drupal_get_feeds();
  2436. $variables['language'] = $GLOBALS['language'];
  2437. $variables['language']->dir = $GLOBALS['language']->direction ? 'rtl' : 'ltr';
  2438. $variables['logo'] = theme_get_setting('logo');
  2439. $variables['main_menu'] = theme_get_setting('toggle_main_menu') ? menu_main_menu() : array();
  2440. $variables['secondary_menu'] = theme_get_setting('toggle_secondary_menu') ? menu_secondary_menu() : array();
  2441. $variables['action_links'] = menu_local_actions();
  2442. $variables['site_name'] = (theme_get_setting('toggle_name') ? filter_xss_admin(variable_get('site_name', 'Drupal')) : '');
  2443. $variables['site_slogan'] = (theme_get_setting('toggle_slogan') ? filter_xss_admin(variable_get('site_slogan', '')) : '');
  2444. $variables['tabs'] = menu_local_tabs();
  2445. if ($node = menu_get_object()) {
  2446. $variables['node'] = $node;
  2447. }
  2448. // Populate the page template suggestions.
  2449. if ($suggestions = theme_get_suggestions(arg(), 'page')) {
  2450. $variables['theme_hook_suggestions'] = $suggestions;
  2451. }
  2452. }
  2453. /**
  2454. * Process variables for page.tpl.php
  2455. *
  2456. * Perform final addition of variables before passing them into the template.
  2457. * To customize these variables, simply set them in an earlier step.
  2458. *
  2459. * @see template_preprocess_page()
  2460. * @see page.tpl.php
  2461. */
  2462. function template_process_page(&$variables) {
  2463. if (!isset($variables['breadcrumb'])) {
  2464. // Build the breadcrumb last, so as to increase the chance of being able to
  2465. // re-use the cache of an already rendered menu containing the active link
  2466. // for the current page.
  2467. // @see menu_tree_page_data()
  2468. $variables['breadcrumb'] = theme('breadcrumb', array('breadcrumb' => drupal_get_breadcrumb()));
  2469. }
  2470. if (!isset($variables['title'])) {
  2471. $variables['title'] = drupal_get_title();
  2472. }
  2473. // Generate messages last in order to capture as many as possible for the
  2474. // current page.
  2475. if (!isset($variables['messages'])) {
  2476. $variables['messages'] = $variables['show_messages'] ? theme('status_messages') : '';
  2477. }
  2478. }
  2479. /**
  2480. * Process variables for html.tpl.php
  2481. *
  2482. * Perform final addition and modification of variables before passing into
  2483. * the template. To customize these variables, call drupal_render() on elements
  2484. * in $variables['page'] during THEME_preprocess_page().
  2485. *
  2486. * @see template_preprocess_html()
  2487. * @see html.tpl.php
  2488. */
  2489. function template_process_html(&$variables) {
  2490. // Render page_top and page_bottom into top level variables.
  2491. $variables['page_top'] = drupal_render($variables['page']['page_top']);
  2492. $variables['page_bottom'] = drupal_render($variables['page']['page_bottom']);
  2493. // Place the rendered HTML for the page body into a top level variable.
  2494. $variables['page'] = $variables['page']['#children'];
  2495. $variables['page_bottom'] .= drupal_get_js('footer');
  2496. $variables['head'] = drupal_get_html_head();
  2497. $variables['css'] = drupal_add_css();
  2498. $variables['styles'] = drupal_get_css();
  2499. $variables['scripts'] = drupal_get_js();
  2500. }
  2501. /**
  2502. * Generate an array of suggestions from path arguments.
  2503. *
  2504. * This is typically called for adding to the 'theme_hook_suggestions' or
  2505. * 'classes_array' variables from within preprocess functions, when wanting to
  2506. * base the additional suggestions on the path of the current page.
  2507. *
  2508. * @param $args
  2509. * An array of path arguments, such as from function arg().
  2510. * @param $base
  2511. * A string identifying the base 'thing' from which more specific suggestions
  2512. * are derived. For example, 'page' or 'html'.
  2513. * @param $delimiter
  2514. * The string used to delimit increasingly specific information. The default
  2515. * of '__' is appropriate for theme hook suggestions. '-' is appropriate for
  2516. * extra classes.
  2517. *
  2518. * @return
  2519. * An array of suggestions, suitable for adding to
  2520. * $variables['theme_hook_suggestions'] within a preprocess function or to
  2521. * $variables['classes_array'] if the suggestions represent extra CSS classes.
  2522. */
  2523. function theme_get_suggestions($args, $base, $delimiter = '__') {
  2524. // Build a list of suggested theme hooks or body classes in order of
  2525. // specificity. One suggestion is made for every element of the current path,
  2526. // though numeric elements are not carried to subsequent suggestions. For
  2527. // example, for $base='page', http://www.example.com/node/1/edit would result
  2528. // in the following suggestions and body classes:
  2529. //
  2530. // page__node page-node
  2531. // page__node__% page-node-%
  2532. // page__node__1 page-node-1
  2533. // page__node__edit page-node-edit
  2534. $suggestions = array();
  2535. $prefix = $base;
  2536. foreach ($args as $arg) {
  2537. // Remove slashes or null per SA-CORE-2009-003 and change - (hyphen) to _
  2538. // (underscore).
  2539. //
  2540. // When we discover templates in @see drupal_find_theme_templates,
  2541. // hyphens (-) are converted to underscores (_) before the theme hook
  2542. // is registered. We do this because the hyphens used for delimiters
  2543. // in hook suggestions cannot be used in the function names of the
  2544. // associated preprocess functions. Any page templates designed to be used
  2545. // on paths that contain a hyphen are also registered with these hyphens
  2546. // converted to underscores so here we must convert any hyphens in path
  2547. // arguments to underscores here before fetching theme hook suggestions
  2548. // to ensure the templates are appropriately recognized.
  2549. $arg = str_replace(array("/", "\\", "\0", '-'), array('', '', '', '_'), $arg);
  2550. // The percent acts as a wildcard for numeric arguments since
  2551. // asterisks are not valid filename characters on many filesystems.
  2552. if (is_numeric($arg)) {
  2553. $suggestions[] = $prefix . $delimiter . '%';
  2554. }
  2555. $suggestions[] = $prefix . $delimiter . $arg;
  2556. if (!is_numeric($arg)) {
  2557. $prefix .= $delimiter . $arg;
  2558. }
  2559. }
  2560. if (drupal_is_front_page()) {
  2561. // Front templates should be based on root only, not prefixed arguments.
  2562. $suggestions[] = $base . $delimiter . 'front';
  2563. }
  2564. return $suggestions;
  2565. }
  2566. /**
  2567. * Process variables for maintenance-page.tpl.php.
  2568. *
  2569. * The variables array generated here is a mirror of
  2570. * template_preprocess_page(). This preprocessor will run its course when
  2571. * theme_maintenance_page() is invoked. An alternate template file of
  2572. * maintenance-page--offline.tpl.php can be used when the database is offline to
  2573. * hide errors and completely replace the content.
  2574. *
  2575. * The $variables array contains the following arguments:
  2576. * - $content
  2577. *
  2578. * @see maintenance-page.tpl.php
  2579. */
  2580. function template_preprocess_maintenance_page(&$variables) {
  2581. // Add favicon
  2582. if (theme_get_setting('toggle_favicon')) {
  2583. $favicon = theme_get_setting('favicon');
  2584. $type = theme_get_setting('favicon_mimetype');
  2585. drupal_add_html_head_link(array('rel' => 'shortcut icon', 'href' => drupal_strip_dangerous_protocols($favicon), 'type' => $type));
  2586. }
  2587. global $theme;
  2588. // Retrieve the theme data to list all available regions.
  2589. $theme_data = list_themes();
  2590. $regions = $theme_data[$theme]->info['regions'];
  2591. // Get all region content set with drupal_add_region_content().
  2592. foreach (array_keys($regions) as $region) {
  2593. // Assign region to a region variable.
  2594. $region_content = drupal_get_region_content($region);
  2595. isset($variables[$region]) ? $variables[$region] .= $region_content : $variables[$region] = $region_content;
  2596. }
  2597. // Setup layout variable.
  2598. $variables['layout'] = 'none';
  2599. if (!empty($variables['sidebar_first'])) {
  2600. $variables['layout'] = 'first';
  2601. }
  2602. if (!empty($variables['sidebar_second'])) {
  2603. $variables['layout'] = ($variables['layout'] == 'first') ? 'both' : 'second';
  2604. }
  2605. // Construct page title
  2606. if (drupal_get_title()) {
  2607. $head_title = array(
  2608. 'title' => strip_tags(drupal_get_title()),
  2609. 'name' => variable_get('site_name', 'Drupal'),
  2610. );
  2611. }
  2612. else {
  2613. $head_title = array('name' => variable_get('site_name', 'Drupal'));
  2614. if (variable_get('site_slogan', '')) {
  2615. $head_title['slogan'] = variable_get('site_slogan', '');
  2616. }
  2617. }
  2618. // set the default language if necessary
  2619. $language = isset($GLOBALS['language']) ? $GLOBALS['language'] : language_default();
  2620. $variables['head_title_array'] = $head_title;
  2621. $variables['head_title'] = implode(' | ', $head_title);
  2622. $variables['base_path'] = base_path();
  2623. $variables['front_page'] = url();
  2624. $variables['breadcrumb'] = '';
  2625. $variables['feed_icons'] = '';
  2626. $variables['help'] = '';
  2627. $variables['language'] = $language;
  2628. $variables['language']->dir = $language->direction ? 'rtl' : 'ltr';
  2629. $variables['logo'] = theme_get_setting('logo');
  2630. $variables['messages'] = $variables['show_messages'] ? theme('status_messages') : '';
  2631. $variables['main_menu'] = array();
  2632. $variables['secondary_menu'] = array();
  2633. $variables['site_name'] = (theme_get_setting('toggle_name') ? variable_get('site_name', 'Drupal') : '');
  2634. $variables['site_slogan'] = (theme_get_setting('toggle_slogan') ? variable_get('site_slogan', '') : '');
  2635. $variables['tabs'] = '';
  2636. $variables['title'] = drupal_get_title();
  2637. // Compile a list of classes that are going to be applied to the body element.
  2638. $variables['classes_array'][] = 'in-maintenance';
  2639. if (isset($variables['db_is_active']) && !$variables['db_is_active']) {
  2640. $variables['classes_array'][] = 'db-offline';
  2641. }
  2642. if ($variables['layout'] == 'both') {
  2643. $variables['classes_array'][] = 'two-sidebars';
  2644. }
  2645. elseif ($variables['layout'] == 'none') {
  2646. $variables['classes_array'][] = 'no-sidebars';
  2647. }
  2648. else {
  2649. $variables['classes_array'][] = 'one-sidebar sidebar-' . $variables['layout'];
  2650. }
  2651. // Dead databases will show error messages so supplying this template will
  2652. // allow themers to override the page and the content completely.
  2653. if (isset($variables['db_is_active']) && !$variables['db_is_active']) {
  2654. $variables['theme_hook_suggestion'] = 'maintenance_page__offline';
  2655. }
  2656. }
  2657. /**
  2658. * Theme process function for theme_maintenance_field().
  2659. *
  2660. * The variables array generated here is a mirror of template_process_html().
  2661. * This processor will run its course when theme_maintenance_page() is invoked.
  2662. *
  2663. * @see maintenance-page.tpl.php
  2664. * @see template_process_html()
  2665. */
  2666. function template_process_maintenance_page(&$variables) {
  2667. $variables['head'] = drupal_get_html_head();
  2668. $variables['css'] = drupal_add_css();
  2669. $variables['styles'] = drupal_get_css();
  2670. $variables['scripts'] = drupal_get_js();
  2671. }
  2672. /**
  2673. * Preprocess variables for region.tpl.php
  2674. *
  2675. * Prepares the values passed to the theme_region function to be passed into a
  2676. * pluggable template engine. Uses the region name to generate a template file
  2677. * suggestions. If none are found, the default region.tpl.php is used.
  2678. *
  2679. * @see drupal_region_class()
  2680. * @see region.tpl.php
  2681. */
  2682. function template_preprocess_region(&$variables) {
  2683. // Create the $content variable that templates expect.
  2684. $variables['content'] = $variables['elements']['#children'];
  2685. $variables['region'] = $variables['elements']['#region'];
  2686. $variables['classes_array'][] = drupal_region_class($variables['region']);
  2687. $variables['theme_hook_suggestions'][] = 'region__' . $variables['region'];
  2688. }
  2689. /**
  2690. * Preprocesses variables for theme_username().
  2691. *
  2692. * Modules that make any changes to variables like 'name' or 'extra' must insure
  2693. * that the final string is safe to include directly in the output by using
  2694. * check_plain() or filter_xss().
  2695. *
  2696. * @see template_process_username()
  2697. */
  2698. function template_preprocess_username(&$variables) {
  2699. $account = $variables['account'];
  2700. $variables['extra'] = '';
  2701. if (empty($account->uid)) {
  2702. $variables['uid'] = 0;
  2703. if (theme_get_setting('toggle_comment_user_verification')) {
  2704. $variables['extra'] = ' (' . t('not verified') . ')';
  2705. }
  2706. }
  2707. else {
  2708. $variables['uid'] = (int) $account->uid;
  2709. }
  2710. // Set the name to a formatted name that is safe for printing and
  2711. // that won't break tables by being too long. Keep an unshortened,
  2712. // unsanitized version, in case other preprocess functions want to implement
  2713. // their own shortening logic or add markup. If they do so, they must ensure
  2714. // that $variables['name'] is safe for printing.
  2715. $name = $variables['name_raw'] = format_username($account);
  2716. if (drupal_strlen($name) > 20) {
  2717. $name = drupal_substr($name, 0, 15) . '...';
  2718. }
  2719. $variables['name'] = check_plain($name);
  2720. $variables['profile_access'] = user_access('access user profiles');
  2721. $variables['link_attributes'] = array();
  2722. // Populate link path and attributes if appropriate.
  2723. if ($variables['uid'] && $variables['profile_access']) {
  2724. // We are linking to a local user.
  2725. $variables['link_attributes'] = array('title' => t('View user profile.'));
  2726. $variables['link_path'] = 'user/' . $variables['uid'];
  2727. }
  2728. elseif (!empty($account->homepage)) {
  2729. // Like the 'class' attribute, the 'rel' attribute can hold a
  2730. // space-separated set of values, so initialize it as an array to make it
  2731. // easier for other preprocess functions to append to it.
  2732. $variables['link_attributes'] = array('rel' => array('nofollow'));
  2733. $variables['link_path'] = $account->homepage;
  2734. $variables['homepage'] = $account->homepage;
  2735. }
  2736. // We do not want the l() function to check_plain() a second time.
  2737. $variables['link_options']['html'] = TRUE;
  2738. // Set a default class.
  2739. $variables['attributes_array'] = array('class' => array('username'));
  2740. }
  2741. /**
  2742. * Processes variables for theme_username().
  2743. *
  2744. * @see template_preprocess_username()
  2745. */
  2746. function template_process_username(&$variables) {
  2747. // Finalize the link_options array for passing to the l() function.
  2748. // This is done in the process phase so that attributes may be added by
  2749. // modules or the theme during the preprocess phase.
  2750. if (isset($variables['link_path'])) {
  2751. // $variables['attributes_array'] contains attributes that should be applied
  2752. // regardless of whether a link is being rendered or not.
  2753. // $variables['link_attributes'] contains attributes that should only be
  2754. // applied if a link is being rendered. Preprocess functions are encouraged
  2755. // to use the former unless they want to add attributes on the link only.
  2756. // If a link is being rendered, these need to be merged. Some attributes are
  2757. // themselves arrays, so the merging needs to be recursive.
  2758. $variables['link_options']['attributes'] = array_merge_recursive($variables['link_attributes'], $variables['attributes_array']);
  2759. }
  2760. }

Functions

Namesort descending Description
drupal_find_base_themes Find all the base themes for the specified theme.
drupal_find_theme_functions Allows themes and/or theme engines to discover overridden theme functions.
drupal_find_theme_templates Allows themes and/or theme engines to easily discover overridden templates.
drupal_theme_access Determines if a theme is available to use.
drupal_theme_initialize Initializes the theme system by loading the theme.
drupal_theme_rebuild Forces the system to rebuild the theme registry.
list_themes Returns a list of all currently available themes.
path_to_theme Returns the path to the current themed element.
template_preprocess Adds a default set of helper variables for variable processors and templates.
template_preprocess_html Preprocess variables for html.tpl.php
template_preprocess_maintenance_page Process variables for maintenance-page.tpl.php.
template_preprocess_page Preprocess variables for page.tpl.php
template_preprocess_region Preprocess variables for region.tpl.php
template_preprocess_username Preprocesses variables for theme_username().
template_process Adds helper variables derived from variables defined during preprocessing.
template_process_html Process variables for html.tpl.php
template_process_maintenance_page Theme process function for theme_maintenance_field().
template_process_page Process variables for page.tpl.php
template_process_username Processes variables for theme_username().
theme Generates themed output.
theme_breadcrumb Returns HTML for a breadcrumb trail.
theme_disable Disables a given list of themes.
theme_enable Enables a given list of themes.
theme_feed_icon Returns HTML for a feed icon.
theme_get_registry Gets the theme registry.
theme_get_setting Retrieves a setting for the current theme or for a given theme.
theme_get_suggestions Generate an array of suggestions from path arguments.
theme_html_tag Returns HTML for a generic HTML tag with attributes.
theme_image Returns HTML for an image.
theme_indentation Returns HTML for an indentation div; used for drag and drop tables.
theme_item_list Returns HTML for a list or nested list of items.
theme_link Returns HTML for a link.
theme_links Returns HTML for a set of links.
theme_mark Returns HTML for a marker for new or updated content.
theme_more_help_link Returns HTML for a "more help" link.
theme_more_link Returns HTML for a "more" link, like those used in blocks.
theme_progress_bar Returns HTML for a progress bar.
theme_render_template Renders a system default template, which is essentially a PHP template.
theme_status_messages Returns HTML for status and/or error messages, grouped by type.
theme_table Returns HTML for a table.
theme_tablesort_indicator Returns HTML for a sort icon.
theme_username Returns HTML for a username, potentially linked to the user's page.
_drupal_theme_access Helper function for determining access to a theme.
_drupal_theme_initialize Initializes the theme system given already loaded information.
_template_preprocess_default_variables Returns hook-independent variables to template_preprocess().
_theme_build_registry Builds the theme registry cache.
_theme_load_registry Gets the theme_registry cache; if it doesn't exist, builds it.
_theme_process_registry Process a single implementation of hook_theme().
_theme_registry_callback Sets the callback that will be used by theme_get_registry().
_theme_render_template_debug Renders a template for any engine.
_theme_save_registry Writes the theme_registry cache into the database.
_theme_table_cell Returns HTML output for a single table cell for theme_table().

Constants

Namesort descending Description
MARK_NEW Mark content as being new.
MARK_READ Mark content as read.
MARK_UPDATED Mark content as being updated.

Classes

Namesort descending Description
ThemeRegistry Builds the run-time theme registry.