Default theme implementations

Functions and templates that present output to the user, and can be implemented by themes.

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); Additionally, the theme() function can take an array of theme hooks, which can be used to provide 'fallback' implementations to allow for more specific control of output. For example, the function: theme(array('table__foo', 'table'), $header, $rows) would look to see if 'table__foo' is registered anywhere; if it is not, it would 'fall back' to the generic 'table' implementation. This can be used to attach specific theme functions to named objects, allowing the themer more control over specific types of output.

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_theme(), 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 theme_hooks that it registers. This implementation may be either a function or a template; if it is a function it must be specified via hook_theme(). 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.

In order to create theme-specific implementations of these hooks, themes can implement their own version of theme hooks, either as functions or templates. These implementations will be used instead of the default implementation. If using a pure .theme without an engine, the .theme is required to implement its own version of hook_theme() 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 also

theme()

@see hook_theme()

Functions

Name	Location	Description
phptemplate_menu_local_tasks	drupal/themes/garland/template.php	Returns the rendered local tasks. The default implementation renders them as tabs. Overridden to split the secondary tasks.
theme_address_pane	ubercart/uc_cart/uc_cart_checkout_pane.inc	Theme the delivery/billing address forms in tables.
theme_admin_block	drupal/modules/system/system.admin.inc	This function formats an administrative block for display.
theme_admin_block_content	drupal/modules/system/system.admin.inc	This function formats the content of an administrative block.
theme_admin_page	drupal/modules/system/system.admin.inc	This function formats an administrative page for viewing.
theme_aggregator_page_opml	drupal/modules/aggregator/aggregator.pages.inc	Theme the OPML feed output.
theme_aggregator_page_rss	drupal/modules/aggregator/aggregator.pages.inc	Theme the RSS output.
theme_blocks	drupal/includes/theme.inc	Return a set of blocks available for the current user.
theme_book_admin_table	drupal/modules/book/book.admin.inc	Theme function for the book administration page form. See alsobook_admin_table()
theme_book_title_link	drupal/modules/book/book.module	Generate the HTML output for a link to a book title when used as a block title.
theme_box	drupal/includes/theme.inc	Return a themed box.
theme_breadcrumb	drupal/includes/theme.inc	Return a themed breadcrumb trail.
theme_button	drupal/includes/form.inc	Theme a form button.
theme_cart_review_table	ubercart/uc_cart/uc_cart_checkout_pane.inc	Format the cart contents table on the checkout page.
theme_checkbox	drupal/includes/form.inc	Format a checkbox.
theme_checkboxes	drupal/includes/form.inc	Format a set of checkboxes.
theme_closure	drupal/includes/theme.inc	Execute hook_footer() which is run at the end of the page right before the close of the body tag.
theme_color_scheme_form	drupal/modules/color/color.module	Theme color form.
theme_comment_admin_overview	drupal/modules/comment/comment.admin.inc	Theme the comment admin form.
theme_comment_controls	drupal/modules/comment/comment.module	Theme comment controls box where the user can change the default display mode and display order of comments.
theme_comment_flat_collapsed	drupal/modules/comment/comment.module	Theme comment flat collapsed view.
theme_comment_flat_expanded	drupal/modules/comment/comment.module	Theme comment flat expanded view.
theme_comment_post_forbidden	drupal/modules/comment/comment.module	Theme a "you can't post comments" notice.
theme_comment_submitted	drupal/modules/comment/comment.module	Theme a "Submitted by ..." notice.
theme_comment_thread_collapsed	drupal/modules/comment/comment.module	Theme comment thread collapsed view.
theme_comment_thread_expanded	drupal/modules/comment/comment.module	Theme comment thread expanded view.
theme_comment_view	drupal/modules/comment/comment.module	Theme a single comment block.
theme_date	drupal/includes/form.inc	Format a date selection element.
theme_dblog_filters	drupal/modules/dblog/dblog.module	Theme dblog administration filter selector.
theme_feed_icon	drupal/includes/theme.inc	Return code that emits an feed icon.
theme_fieldset	drupal/includes/form.inc	Format a group of form items.
theme_file	drupal/includes/form.inc	Format a file upload field.
theme_filter_admin_order	drupal/modules/filter/filter.admin.inc	Theme filter order configuration form.
theme_filter_admin_overview	drupal/modules/filter/filter.admin.inc	Theme the admin overview form.
theme_filter_tips	drupal/modules/filter/filter.pages.inc	Format a set of filter tips.
theme_filter_tips_more_info	drupal/modules/filter/filter.module	Format a link to the more extensive filter tips.
theme_form	drupal/includes/form.inc	Format a form.
theme_form_element	drupal/includes/form.inc	Return a themed form element.
theme_help	drupal/includes/theme.inc	Return a themed help message.
theme_hidden	drupal/includes/form.inc	Format a hidden form field.
theme_image	drupal/includes/theme.inc	Return a themed image.
theme_image_button	drupal/includes/form.inc	Theme a form image button.
theme_indentation	drupal/includes/theme.inc	Create a standard indentation div. Used for drag and drop tables.
theme_item	drupal/includes/form.inc	Format a form item.
theme_item_list	drupal/includes/theme.inc	Return a themed list of items.
theme_links	drupal/includes/theme.inc	Return a themed set of links.
theme_locale_languages_overview_form	drupal/includes/locale.inc	Theme the language overview form.
theme_mark	drupal/includes/theme.inc	Return a themed marker, useful for marking new or updated content.
theme_menu_item	drupal/includes/menu.inc	Generate the HTML output for a menu item and submenu.
theme_menu_item_link	drupal/includes/menu.inc	Generate the HTML output for a single menu link.
theme_menu_local_task	drupal/includes/menu.inc	Generate the HTML output for a single local task link.
theme_menu_local_tasks	drupal/includes/menu.inc	Returns the rendered local tasks. The default implementation renders them as tabs.
theme_menu_overview_form	drupal/modules/menu/menu.admin.inc	Theme the menu overview form into a table.
theme_menu_tree	drupal/includes/menu.inc	Generate the HTML output for a menu tree
theme_more_help_link	drupal/includes/theme.inc	Returns code that emits the 'more help'-link.
theme_more_link	drupal/includes/theme.inc	Returns code that emits the 'more' link used on blocks.
theme_node_add_list	drupal/modules/node/node.pages.inc	Display the list of available node types for node creation.
theme_node_admin_nodes	drupal/modules/node/node.admin.inc	Theme node administration overview.
theme_node_filters	drupal/modules/node/node.admin.inc	Theme node administration filter selector.
theme_node_filter_form	drupal/modules/node/node.admin.inc	Theme node administration filter form.
theme_node_form	drupal/modules/node/node.pages.inc	Present a node submission form.
theme_node_list	drupal/modules/node/node.module	Format a listing of links to nodes.
theme_node_log_message	drupal/modules/node/node.module	Theme a log message.
theme_node_preview	drupal/modules/node/node.pages.inc	Display a node preview for display during node creation and editing.
theme_node_search_admin	drupal/modules/node/node.module	Theme the content ranking part of the search settings admin page.
theme_node_submitted	drupal/modules/node/node.module	Format the "Submitted by username on date/time" for each node
theme_pager	drupal/includes/pager.inc	Format a query pager.
theme_pager_first	drupal/includes/pager.inc	Format a "first page" link.
theme_pager_last	drupal/includes/pager.inc	Format a "last page" link.
theme_pager_link	drupal/includes/pager.inc	Format a link to a specific query result page.
theme_pager_next	drupal/includes/pager.inc	Format a "next page" link.
theme_pager_previous	drupal/includes/pager.inc	Format a "previous page" link.
theme_password	drupal/includes/form.inc	Format a password field.
theme_password_confirm	drupal/includes/form.inc	Format a password_confirm item.
theme_placeholder	drupal/includes/theme.inc	Formats text for emphasized display in a placeholder inside a sentence. Used automatically by t().
theme_poll_choices	drupal/modules/poll/poll.module	Theme the admin poll form for choices.
theme_profile_admin_overview	drupal/modules/profile/profile.admin.inc	Theme the profile field overview into a drag and drop enabled table. See alsoprofile_admin_overview()
theme_progress_bar	drupal/includes/theme.inc	Return a themed progress bar.
theme_radio	drupal/includes/form.inc	Format a radio button.
theme_radios	drupal/includes/form.inc	Format a set of radio buttons.
theme_select	drupal/includes/form.inc	Format a dropdown menu or scrolling selection box.
theme_status_messages	drupal/includes/theme.inc	Return a themed set of status and/or error messages. The messages are grouped by type.
theme_status_report	drupal/modules/system/system.admin.inc	Theme requirements status report.
theme_submenu	drupal/includes/theme.inc	Return a themed submenu, typically displayed under the tabs.
theme_submit	drupal/includes/form.inc	Theme a form submit button.
theme_syslog_format	drupal/modules/syslog/syslog.module	Format a system log entry.
theme_system_admin_by_module	drupal/modules/system/system.admin.inc	Theme output of the dashboard page.
theme_system_modules	drupal/modules/system/system.admin.inc	Theme callback for the modules form.
theme_system_modules_uninstall	drupal/modules/system/system.admin.inc	Themes a table of currently disabled modules.
theme_system_powered_by	drupal/modules/system/system.module	Format the Powered by Drupal text.
theme_system_themes_form	drupal/modules/system/system.admin.inc	Theme function for the system themes form.
theme_system_theme_select_form	drupal/modules/system/system.admin.inc	Theme the theme select form.
theme_table	drupal/includes/theme.inc	Return a themed table.
theme_tablesort_indicator	drupal/includes/theme.inc	Return a themed sort icon.
theme_table_select_header_cell	drupal/includes/theme.inc	Returns a header cell for tables that have a select all functionality.
theme_task_list	drupal/includes/theme.maintenance.inc	Return a themed list of maintenance tasks to perform.
theme_taxonomy_overview_terms	drupal/modules/taxonomy/taxonomy.admin.inc	Theme the terms overview as a sortable list of terms. See alsotaxonomy_overview_terms()
theme_taxonomy_overview_vocabularies	drupal/modules/taxonomy/taxonomy.admin.inc	Theme the vocabulary overview as a sortable list of vocabularies. See alsotaxonomy_overview_vocabularies()
theme_taxonomy_term_page	drupal/modules/taxonomy/taxonomy.pages.inc	Render a taxonomy term page HTML output.
theme_taxonomy_term_select	drupal/modules/taxonomy/taxonomy.module	Format the selection field for choosing terms (by deafult the default selection field is used).
theme_textarea	drupal/includes/form.inc	Format a textarea.
theme_textfield	drupal/includes/form.inc	Format a textfield.
theme_token	drupal/includes/form.inc	Format a form token.
theme_trigger_display	drupal/modules/trigger/trigger.admin.inc	Display actions assigned to this hook-op combination in a table.
theme_uc_admin_dashboard	ubercart/uc_store/uc_store.module	Theme the dashboard on the admin/store page.
theme_uc_attribute_add_to_cart	ubercart/uc_attribute/uc_attribute.module	Display the attribute selection form elements. See also_uc_attribute_alter_form()
theme_uc_attribute_options_form	ubercart/uc_attribute/uc_attribute.admin.inc	Format an attribute and its options.
theme_uc_cart_block_content	ubercart/uc_cart/uc_cart.module	Theme the shopping cart block content.
theme_uc_cart_block_content_cachable	ubercart/uc_cart/uc_cart.module	Theme the cachable shopping cart block content.
theme_uc_cart_block_items	ubercart/uc_cart/uc_cart.module	Theme the table listing the items in the shopping cart block.
theme_uc_cart_block_summary	ubercart/uc_cart/uc_cart.module	Theme the summary table at the bottom of the default shopping cart block.
theme_uc_cart_block_title	ubercart/uc_cart/uc_cart.module	Theme the shopping cart block title
theme_uc_cart_block_title_icon	ubercart/uc_cart/uc_cart.module	Theme the shopping cart icon.
theme_uc_cart_checkout_form	ubercart/uc_cart/uc_cart.pages.inc	Add markup and styling to the checkout panes. See alsouc_cart_checkout_form()
theme_uc_cart_complete_sale	ubercart/uc_cart/uc_cart.module	Theme the sale completion page.
theme_uc_cart_pane_quotes	ubercart/shipping/uc_quote/uc_quote.module	Display the formatted quote cart pane.
theme_uc_cart_view_form	ubercart/uc_cart/uc_cart.module	@see uc_cart_view_form()
theme_uc_cart_view_price	ubercart/uc_cart/uc_cart.module	Dumb wrapper function, as the price has been themed by uc_price() already. See alsouc_cart_view_form()
theme_uc_catalog_block	ubercart/uc_catalog/uc_catalog.module	Theme the catalog block. See alsotheme_uc_catalog_item()
theme_uc_catalog_item	ubercart/uc_catalog/uc_catalog.module	Display a formatted link in the catalog block.
theme_uc_catalog_products	ubercart/uc_catalog/uc_catalog.module	Display a formatted list of products.
theme_uc_catalog_product_grid	ubercart/uc_catalog/uc_catalog.module	Display a list of products in grid format().
theme_uc_empty_cart	ubercart/uc_cart/uc_cart.module	Return the text displayed for an empty shopping cart.
theme_uc_file_admin_files_form_show	ubercart/uc_file/uc_file.admin.inc	@see uc_file_admin_files_form_show_files()
theme_uc_file_downloads_token	ubercart/uc_file/uc_file.module	Theme file download links token.
theme_uc_file_hook_user_file	ubercart/uc_file/uc_file.module	Theme the file dialog at the user account page.
theme_uc_file_hook_user_file_downloads	ubercart/uc_file/uc_file.module	Theme the download table at the user account page.
theme_uc_object_attributes_form	ubercart/uc_attribute/uc_attribute.admin.inc	Display the formatted attribute form. See alsouc_object_attributes_form()
theme_uc_object_options_form	ubercart/uc_attribute/uc_attribute.admin.inc	Display the option form. See alsouc_object_options_form()
theme_uc_order_edit_form	ubercart/uc_order/uc_order.admin.inc	@see uc_order_edit_form()
theme_uc_order_edit_products_form	ubercart/uc_order/uc_order.admin.inc	@see uc_order_edit_products_form()
theme_uc_order_remove_product	ubercart/uc_order/uc_order.admin.inc	Format the button to remove products from an order. See alsoop_products_edit_table()
theme_uc_order_state_table	ubercart/uc_order/uc_order.module	Theme the order state table in the order workflow settings.
theme_uc_order_view_update_controls	ubercart/uc_order/uc_order.order_pane.inc	@see uc_order_view_update_form()
theme_uc_pane_sort_table	ubercart/uc_store/uc_store.module	Theme a pane sorting form into a table.
theme_uc_price	ubercart/uc_store/uc_store.module	Theme a formatted price for display.
theme_uc_price_settings_form	ubercart/uc_store/uc_store.admin.inc	Render the price handler form, adding tabledrag. See alsouc_price_settings_form()
theme_uc_product_add_to_cart	ubercart/uc_product/uc_product.module	Wrap the "Add to Cart" form in a <div>.
theme_uc_product_body	ubercart/uc_product/uc_product.module	Format a product's body.
theme_uc_product_dimensions	ubercart/uc_product/uc_product.module	Format a product's length, width, and height.
theme_uc_product_dimensions_form	ubercart/uc_product/uc_product.module	Put length, width, and height fields on the same line.
theme_uc_product_feature_add_form	ubercart/uc_product/uc_product.admin.inc	@see uc_product_feature_add_form()
theme_uc_product_field_settings_form	ubercart/uc_product/uc_product.admin.inc	Display the product field settings form. See alsouc_product_field_settings_form()
theme_uc_product_form_prices	ubercart/uc_product/uc_product.module
theme_uc_product_form_weight	ubercart/uc_product/uc_product.module
theme_uc_product_image	ubercart/uc_product/uc_product.module	Format a product's images with imagecache and Thickbox.
theme_uc_product_kit_add_to_cart	ubercart/uc_product_kit/uc_product_kit.module	Wrap the "Add to Cart" form in a <div>.
theme_uc_product_model	ubercart/uc_product/uc_product.module	Format a product's model number.
theme_uc_product_price	ubercart/uc_product/uc_product.module	Format a product's price.
theme_uc_product_weight	ubercart/uc_product/uc_product.module	Format a product's weight.
theme_uc_quote_method_settings	ubercart/shipping/uc_quote/uc_quote.admin.inc	Display a formatted list of shipping quote methods and form elements. See alsouc_quote_method_settings()
theme_uc_reports_product_table	ubercart/uc_reports/uc_reports.admin.inc	Return a themed table for product reports.
theme_uc_roles_expiration	ubercart/uc_roles/uc_roles.admin.inc	Theme user role expiration page.
theme_uc_roles_user_expiration	ubercart/uc_roles/uc_roles.module	Theme the role expiration table within the roles dialog on the account edit page.
theme_uc_shipping_address	ubercart/shipping/uc_shipping/uc_shipping.module	Compact the address into a table.
theme_uc_shipping_edit_package_fieldset	ubercart/shipping/uc_shipping/uc_shipping.admin.inc	Display a formatted shipping type fieldset.
theme_uc_shipping_new_package_fieldset	ubercart/shipping/uc_shipping/uc_shipping.admin.inc	Format and display the products in a shipping type fieldset.
theme_uc_shipping_new_shipment	ubercart/shipping/uc_shipping/uc_shipping.admin.inc	Format and display the new shipment form.
theme_uc_shipping_package_dimensions	ubercart/shipping/uc_shipping/uc_shipping.module	Display length, width, and height fields on one line.
theme_uc_stock_edit_form	ubercart/uc_stock/uc_stock.admin.inc	@see uc_stock_edit_form()
theme_uc_store_address_fields_form	ubercart/uc_store/uc_store.module	@see uc_store_address_fields_form()
theme_uc_store_footer	ubercart/uc_store/uc_store.module	Wrap the footer in a div so it can be re-styled.
theme_uc_ups_confirm_shipment	ubercart/shipping/uc_ups/uc_ups.admin.inc	Display final shipment information for review. See alsouc_ups_confirm_shipment()
theme_uc_ups_label_image	ubercart/shipping/uc_ups/uc_ups.admin.inc	Display the shipping label for printing.
theme_uc_ups_option_label	ubercart/shipping/uc_ups/uc_ups.admin.inc	Theme function to format the UPS service name and rate amount line-item shown to the customer.
theme_update_report	drupal/modules/update/update.report.inc	Theme project status report.
theme_update_version	drupal/modules/update/update.report.inc	Theme the version display of a project.
theme_upload_attachments	drupal/modules/upload/upload.module	Displays file attachments in table
theme_upload_form_current	drupal/modules/upload/upload.module	Theme the attachments list.
theme_upload_form_new	drupal/modules/upload/upload.module	Theme the attachment form. Note: required to output prefix/suffix.
theme_username	drupal/includes/theme.inc	Format a username.
theme_user_admin_account	drupal/modules/user/user.admin.inc	Theme user administration overview.
theme_user_admin_new_role	drupal/modules/user/user.admin.inc	Theme the new-role form.
theme_user_admin_perm	drupal/modules/user/user.admin.inc	Theme the administer permissions page.
theme_user_filters	drupal/modules/user/user.admin.inc	Theme user administration filter selector.
theme_user_filter_form	drupal/modules/user/user.admin.inc	Theme user administration filter form.
theme_user_list	drupal/modules/user/user.module	Make a list of users.
theme_user_profile	docs/docs/developer/theme.php	Theme a user page.
theme_user_signature	drupal/modules/user/user.module	Theme output of user signature.
theme_xml_icon	drupal/includes/theme.inc	Return code that emits an XML icon.