Binary files ../drupal-themeswo/.DS_Store and ./.DS_Store differ
diff -urNp ../drupal-themeswo/includes/bootstrap.inc ./includes/bootstrap.inc
--- ../drupal-themeswo/includes/bootstrap.inc 2007-03-28 07:08:21.000000000 -0700
+++ ./includes/bootstrap.inc 2007-03-31 12:13:22.000000000 -0700
@@ -922,6 +922,9 @@ function drupal_maintenance_theme() {
drupal_add_css(drupal_get_path('module', 'system') .'/defaults.css', 'module');
drupal_add_css(drupal_get_path('module', 'system') .'/system.css', 'module');
$theme = '';
+
+ // Special case registry of theme functions used by the installer
+ _theme_set_registry(drupal_common_themes());
}
/**
diff -urNp ../drupal-themeswo/includes/common.inc ./includes/common.inc
--- ../drupal-themeswo/includes/common.inc 2007-03-29 16:17:15.000000000 -0700
+++ ./includes/common.inc 2007-03-31 13:24:03.000000000 -0700
@@ -2311,3 +2311,258 @@ function int2vancode($i = 0) {
$length = strlen($num);
return chr($length + ord('0') - 1) . $num;
}
+
+/**
+ * Provide theme registration for themes across .inc files.
+ */
+function drupal_common_themes() {
+ return array(
+ // theme.inc
+ 'placeholder' => array(
+ 'function' => 'theme_placeholder',
+ 'arguments' => array('text' => NULL)
+ ),
+ 'page' => array(
+ 'function' => 'theme_page',
+ 'file' => 'theme.base.inc',
+ 'path' => 'includes',
+ 'arguments' => array('content' => NULL, 'show_blocks' => TRUE),
+ ),
+ 'maintenance_page' => array(
+ 'function' => 'theme_maintenance_page',
+ 'arguments' => array('content' => NULL, 'messages' => TRUE),
+ ),
+ 'install_page' => array(
+ 'function' => 'theme_install_page',
+ 'arguments' => array('content' => NULL),
+ ),
+ 'task_list' => array(
+ 'function' => 'theme_task_list',
+ 'arguments' => array('items' => NULL, 'active' => NULL),
+ ),
+ 'status_messages' => array(
+ 'function' => 'theme_status_messages',
+ 'arguments' => array('display' => NULL),
+ ),
+ 'links' => array(
+ 'function' => 'theme_links',
+ 'arguments' => array('links' => NULL, 'attributes' => array('class' => 'links')),
+ ),
+ 'image' => array(
+ 'function' => 'theme_image',
+ 'arguments' => array('path' => NULL, 'alt' => '', 'title' => '', 'attributes' => NULL, 'getsize' => TRUE),
+ ),
+ 'breadcrumb' => array(
+ 'function' => 'theme_breadcrumb',
+ 'arguments' => array('breadcrumb' => NULL),
+ ),
+ 'help' => array(
+ 'function' => 'theme_help',
+ 'arguments' => array(),
+ ),
+ 'node' => array(
+ 'function' => 'theme_node',
+ 'file' => 'theme.base.inc',
+ 'path' => 'includes',
+ 'arguments' => array('node' => NULL, 'teaser' => FALSE, 'page' => FALSE),
+ ),
+ 'submenu' => array(
+ 'function' => 'theme_submenu',
+ 'arguments' => array('links' => NULL),
+ ),
+ 'table' => array(
+ 'function' => 'theme_table',
+ 'arguments' => array('header' => NULL, 'rows' => NULL, 'attributes' => array(), 'caption' => NULL),
+ ),
+ 'table_select_header_cell' => array(
+ 'function' => 'theme_table_select_header_cell',
+ 'arguments' => array(),
+ ),
+ 'tablesort_indicator' => array(
+ 'function' => 'theme_tablesort_indicator',
+ 'arguments' => array('style' => NULL),
+ ),
+ 'box' => array(
+ 'function' => 'theme_box',
+ 'arguments' => array('title' => NULL, 'content' => NULL, 'region' => 'main'),
+ ),
+ 'block' => array(
+ 'function' => 'theme_block',
+ 'file' => 'theme.base.inc',
+ 'path' => 'includes',
+ 'arguments' => array('block' => NULL),
+ ),
+ 'mark' => array(
+ 'function' => 'theme_mark',
+ 'arguments' => array('type' => MARK_NEW),
+ ),
+ 'item_list' => array(
+ 'function' => 'theme_item_list',
+ 'arguments' => array('items' => array(), 'title' => NULL, 'type' => 'ul', 'attributes' => NULL),
+ ),
+ 'more_help_link' => array(
+ 'function' => 'theme_more_help_link',
+ 'arguments' => array('url' => NULL),
+ ),
+ 'xml_icon' => array(
+ 'function' => 'theme_xml_icon',
+ 'arguments' => array('url' => NULL),
+ ),
+ 'feed_icon' => array(
+ 'function' => 'theme_feed_icon',
+ 'arguments' => array('url' => NULL),
+ ),
+ 'closure' => array(
+ 'function' => 'theme_closure',
+ 'arguments' => array('main' => 0),
+ ),
+ 'blocks' => array(
+ 'function' => 'theme_blocks',
+ 'arguments' => array('region' => NULL),
+ ),
+ 'username' => array(
+ 'function' => 'theme_username',
+ 'arguments' => array('object' => NULL),
+ ),
+ 'progress_bar' => array(
+ 'function' => 'theme_progress_bar',
+ 'arguments' => array('percent' => NULL, 'message' => NULL),
+ ),
+ // from pager.inc
+ 'pager' => array(
+ 'function' => 'theme_pager',
+ 'arguments' => array('tags' => array(), 'limit' => 10, 'element' => 0, 'parameters' => array()),
+ ),
+ 'pager_first' => array(
+ 'function' => 'theme_pager_first',
+ 'arguments' => array('text' => NULL, 'limit' => NULL, 'element' => 0, 'parameters' => array()),
+ ),
+ 'pager_previous' => array(
+ 'function' => 'theme_pager_previous',
+ 'arguments' => array('text' => NULL, 'limit' => NULL, 'element' => 0, 'interval' => 1, 'parameters' => array()),
+ ),
+ 'pager_next' => array(
+ 'function' => 'theme_pager_next',
+ 'arguments' => array('text' => NULL, 'limit' => NULL, 'element' => 0, 'interval' => 1, 'parameters' => array()),
+ ),
+ 'pager_last' => array(
+ 'function' => 'theme_pager_last',
+ 'arguments' => array('text' => NULL, 'limit' => NULL, 'element' => 0, 'parameters' => array()),
+ ),
+ 'pager_list' => array(
+ 'function' => 'theme_pager_list',
+ 'arguments' => array('limit' => NULL, 'element' => 0, 'quantity' => 5, 'text' => '', 'parameters' => array()),
+ ),
+ 'pager_link' => array(
+ 'function' => 'theme_pager_link',
+ 'arguments' => array('text' => NULL, 'page_new' => NULL, 'element' => NULL, 'parameters' => array(), 'attributes' => array()),
+ ),
+ // from locale.inc
+ 'locale_admin_manage_screen' => array(
+ 'function' => 'theme_locale_admin_manage_screen',
+ 'arguments' => array('form' => NULL),
+ ),
+ // from menu.inc
+ 'menu_item_link' => array(
+ 'function' => 'theme_menu_item_link',
+ 'arguments' => array('item' => NULL),
+ ),
+ 'menu_tree' => array(
+ 'function' => 'theme_menu_tree',
+ 'arguments' => array('tree' => NULL),
+ ),
+ 'menu_item' => array(
+ 'function' => 'theme_menu_item',
+ 'arguments' => array('link' => NULL, 'has_children' => NULL, 'menu' => ''),
+ ),
+ 'menu_local_task' => array(
+ 'function' => 'theme_menu_local_task',
+ 'arguments' => array('link' => NULL, 'active' => FALSE),
+ ),
+ 'menu_local_tasks' => array(
+ 'function' => 'theme_menu_local_tasks',
+ 'arguments' => array(),
+ ),
+ // from form.inc
+ 'select' => array(
+ 'function' => 'theme_select',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'fieldset' => array(
+ 'function' => 'theme_fieldset',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'radio' => array(
+ 'function' => 'theme_radio',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'radios' => array(
+ 'function' => 'theme_radios',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'password_confirm' => array(
+ 'function' => 'theme_password_confirm',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'date' => array(
+ 'function' => 'theme_date',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'item' => array(
+ 'function' => 'theme_item',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'checkbox' => array(
+ 'function' => 'theme_checkbox',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'checkboxes' => array(
+ 'function' => 'theme_checkboxes',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'submit' => array(
+ 'function' => 'theme_submit',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'button' => array(
+ 'function' => 'theme_button',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'hidden' => array(
+ 'function' => 'theme_hidden',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'token' => array(
+ 'function' => 'theme_token',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'textfield' => array(
+ 'function' => 'theme_textfield',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'form' => array(
+ 'function' => 'theme_form',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'textarea' => array(
+ 'function' => 'theme_textarea',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'markup' => array(
+ 'function' => 'theme_markup',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'password' => array(
+ 'function' => 'theme_password',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'file' => array(
+ 'function' => 'theme_file',
+ 'arguments' => array('element' => NULL),
+ ),
+ 'form_element' => array(
+ 'function' => 'theme_form_element',
+ 'arguments' => array('element' => NULL, 'value' => NULL),
+ ),
+ );
+}
diff -urNp ../drupal-themeswo/includes/form.inc ./includes/form.inc
--- ../drupal-themeswo/includes/form.inc 2007-03-26 22:13:53.000000000 -0700
+++ ./includes/form.inc 2007-03-31 12:13:22.000000000 -0700
@@ -457,7 +457,9 @@ function drupal_render_form($form_id, &$
// Don't override #theme if someone already set it.
if (!isset($form['#theme'])) {
- if (theme_get_function($form_id)) {
+ init_theme();
+ $registry = theme_get_registry();
+ if (isset($registry[$form_id])) {
$form['#theme'] = $form_id;
}
}
diff -urNp ../drupal-themeswo/includes/menu.inc ./includes/menu.inc
--- ../drupal-themeswo/includes/menu.inc 2007-03-26 22:13:53.000000000 -0700
+++ ./includes/menu.inc 2007-03-31 13:14:01.000000000 -0700
@@ -498,6 +498,23 @@ function theme_menu_item_link($item) {
}
/**
+ * Returns the rendered local tasks. The default implementation renders
+ * them as tabs.
+ */
+function theme_menu_local_tasks() {
+ $output = '';
+
+ if ($primary = menu_primary_local_tasks()) {
+ $output .= "\n";
+ }
+ if ($secondary = menu_secondary_local_tasks()) {
+ $output .= "\n";
+ }
+
+ return $output;
+}
+
+/**
* Generate the HTML output for a menu tree
*/
function theme_menu_tree($tree) {
diff -urNp ../drupal-themeswo/includes/theme.inc ./includes/theme.inc
--- ../drupal-themeswo/includes/theme.inc 2007-03-26 22:13:53.000000000 -0700
+++ ./includes/theme.inc 2007-03-31 12:13:22.000000000 -0700
@@ -72,6 +72,7 @@ function init_theme() {
if (strpos($themes[$theme]->filename, '.theme')) {
// file is a theme; include it
include_once './' . $themes[$theme]->filename;
+ _theme_load_registry($theme);
}
elseif (strpos($themes[$theme]->description, '.engine')) {
// file is a template; include its engine
@@ -80,10 +81,104 @@ function init_theme() {
if (function_exists($theme_engine .'_init')) {
call_user_func($theme_engine .'_init', $themes[$theme]);
}
+ _theme_load_registry($theme, $theme_engine);
}
}
/**
+ * Retrieve the stored theme registry. If the theme registry is already
+ * in memory it will be returned; otherwise it will attempt to load the
+ * registry from cache. If this fails, it will construct the registry and
+ * cache it.
+ */
+function theme_get_registry($registry = NULL) {
+ static $theme_registry = NULL;
+ if (isset($registry)) {
+ $theme_registry = $registry;
+ }
+
+ return $theme_registry;
+}
+
+/**
+ * Store the theme registry in memory.
+ */
+function _theme_set_registry($registry) {
+ // Pass through for setting of static variable.
+ return theme_get_registry($registry);
+}
+
+/**
+ * Get the theme_registry cache from the database; if it doesn't exist, build
+ * it.
+ */
+function _theme_load_registry($theme, $theme_engine = NULL) {
+ // TODO: use a separate cache for this.
+ $cache = cache_get("theme_registry:$theme", 'cache');
+ if (isset($cache->data)) {
+ $registry = unserialize($cache->data);
+ }
+ else {
+ $registry = _theme_build_registry($theme, $theme_engine);
+ _theme_save_registry($theme, $registry);
+ }
+ _theme_set_registry($registry);
+}
+
+/**
+ * Write the theme_registry cache into the database.
+ */
+function _theme_save_registry($theme, $registry) {
+ // TODO: use a separate cache for this.
+ cache_set("theme_registry:$theme", 'cache', serialize($registry));
+}
+
+/**
+ * Process a single invocation of the themes hook.
+ */
+function _theme_process_registry(&$cache, $name, $type) {
+ $function = $name .'_themes';
+ if (function_exists($function)) {
+ $result = $function($cache);
+
+ // Automatically find paths
+ $path = drupal_get_path($type, $name);
+ foreach ($result as $hook => $info) {
+ $result[$hook]['type'] = $type;
+ if (isset($info['file']) && !isset($info['path'])) {
+ $result[$hook]['file'] = $path .'/'. $info['file'];
+ }
+ // If 'arguments' have been defined previously, carry them forward.
+ // This should happen if a theme overrides a Drupal defined theme
+ // function, for example.
+ if (!isset($info['arguments']) && isset($cache[$hook])) {
+ $result[$hook]['arguments'] = $cache[$hook]['arguments'];
+ }
+ }
+
+ $cache = array_merge($cache, $result);
+ }
+}
+
+/**
+ * Rebuild the hook theme_registry cache.
+ */
+function _theme_build_registry($theme, $theme_engine) {
+ $cache = array();
+ foreach (module_implements('themes') as $module) {
+ _theme_process_registry($cache, $module, 'module');
+ }
+
+ if ($theme_engine) {
+ _theme_process_registry($cache, $theme_engine, 'theme_engine');
+ }
+
+ _theme_process_registry($cache, $theme, 'theme');
+
+ return $cache;
+}
+
+/**
* Provides a list of currently available themes.
*
* @param $refresh
@@ -140,18 +235,41 @@ function list_theme_engines($refresh = F
}
/**
- * Generate the themed representation of a Drupal object.
- *
- * All requests for themed functions must go through this function. It examines
- * the request and routes it to the appropriate theme function. If the current
- * theme does not implement the requested function, then the current theme
- * engine is checked. If neither the engine nor theme implement the requested
- * function, then the base theme function is called.
+ * Generate the themed output.
*
- * For example, to retrieve the HTML that is output by theme_page($output), a
- * module should call theme('page', $output).
+ * All requests for theme hooks must go through this function. It examines
+ * the request and routes it to the appropriate theme function. The theme
+ * registry is checked to determine which implementation to use, which may
+ * be a function or a template.
+ *
+ * If the implementation is a function, it is executed and its return value
+ * passed along.
+ *
+ * If the implementation is a template, the arguments are converted to a
+ * $variables array. This array is then modified by the theme engine (if
+ * applicable) and the theme. The following functions may be used to modify
+ * the $variables array:
+ *
+ * ENGINE_engine_variables(&$variables)
+ * This function should only be implemented by theme engines and is exists
+ * so that the theme engine can set necessary variables. It is commonly
+ * used to set global variables such as $directory and $is_front_page.
+ * ENGINE_engine_variables_HOOK(&$variables)
+ * This is the same as the previous function, but is called only per hook.
+ * ENGINE_variables_HOOK(&$variables)
+ * ENGINE_variables(&$variables)
+ * This is meant to be used by themes that utilize a theme engine; as it is
+ * good practice for these themes to use the theme engine's name for
+ * their functions so that they may share code. In PHPTemplate, these
+ * functions will appear in template.php
+ * THEME_variables_HOOK(&$variables)
+ * THEME_variables(&$variables)
+ * These functions are based upon the raw theme; they should primarily be
+ * used by themes that do not use an engine or by themes that need small
+ * changes to what has already been established in the theme engine version
+ * of the function.
*
- * @param $function
+ * @param $hook
* The name of the theme function to call.
* @param ...
* Additional arguments to pass along to the theme function.
@@ -159,48 +277,125 @@ function list_theme_engines($refresh = F
* An HTML string that generates the themed output.
*/
function theme() {
- static $functions;
$args = func_get_args();
- $function = array_shift($args);
+ $hook = array_shift($args);
- if (!isset($functions[$function])) {
- $functions[$function] = theme_get_function($function);
+ static $hooks = NULL;
+ if (!isset($hooks)) {
+ init_theme();
+ $hooks = theme_get_registry();
+ }
+
+ if (!isset($hooks[$hook])) {
+ return;
}
- if ($functions[$function]) {
- return call_user_func_array($functions[$function], $args);
+
+ $info = $hooks[$hook];
+
+ if (isset($info['function'])) {
+ // The theme call is a function.
+ // Include a file if this theme function is held elsewhere.
+ if (!empty($info['file'])) {
+ include_once($info['file']);
+ }
+ return call_user_func_array($info['function'], $args);
+ }
+ else {
+ // The theme call is a template.
+ $variables = array(
+ 'template_files' => array()
+ );
+ if (!empty($info['arguments'])) {
+ $count = 0;
+ foreach ($info['arguments'] as $name => $default) {
+ $variables[$name] = isset($args[$count]) ? $args[$count] : $default;
+ $count++;
+ }
+ }
+
+ // default render function and extension.
+ $render_function = 'theme_render_template';
+ $extension = '.tpl.php';
+ $variables_list = array();
+
+ // Run through the theme engine variables, if necessary
+ global $theme_engine;
+ if (isset($theme_engine)) {
+ // Call each of our variable override functions. We allow
+ // several to create cleaner code.
+ $variables_list[] = $theme_engine .'_engine_variables';
+ $variables_list[] = $theme_engine .'_engine_variables_'. $hook;
+ $variables_list[] = $theme_engine .'_variables';
+ $variables_list[] = $theme_engine .'_variables_'. $hook;
+
+ // If theme or theme engine is implementing this, it may have
+ // a different extension and a different renderer.
+ if ($hooks[$hook]['type'] != 'module') {
+ if (function_exists($theme_engine .'_render_template')) {
+ $render_function = $theme_engine .'_render_template';
+ }
+ $extension_function = $theme_engine .'_extension';
+ if (function_exists($extension_function)) {
+ $extension = $extension_function();
+ }
+ }
+ }
+
+ // Add theme specific variable substitution:
+ global $theme;
+ $variables_list[] = $theme .'_variables';
+ $variables_list[] = $theme .'_variables_'. $hook;
+
+ // This construct ensures that we can keep a reference through
+ // call_user_func_array.
+ $args = array(&$variables, $hook);
+ foreach ($variables_list as $variables_function) {
+ if (function_exists($variables_function)) {
+ call_user_func_array($variables_function, $args);
+ }
+ }
+
+ // Get suggestions for alternate templates out of the variables
+ // that were set. This lets us dynamically choose a template
+ // from a list. The order is FILO, so this array is ordered from
+ // least appropriate first to most appropriate last.
+ $suggestions = array();
+
+ if (isset($variables['template_files'])) {
+ $suggestions = $variables['template_files'];
+ }
+ if (isset($variables['template_file'])) {
+ $suggestions[] = $variables['template_file'];
+ }
+
+ if ($suggestions) {
+ $template_file = drupal_discover_template($suggestions, $extension);
+ }
+
+ if (empty($template_file)) {
+ $template_file = $hooks[$hook]['file'] . $extension;
+ if (isset($hooks[$hook]['path'])) {
+ $template_file = $hooks[$hook]['path'] .'/'. $template_file;
+ }
+ }
+ return $render_function($template_file, $variables);
}
}
/**
- * Determine if a theme function exists, and if so return which one was found.
- *
- * @param $function
- * The name of the theme function to test.
- * @return
- * The name of the theme function that should be used, or FALSE if no function exists.
+ * Choose which template file to actually render; these are all
+ * suggested templates from the theme.
*/
-function theme_get_function($function) {
- global $theme, $theme_engine;
+function drupal_discover_template($suggestions, $extension = '.tpl.php') {
+ global $theme_engine;
- // Because theme() is called a lot, calling init_theme() only to have it
- // smartly return is a noticeable performance hit. Don't do it.
- if (!isset($theme)) {
- init_theme();
- }
-
- if (($theme != '') && function_exists($theme .'_'. $function)) {
- // call theme function
- return $theme .'_'. $function;
- }
- elseif (($theme != '') && isset($theme_engine) && function_exists($theme_engine .'_'. $function)) {
- // call engine function
- return $theme_engine .'_'. $function;
- }
- elseif (function_exists('theme_'. $function)){
- // call Drupal function
- return 'theme_'. $function;
+ // Loop through any suggestions in FIFO order.
+ $suggestions = array_reverse($suggestions);
+ foreach ($suggestions as $suggestion) {
+ if (!empty($suggestion) && file_exists($file = path_to_theme() .'/'. $suggestion . $extension)) {
+ return $file;
+ }
}
- return FALSE;
}
/**
@@ -348,16 +543,79 @@ function theme_get_setting($setting_name
}
/**
- * @defgroup themeable Themeable functions
+ * Render a system default template, which is essentially a PHP template.
+ *
+ * @param $file
+ * The filename of the template to render.
+ * @param $variables
+ * A keyed array of variables that will appear in the output.
+ *
+ * @return
+ * The output generated by the template.
+ */
+function theme_render_template($file, $variables) {
+ extract($variables, EXTR_SKIP); // Extract the variables to a local namespace
+ ob_start(); // Start output buffering
+ include "./$file"; // Include the file
+ $contents = ob_get_contents(); // Get the contents of the buffer
+ ob_end_clean(); // End buffering and discard
+ return $contents; // Return the contents
+}
+
+/**
+ * @defgroup themeable Default theme implementations
* @{
- * Functions that display HTML, and which can be customized by themes.
+ * Functions and templates that present output to the user, and can be
+ * implemented by themes.
*
- * All functions that produce HTML for display should be themeable. This means
- * that they should be named with the theme_ prefix, and invoked using theme()
- * rather than being called directly. This allows themes to override the display
- * of any Drupal object.
+ * Drupal's presentation layer is a pluggable system known as the theme
+ * layer. Each theme can take control over most of Drupal's output, and
+ * has complete control over the CSS.
+ *
+ * Inside Drupal, the theme layer is utilized by the use of the theme()
+ * function, which is passed the name of a component (the theme hook)
+ * and several arguments. For example, theme('table', $header, $rows);
+ *
+ * As of Drupal 6, every theme hook is required to be registered by the
+ * module that owns it, so that Drupal can tell what to do with it and
+ * to make it simple for themes to identify and override the behavior
+ * for these calls.
+ *
+ * The theme hooks are registered via hook_themes(), which returns an
+ * array of arrays with information about the hook. It describes the
+ * arguments the function or template will need, and provides
+ * defaults for the template in case they are not filled in. If the default
+ * implementation is a function, by convention it is named theme_HOOK().
+ *
+ * Each module should provide a default implementation for themes that
+ * it registers. This implementation may be either a function or a template;
+ * if it is a function it must be specified via hook_themes(). By convention,
+ * default implementations of theme hooks are named theme_HOOK. Default
+ * template implementations are stored in the module directory.
+ *
+ * Drupal's default template renderer is a simple PHP parsing engine that
+ * includes the template and stores the output. Drupal's theme engines
+ * can provide alternate template engines, such as XTemplate, Smarty and
+ * PHPTal. The most common template engine is PHPTemplate (included with
+ * Drupal and implemented in phptemplate.engine, which uses Drupal's default
+ * template renderer.
+ *
+ * Themes can implement their own version of theme hooks, either as functions
+ * or files. If using a pure .theme without an engine, the .theme is required
+ * to implement its own version of hook_themes() to tell Drupal what it is
+ * implementing; themes utilizing an engine will have their well-named
+ * theming functions automatically registered for them. While this can vary
+ * based upon the theme engine, the standard set by phptemplate is that theme
+ * functions should be named either phptemplate_HOOK or THEMENAME_HOOK. For
+ * example, for Drupal's default theme (Garland) to implement the 'table' hook,
+ * the phptemplate.engine would find phptemplate_table() or garland_table().
+ * The ENGINE_HOOK() syntax is preferred, as this can be used by sub-themes
+ * (which are themes that share code but use different stylesheets).
*
* The theme system is described and defined in theme.inc.
+ *
+ * @see theme()
+ * @see hook_themes()
*/
/**
@@ -373,55 +631,6 @@ function theme_placeholder($text) {
return ''. check_plain($text) .' ';
}
-/**
- * Return an entire Drupal page displaying the supplied content.
- *
- * @param $content
- * A string to display in the main content area of the page.
- * @return
- * A string containing the entire HTML page.
- */
-function theme_page($content) {
- // Get blocks before so that they can alter the header (JavaScript, Stylesheets etc.)
- $blocks = theme('blocks', 'all');
-
- $output = "\n";
- $output .= '';
- $output .= '';
- $output .= ' '. (drupal_get_title() ? strip_tags(drupal_get_title()) : variable_get('site_name', 'Drupal')) .' ';
- $output .= drupal_get_html_head();
- $output .= drupal_get_css();
- $output .= drupal_get_js();
-
- $output .= ' ';
- $output .= ' ';
- $output .= '';
-
- $output .= $blocks;
- $output .= ' ';
-
- $output .= theme('breadcrumb', drupal_get_breadcrumb());
- $output .= '' . drupal_get_title() . ' ';
-
- if ($tabs = theme('menu_local_tasks')) {
- $output .= $tabs;
- }
-
- $output .= theme('help');
-
- $output .= theme('status_messages');
-
- $output .= "\n\n";
- $output .= $content;
- $output .= drupal_get_feeds();
- $output .= "\n\n";
-
- $output .= '
';
- $output .= theme('closure');
- $output .= '';
-
- return $output;
-}
/**
* Generate a themed maintenance page.
@@ -458,9 +667,7 @@ function theme_maintenance_page($content
'content' => $content,
);
- // Render simplified PHPTemplate.
- include_once './themes/engines/phptemplate/phptemplate.engine';
- $output = _phptemplate_render('misc/maintenance.tpl.php', $variables);
+ $output = theme_render_template('misc/maintenance.tpl.php', $variables);
return $output;
}
@@ -509,9 +716,7 @@ function theme_install_page($content) {
$variables['messages'] .= theme('status_messages', 'status');
}
- // Render simplified PHPTemplate.
- include_once './themes/engines/phptemplate/phptemplate.engine';
- return _phptemplate_render('misc/maintenance.tpl.php', $variables);
+ return theme_render_template('misc/maintenance.tpl.php', $variables);
}
/**
@@ -678,66 +883,6 @@ function theme_help() {
}
/**
- * Return a themed node.
- *
- * @param $node
- * An object providing all relevant information for displaying a node:
- * - $node->nid: The ID of the node.
- * - $node->type: The content type (story, blog, forum...).
- * - $node->title: The title of the node.
- * - $node->created: The creation date, as a UNIX timestamp.
- * - $node->teaser: A shortened version of the node body.
- * - $node->body: The entire node contents.
- * - $node->changed: The last modification date, as a UNIX timestamp.
- * - $node->uid: The ID of the author.
- * - $node->username: The username of the author.
- * @param $teaser
- * Whether to display the teaser only, as on the main page.
- * @param $page
- * Whether to display the node as a standalone page. If TRUE, do not display
- * the title because it will be provided by the menu system.
- * @return
- * A string containing the node output.
- */
-function theme_node($node, $teaser = FALSE, $page = FALSE) {
- if (!$node->status) {
- $output = '';
- }
-
- if (module_exists('taxonomy')) {
- $terms = taxonomy_link('taxonomy terms', $node);
- }
-
- if ($page == 0) {
- $output .= t('!title by !name', array('!title' => '
'. check_plain($node->title) .' ', '!name' => theme('username', $node)));
- }
- else {
- $output .= t('by !name', array('!name' => theme('username', $node)));
- }
-
- if (count($terms)) {
- $output .= '
('. theme('links', $terms) .') ';
- }
-
- if ($teaser && $node->teaser) {
- $output .= $node->teaser;
- }
- else {
- $output .= $node->body;
- }
-
- if ($node->links) {
- $output .= '
'. theme('links', $node->links) .'
';
- }
-
- if (!$node->status) {
- $output .= '
module (all blocks of module module ), and
- * \#block-module -delta (specific block of module module
- * with delta delta ) in your theme's CSS.
- *
- * @param $block
- * An object populated with fields from the "blocks" database table
- * ($block->module, $block->delta ...) and fields returned by
- * module _block('view') ($block->subject, $block->content, ...).
- * @return
- * A string containing the block output.
- */
-function theme_block($block) {
- $output = "module\" id=\"block-$block->module-$block->delta\">\n";
- $output .= "
$block->subject \n";
- $output .= "
$block->content
\n";
- $output .= "
'. check_plain($text) .' ';
+ }
+
+-/**
+- * Return an entire Drupal page displaying the supplied content.
+- *
+- * @param $content
+- * A string to display in the main content area of the page.
+- * @return
+- * A string containing the entire HTML page.
+- */
+-function theme_page($content) {
+- // Get blocks before so that they can alter the header (JavaScript, Stylesheets etc.)
+- $blocks = theme('blocks', 'all');
+-
+- $output = "\n";
+- $output .= '';
+- $output .= '';
+- $output .= ' '. (drupal_get_title() ? strip_tags(drupal_get_title()) : variable_get('site_name', 'Drupal')) .' ';
+- $output .= drupal_get_html_head();
+- $output .= drupal_get_css();
+- $output .= drupal_get_js();
+-
+- $output .= ' ';
+- $output .= ' ';
+- $output .= '';
+-
+- $output .= $blocks;
+- $output .= ' ';
+-
+- $output .= theme('breadcrumb', drupal_get_breadcrumb());
+- $output .= '' . drupal_get_title() . ' ';
+-
+- if ($tabs = theme('menu_local_tasks')) {
+- $output .= $tabs;
+- }
+-
+- $output .= theme('help');
+-
+- $output .= theme('status_messages');
+-
+- $output .= "\n\n";
+- $output .= $content;
+- $output .= drupal_get_feeds();
+- $output .= "\n\n";
+-
+- $output .= '
';
+- $output .= theme('closure');
+- $output .= '';
+-
+- return $output;
+-}
+
+ /**
+ * Generate a themed maintenance page.
+@@ -458,9 +667,7 @@ function theme_maintenance_page($content
+ 'content' => $content,
+ );
+
+- // Render simplified PHPTemplate.
+- include_once './themes/engines/phptemplate/phptemplate.engine';
+- $output = _phptemplate_render('misc/maintenance.tpl.php', $variables);
++ $output = theme_render_template('misc/maintenance.tpl.php', $variables);
+
+ return $output;
+ }
+@@ -509,9 +716,7 @@ function theme_install_page($content) {
+ $variables['messages'] .= theme('status_messages', 'status');
+ }
+
+- // Render simplified PHPTemplate.
+- include_once './themes/engines/phptemplate/phptemplate.engine';
+- return _phptemplate_render('misc/maintenance.tpl.php', $variables);
++ return theme_render_template('misc/maintenance.tpl.php', $variables);
+ }
+
+ /**
+@@ -678,66 +883,6 @@ function theme_help() {
+ }
+
+ /**
+- * Return a themed node.
+- *
+- * @param $node
+- * An object providing all relevant information for displaying a node:
+- * - $node->nid: The ID of the node.
+- * - $node->type: The content type (story, blog, forum...).
+- * - $node->title: The title of the node.
+- * - $node->created: The creation date, as a UNIX timestamp.
+- * - $node->teaser: A shortened version of the node body.
+- * - $node->body: The entire node contents.
+- * - $node->changed: The last modification date, as a UNIX timestamp.
+- * - $node->uid: The ID of the author.
+- * - $node->username: The username of the author.
+- * @param $teaser
+- * Whether to display the teaser only, as on the main page.
+- * @param $page
+- * Whether to display the node as a standalone page. If TRUE, do not display
+- * the title because it will be provided by the menu system.
+- * @return
+- * A string containing the node output.
+- */
+-function theme_node($node, $teaser = FALSE, $page = FALSE) {
+- if (!$node->status) {
+- $output = '';
+- }
+-
+- if (module_exists('taxonomy')) {
+- $terms = taxonomy_link('taxonomy terms', $node);
+- }
+-
+- if ($page == 0) {
+- $output .= t('!title by !name', array('!title' => '
'. check_plain($node->title) .' ', '!name' => theme('username', $node)));
+- }
+- else {
+- $output .= t('by !name', array('!name' => theme('username', $node)));
+- }
+-
+- if (count($terms)) {
+- $output .= '
('. theme('links', $terms) .') ';
+- }
+-
+- if ($teaser && $node->teaser) {
+- $output .= $node->teaser;
+- }
+- else {
+- $output .= $node->body;
+- }
+-
+- if ($node->links) {
+- $output .= '
'. theme('links', $node->links) .'
';
+- }
+-
+- if (!$node->status) {
+- $output .= '
module (all blocks of module module ), and
+- * \#block-module -delta (specific block of module module
+- * with delta delta ) in your theme's CSS.
+- *
+- * @param $block
+- * An object populated with fields from the "blocks" database table
+- * ($block->module, $block->delta ...) and fields returned by
+- * module _block('view') ($block->subject, $block->content, ...).
+- * @return
+- * A string containing the block output.
+- */
+-function theme_block($block) {
+- $output = "module\" id=\"block-$block->module-$block->delta\">\n";
+- $output .= "
$block->subject \n";
+- $output .= "
$block->content
\n";
+- $output .= "
'. check_plain($text) .' ';
+ }
+
+-/**
+- * Return an entire Drupal page displaying the supplied content.
+- *
+- * @param $content
+- * A string to display in the main content area of the page.
+- * @return
+- * A string containing the entire HTML page.
+- */
+-function theme_page($content) {
+- // Get blocks before so that they can alter the header (JavaScript, Stylesheets etc.)
+- $blocks = theme('blocks', 'all');
+-
+- $output = "\n";
+- $output .= '';
+- $output .= '';
+- $output .= ' '. (drupal_get_title() ? strip_tags(drupal_get_title()) : variable_get('site_name', 'Drupal')) .' ';
+- $output .= drupal_get_html_head();
+- $output .= drupal_get_css();
+- $output .= drupal_get_js();
+-
+- $output .= ' ';
+- $output .= ' ';
+- $output .= '';
+-
+- $output .= $blocks;
+- $output .= ' ';
+-
+- $output .= theme('breadcrumb', drupal_get_breadcrumb());
+- $output .= '' . drupal_get_title() . ' ';
+-
+- if ($tabs = theme('menu_local_tasks')) {
+- $output .= $tabs;
+- }
+-
+- $output .= theme('help');
+-
+- $output .= theme('status_messages');
+-
+- $output .= "\n\n";
+- $output .= $content;
+- $output .= drupal_get_feeds();
+- $output .= "\n\n";
+-
+- $output .= '
';
+- $output .= theme('closure');
+- $output .= '';
+-
+- return $output;
+-}
+
+ /**
+ * Generate a themed maintenance page.
+@@ -458,9 +667,7 @@ function theme_maintenance_page($content
+ 'content' => $content,
+ );
+
+- // Render simplified PHPTemplate.
+- include_once './themes/engines/phptemplate/phptemplate.engine';
+- $output = _phptemplate_render('misc/maintenance.tpl.php', $variables);
++ $output = theme_render_template('misc/maintenance.tpl.php', $variables);
+
+ return $output;
+ }
+@@ -509,9 +716,7 @@ function theme_install_page($content) {
+ $variables['messages'] .= theme('status_messages', 'status');
+ }
+
+- // Render simplified PHPTemplate.
+- include_once './themes/engines/phptemplate/phptemplate.engine';
+- return _phptemplate_render('misc/maintenance.tpl.php', $variables);
++ return theme_render_template('misc/maintenance.tpl.php', $variables);
+ }
+
+ /**
+@@ -678,66 +883,6 @@ function theme_help() {
+ }
+
+ /**
+- * Return a themed node.
+- *
+- * @param $node
+- * An object providing all relevant information for displaying a node:
+- * - $node->nid: The ID of the node.
+- * - $node->type: The content type (story, blog, forum...).
+- * - $node->title: The title of the node.
+- * - $node->created: The creation date, as a UNIX timestamp.
+- * - $node->teaser: A shortened version of the node body.
+- * - $node->body: The entire node contents.
+- * - $node->changed: The last modification date, as a UNIX timestamp.
+- * - $node->uid: The ID of the author.
+- * - $node->username: The username of the author.
+- * @param $teaser
+- * Whether to display the teaser only, as on the main page.
+- * @param $page
+- * Whether to display the node as a standalone page. If TRUE, do not display
+- * the title because it will be provided by the menu system.
+- * @return
+- * A string containing the node output.
+- */
+-function theme_node($node, $teaser = FALSE, $page = FALSE) {
+- if (!$node->status) {
+- $output = '';
+- }
+-
+- if (module_exists('taxonomy')) {
+- $terms = taxonomy_link('taxonomy terms', $node);
+- }
+-
+- if ($page == 0) {
+- $output .= t('!title by !name', array('!title' => '
'. check_plain($node->title) .' ', '!name' => theme('username', $node)));
+- }
+- else {
+- $output .= t('by !name', array('!name' => theme('username', $node)));
+- }
+-
+- if (count($terms)) {
+- $output .= '
('. theme('links', $terms) .') ';
+- }
+-
+- if ($teaser && $node->teaser) {
+- $output .= $node->teaser;
+- }
+- else {
+- $output .= $node->body;
+- }
+-
+- if ($node->links) {
+- $output .= '
'. theme('links', $node->links) .'
';
+- }
+-
+- if (!$node->status) {
+- $output .= '
module (all blocks of module module ), and
+- * \#block-module -delta (specific block of module module
+- * with delta delta ) in your theme's CSS.
+- *
+- * @param $block
+- * An object populated with fields from the "blocks" database table
+- * ($block->module, $block->delta ...) and fields returned by
+- * module _block('view') ($block->subject, $block->content, ...).
+- * @return
+- * A string containing the block output.
+- */
+-function theme_block($block) {
+- $output = "module\" id=\"block-$block->module-$block->delta\">\n";
+- $output .= "
$block->subject \n";
+- $output .= "
$block->content
\n";
+- $output .= "