Theme system
* @see themeable
*/
/**
* Hook Help - returns theme specific help and information.
*
* @param section defines the @a section of the help to be returned.
*
* @return a string containing the help output.
*/
function theme_help($section) {
switch ($section) {
case 'admin/themes#description':
return t('The base theme');
}
}
/**
* Initialize the theme system by loading the theme.
*
* @return
* The name of the currently selected theme.
*/
function init_theme() {
global $user;
$themes = list_themes();
// Only select the user selected theme if it is available in the
// list of enabled themes.
$theme = $user->theme && $themes[$user->theme] ? $user->theme : variable_get('theme_default', 0);
include_once($themes[$theme]->filename);
return $theme;
}
/**
* Provides a list of currently available themes.
*
* @param $refresh
* Whether to reload the list of themes from the database.
* @return
* An array of the currently available themes.
*/
function list_themes($refresh = FALSE) {
static $list;
if ($refresh) {
unset($list);
}
if (!$list) {
$list = array();
$result = db_query("SELECT * FROM {system} where type = 'theme' AND status = '1' ORDER BY name");
while ($theme = db_fetch_object($result)) {
if (file_exists($theme->filename)) {
$list[$theme->name] = $theme;
}
}
}
return $list;
}
/**
* 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 base theme function
* is called.
*
* For example, to retrieve the HTML that is output by theme_page($output), a
* module should call theme('page', $output).
*
* @param $function
* The name of the theme function to call.
* @param ...
* Additional arguments to pass along to the theme function.
* @return
* An HTML string that generates the themed output.
*/
function theme() {
global $theme;
$args = func_get_args();
$function = array_shift($args);
if (($theme != '') && (function_exists($theme .'_'. $function))) {
return call_user_func_array($theme .'_'. $function, $args);
}
elseif (function_exists('theme_'. $function)){
return call_user_func_array('theme_'. $function, $args);
}
}
/**
* Return the path to the currently selected theme.
*/
function path_to_theme() {
global $theme;
$themes = list_themes();
return dirname($themes[$theme]->filename);
}
/**
* @defgroup themeable Themeable functions
* @{
*
* 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.
*
* @see theme.inc
*/
/**
* Return an entire Drupal page displaying the supplied content.
*
* @param $content
* A string to display in the main content area of the page.
* @param $title
* The title of the page, if different from that provided by the menu system.
* @param $breadcrumb
* The breadcrumb trail for the page, if different from that provided by the
* menu system. Use menu_set_location() instead, if possible.
* @return
* A string containing the entire HTML page.
*/
function theme_page($content, $title = NULL, $breadcrumb = NULL) {
if (isset($title)) {
drupal_set_title($title);
}
if (isset($breadcrumb)) {
drupal_set_breadcrumb($breadcrumb);
}
$output = "\n";
$output .= '';
$output .= '';
$output .= ' '. (drupal_get_title() ? drupal_get_title() : variable_get('site_name', 'drupal')) .'';
$output .= drupal_get_html_head();
$output .= ' ';
$output .= ' ';
$output .= '';
$output .= theme('box', t('Navigation'), @implode('
', link_page()));
$output .= theme('blocks', 'all');
$output .= ' | ';
$output .= theme('breadcrumb', drupal_get_breadcrumb());
$output .= '' . drupal_get_title() . '';
if ($tabs = theme('menu_local_tasks')) {
$output .= $tabs;
}
if ($help = menu_get_active_help()) {
$output .= ''. $help .'
';
}
$output .= theme_status_messages();
$output .= "\n\n";
$output .= $content;
$output .= "\n\n";
$output .= ' |
';
$output .= theme_closure();
$output .= '';
return $output;
}
/**
* Returns themed set of status and/or error messages. The messages are grouped
* by type.
*
* @return
* A string containing the messages.
*/
function theme_status_messages() {
if ($data = drupal_get_messages()) {
$output = '';
foreach ($data as $type => $messages) {
$output .= "\n";
if (count($messages) > 1) {
$output .= "
\n";
foreach($messages as $message) {
$output .= ' - '. $message ."
\n";
}
$output .= "
\n";
}
else {
$output .= $messages[0];
}
$output .= "
![\"$alt\"](\"$path\" "\\"$title\\"")
";
}
}
/**
* Return a themed breadcrumb trail.
*
* @param $breadcrumb
* An array containing the breadcrumb links.
* @return a string containing the breadcrumb output.
*/
function theme_breadcrumb($breadcrumb) {
return ''. implode($breadcrumb, ' » ') .'
';
}
/**
* 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 (module_exist('taxonomy')) {
$terms = taxonomy_link('taxonomy terms', $node);
}
if ($page == 0) {
$output = ''. $node->title .'
by '. format_name($node);
}
else {
$output = 'by '. format_name($node);
}
if (count($terms)) {
$output .= ' ('. theme('links', $terms) .')
';
}
if ($teaser && $node->teaser) {
$output .= $node->teaser;
}
else {
$output .= $node->body;
}
if ($links = link_node($node, $teaser)) {
$output .= ''. theme('links', $links) .'
';
}
return $output;
}
/**
* Return a themed form element.
*
* @param $title the form element's title
* @param $value the form element's data
* @param $description the form element's description or explanation
* @param $id the form element's ID used by the <label> tag
* @param $required a boolean to indicate whether this is a required field or not
* @param $error a string with an error message filed against this form element
*
* @return a string representing the form element
*/
function theme_form_element($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
$output = "\n";
return $output;
}
/**
* Return a themed submenu, typically displayed under the tabs.
*
* @param $links
* An array of links.
*/
function theme_submenu($links) {
return '';
}
/**
* Return a themed table.
*
* @param $header
* An array containing the table headers. Each element of the array can be
* either a localized string or an associative array with the following keys:
* - "data": The localized title of the table column.
* - "field": The database field represented in the table column (required if
* user is to be able to sort on this column).
* - "sort": A default sort order for this column ("asc" or "desc").
* - Any HTML attributes, such as "colspan", to apply to the column header cell.
* @param $rows
* An array of arrays containing the table cells. Each cell can be either a
* string or and associative array with the following keys:
* - "data": The string to display in the table cell.
* - Any HTML attributes, such as "colspan", to apply to the table cell.
* @param $attributes
* An array of HTML attributes to apply to the table tag.
* @return
* An HTML string representing the table.
*/
function theme_table($header, $rows, $attributes = NULL) {
$output = '\n";
// Format the table header:
if (is_array($header)) {
$ts = tablesort_init($header);
$output .= ' ';
foreach ($header as $cell) {
$cell = tablesort_header($cell, $header, $ts);
$output .= _theme_table_cell($cell, 1);
}
$output .= "
\n";
}
// Format the table rows:
if (is_array($rows)) {
foreach ($rows as $number => $row) {
if ($number % 2 == 1) {
$output .= ' ';
}
else {
$output .= '
';
}
$i = 0;
foreach ($row as $cell) {
$cell = tablesort_cell($cell, $header, $ts, $i);
$output .= _theme_table_cell($cell, 0);
$i++;
}
$output .= "
\n";
}
}
$output .= "
\n";
return $output;
}
/**
* Return a themed box.
*
* @param $title
* The subject of the box.
* @param $content
* The content of the box.
* @param $region
* The region in which the box is displayed.
* @return
* A string containing the box output.
*/
function theme_box($title, $content, $region = 'main') {
$output = ''. $title .'
'. $content .'
';
return $output;
}
/**
* Return a themed block.
*
* You can style your blocks by defining .block (all blocks),
* .block-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, $block->region, ...) 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 .= "
';
if (isset($title)) {
$output .= '
'. $title .'
';
}
if (isset($items)) {
$output .= '
';
foreach ($items as $item) {
$output .= '- '. $item .'
';
}
$output .= '
';
}
$output .= '
'. $message .'
';
}
function theme_more_help_link($url) {
return '
';
}
/**
* Return code that emits an XML icon.
*/
function theme_xml_icon($url) {
if ($image = theme('image', 'misc/xml.png', t('XML feed'), t('XML feed'))) {
return '';
}
}
/**
* Execute hook_footer() which is run at the end of the page right before the
* close of the body tag.
*
* @param $main (optional)
*
* @return
* A string containing the results of the hook_footer() calls.
*/
function theme_closure($main = 0) {
$footer = module_invoke_all('footer', $main);
return implode($footer, "\n");
}
/**
* Call hook_onload() in all modules to enable modules to insert JavaScript that
* will get run once the page has been loaded by the browser.
*
* @param $theme_onloads
* Additional onload directives.
* @return
* A string containing the onload attributes.
*/
function theme_onload_attribute($theme_onloads = array()) {
if (!is_array($theme_onloads)) {
$theme_onloads = array($theme_onloads);
}
// Merge theme onloads (javascript rollovers, image preloads, etc.)
// with module onloads (htmlarea, etc.)
$onloads = array_merge(module_invoke_all('onload'), $theme_onloads);
if (count($onloads)) {
return ' onload="' . implode('; ', $onloads) . '"';
}
return '';
}
/**
* Return a set of blocks available for the current user.
*
* @param $region
* Which set of blocks to retrieve.
* @return
* A string containing the themed blocks for this region.
*/
function theme_blocks($region) {
$output = '';
if ($list = module_invoke('block', 'list', $region)) {
foreach ($list as $key => $block) {
// $key == module_delta
$output .= theme('block', $block);
}
}
return $output;
}
/**
* @} end of defgroup themeable
*/
function _theme_table_cell($cell, $header = 0) {
$attributes = '';
if (is_array($cell)) {
$data = $cell['data'];
foreach ($cell as $key => $value) {
if ($key != 'data') {
$attributes .= " $key=\"$value\"";
}
}
}
else {
$data = $cell;
}
if ($header) {
$output = "$data";
}
else {
$output = "$data";
}
return $output;
}
?>