Default theme implementations

  1. 7.x drupal/modules/system/theme.api.php themeable
  2. 5.x drupal/includes/theme.inc themeable
  3. 6.x drupal/includes/theme.inc themeable
  4. 8.x drupal/core/modules/system/theme.api.php themeable

Functions and templates for the user interface to 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 an array of variables. For example, theme('table', array('header' => $header, 'rows' => $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'), $variables) 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 THEMENAME_HOOK. For example, for Drupal's default theme (Bartik) to implement the 'table' hook, the phptemplate.engine would find bartik_table().

The theme system is described and defined in theme.inc.

End of "defgroup themeable".

See also

theme()

hook_theme()

Hooks

Callbacks

Functions

Name Locationsort descending Description
theme_select drupal/includes/form.inc Returns HTML for a select form element.
theme_fieldset drupal/includes/form.inc Returns HTML for a fieldset form element and its children.
theme_radio drupal/includes/form.inc Returns HTML for a radio button form element.
theme_radios drupal/includes/form.inc Returns HTML for a set of radio button form elements.
theme_date drupal/includes/form.inc Returns HTML for a date selection form element.
theme_checkbox drupal/includes/form.inc Returns HTML for a checkbox form element.
theme_checkboxes drupal/includes/form.inc Returns HTML for a set of checkbox form elements.
theme_container drupal/includes/form.inc Returns HTML to wrap child elements in a container.
theme_tableselect drupal/includes/form.inc Returns HTML for a table with radio buttons or checkboxes.
theme_vertical_tabs drupal/includes/form.inc Returns HTML for an element's children fieldsets as vertical tabs.
theme_submit drupal/includes/form.inc Returns HTML for a submit button form element.
theme_button drupal/includes/form.inc Returns HTML for a button form element.
theme_image_button drupal/includes/form.inc Returns HTML for an image button form element.
theme_hidden drupal/includes/form.inc Returns HTML for a hidden form element.
theme_textfield drupal/includes/form.inc Returns HTML for a textfield form element.
theme_form drupal/includes/form.inc Returns HTML for a form.
theme_textarea drupal/includes/form.inc Returns HTML for a textarea form element.
theme_password drupal/includes/form.inc Returns HTML for a password form element.
theme_file drupal/includes/form.inc Returns HTML for a file upload form element.
theme_form_element drupal/includes/form.inc Returns HTML for a form element.
theme_form_required_marker drupal/includes/form.inc Returns HTML for a marker for required form elements.
theme_form_element_label drupal/includes/form.inc Returns HTML for a form element label and required marker.
theme_menu_tree drupal/includes/menu.inc Returns HTML for a wrapper for a menu sub-tree.
theme_menu_link drupal/includes/menu.inc Returns HTML for a menu link and submenu.
theme_menu_local_task drupal/includes/menu.inc Returns HTML for a single local task link.
theme_menu_local_action drupal/includes/menu.inc Returns HTML for a single local action link.
theme_menu_local_tasks drupal/includes/menu.inc Returns HTML for primary and secondary local tasks.
theme_pager drupal/includes/pager.inc Returns HTML for a query pager.
theme_pager_first drupal/includes/pager.inc Returns HTML for the "first page" link in a query pager.
theme_pager_previous drupal/includes/pager.inc Returns HTML for the "previous page" link in a query pager.
theme_pager_next drupal/includes/pager.inc Returns HTML for the "next page" link in a query pager.
theme_pager_last drupal/includes/pager.inc Returns HTML for the "last page" link in query pager.
theme_pager_link drupal/includes/pager.inc Returns HTML for a link to a specific query result page.
theme_status_messages drupal/includes/theme.inc Returns HTML for status and/or error messages, grouped by type.
theme_link drupal/includes/theme.inc Returns HTML for a link.
theme_links drupal/includes/theme.inc Returns HTML for a set of links.
theme_image drupal/includes/theme.inc Returns HTML for an image.
theme_breadcrumb drupal/includes/theme.inc Returns HTML for a breadcrumb trail.
theme_table drupal/includes/theme.inc Returns HTML for a table.
theme_tablesort_indicator drupal/includes/theme.inc Returns HTML for a sort icon.
theme_mark drupal/includes/theme.inc Returns HTML for a marker for new or updated content.
theme_item_list drupal/includes/theme.inc Returns HTML for a list or nested list of items.
theme_more_help_link drupal/includes/theme.inc Returns HTML for a "more help" link.
theme_feed_icon drupal/includes/theme.inc Returns HTML for a feed icon.
theme_html_tag drupal/includes/theme.inc Returns HTML for a generic HTML tag with attributes.
theme_more_link drupal/includes/theme.inc Returns HTML for a "more" link, like those used in blocks.
theme_username drupal/includes/theme.inc Returns HTML for a username, potentially linked to the user's page.
theme_progress_bar drupal/includes/theme.inc Returns HTML for a progress bar.
theme_indentation drupal/includes/theme.inc Returns HTML for an indentation div; used for drag and drop tables.
theme_task_list drupal/includes/theme.maintenance.inc Returns HTML for a list of maintenance tasks to perform.
theme_authorize_report drupal/includes/theme.maintenance.inc Returns HTML for a results report of an operation run by authorize.php.
theme_authorize_message drupal/includes/theme.maintenance.inc Returns HTML for a single log message from the authorize.php batch operation.
theme_aggregator_block_item drupal/modules/aggregator/aggregator.module Returns HTML for an individual feed item for display in the block.
theme_aggregator_categorize_items drupal/modules/aggregator/aggregator.pages.inc Returns HTML for the aggregator page list form for assigning categories.
theme_aggregator_page_rss drupal/modules/aggregator/aggregator.pages.inc Prints the RSS page for a feed.
theme_aggregator_page_opml drupal/modules/aggregator/aggregator.pages.inc Prints the OPML page for the feed.
theme_book_admin_table drupal/modules/book/book.admin.inc Returns HTML for a book administration form.
theme_book_title_link drupal/modules/book/book.module Returns HTML for a link to a book title when used as a block title.
theme_color_scheme_form drupal/modules/color/color.module Returns HTML for a theme's color form.
theme_comment_block drupal/modules/comment/comment.module Returns HTML for a list of recent comments to be displayed in the comment block.
theme_comment_post_forbidden drupal/modules/comment/comment.module Returns HTML for a "you can't post comments" notice.
theme_dashboard drupal/modules/dashboard/dashboard.module Returns HTML for the entire dashboard.
theme_dashboard_admin drupal/modules/dashboard/dashboard.module Returns HTML for the non-customizable part of the dashboard page.
theme_dashboard_region drupal/modules/dashboard/dashboard.module Returns HTML for a generic dashboard region.
theme_dashboard_disabled_blocks drupal/modules/dashboard/dashboard.module Returns HTML for disabled blocks, for use in dashboard customization mode.
theme_dashboard_disabled_block drupal/modules/dashboard/dashboard.module Returns HTML for disabled blocks, for use in dashboard customization mode.
theme_dblog_message drupal/modules/dblog/dblog.admin.inc Returns HTML for a log message.
theme_field_multiple_value_form drupal/modules/field/field.form.inc Returns HTML for an individual form element.
theme_field drupal/modules/field/field.module Returns HTML for a field.
theme_options_none drupal/modules/field/modules/options/options.module Returns HTML for the label for the empty value for options that are not required.
theme_field_ui_table drupal/modules/field_ui/field_ui.admin.inc Returns HTML for Field UI overview tables.
theme_file_widget drupal/modules/file/file.field.inc Returns HTML for an individual file upload widget.
theme_file_widget_multiple drupal/modules/file/file.field.inc Returns HTML for a group of file upload widgets.
theme_file_upload_help drupal/modules/file/file.field.inc Returns HTML for help text based on file upload validators.
theme_file_formatter_table drupal/modules/file/file.field.inc Returns HTML for a file attachments table.
theme_file_managed_file drupal/modules/file/file.module Returns HTML for a managed file element.
theme_file_link drupal/modules/file/file.module Returns HTML for a link to a file.
theme_file_icon drupal/modules/file/file.module Returns HTML for an image with an appropriate icon for the given file.
theme_filter_admin_overview drupal/modules/filter/filter.admin.inc Returns HTML for the text format administration overview form.
theme_filter_admin_format_filter_order drupal/modules/filter/filter.admin.inc Returns HTML for a text format's filter order form.
theme_text_format_wrapper drupal/modules/filter/filter.module Returns HTML for a text format-enabled form element.
theme_filter_tips_more_info drupal/modules/filter/filter.module Returns HTML for a link to the more extensive filter tips.
theme_filter_guidelines drupal/modules/filter/filter.module Returns HTML for guidelines for a text format.
theme_filter_tips drupal/modules/filter/filter.pages.inc Returns HTML for a set of filter tips.
theme_forum_form drupal/modules/forum/forum.admin.inc Returns HTML for a forum form.
theme_image_style_list drupal/modules/image/image.admin.inc Returns HTML for the page containing the list of image styles.
theme_image_style_effects drupal/modules/image/image.admin.inc Returns HTML for a listing of the effects within a specific image style.
theme_image_style_preview drupal/modules/image/image.admin.inc Returns HTML for a preview of an image style.
theme_image_anchor drupal/modules/image/image.admin.inc Returns HTML for a 3x3 grid of checkboxes for image anchors.
theme_image_resize_summary drupal/modules/image/image.admin.inc Returns HTML for a summary of an image resize effect.
theme_image_scale_summary drupal/modules/image/image.admin.inc Returns HTML for a summary of an image scale effect.
theme_image_crop_summary drupal/modules/image/image.admin.inc Returns HTML for a summary of an image crop effect.
theme_image_rotate_summary drupal/modules/image/image.admin.inc Returns HTML for a summary of an image rotate effect.
theme_image_widget drupal/modules/image/image.field.inc Returns HTML for an image field widget.
theme_image_formatter drupal/modules/image/image.field.inc Returns HTML for an image field formatter.
theme_image_style drupal/modules/image/image.module Returns HTML for an image using a specific image style.
theme_locale_languages_overview_form drupal/modules/locale/locale.admin.inc Returns HTML for the language overview form.
theme_locale_languages_configure_form drupal/modules/locale/locale.admin.inc Returns HTML for a language configuration form.
theme_locale_date_format_form drupal/modules/locale/locale.admin.inc Returns HTML for a locale date format form.
theme_menu_admin_overview drupal/modules/menu/menu.admin.inc Returns HTML for a menu title and description for the menu overview page.
theme_menu_overview_form drupal/modules/menu/menu.admin.inc Returns HTML for the menu overview form into a table.
theme_node_admin_overview drupal/modules/node/content_types.inc Returns HTML for a node type description for the content type admin overview page.
theme_node_search_admin drupal/modules/node/node.module Returns HTML for the content ranking part of the search settings admin page.
theme_node_recent_block drupal/modules/node/node.module Returns HTML for a list of recent content.
theme_node_recent_content drupal/modules/node/node.module Returns HTML for a recent node to be displayed in the recent content block.
theme_node_add_list drupal/modules/node/node.pages.inc Returns HTML for a list of available node types for node creation.
theme_node_preview drupal/modules/node/node.pages.inc Returns HTML for a node preview for display during node creation and editing.
theme_overlay_disable_message drupal/modules/overlay/overlay.module Returns the HTML for the message about how to disable the overlay.
theme_poll_choices drupal/modules/poll/poll.module Returns HTML for an admin poll form for choices.
theme_profile_admin_overview drupal/modules/profile/profile.admin.inc Returns HTML for the profile field overview form into a drag and drop enabled table.
theme_rdf_template_variable_wrapper drupal/modules/rdf/rdf.module Returns HTML for a template variable wrapped in an HTML element with the RDF attributes.
theme_rdf_metadata drupal/modules/rdf/rdf.module Returns HTML for a series of empty spans for exporting RDF metadata in RDFa.
theme_shortcut_set_customize drupal/modules/shortcut/shortcut.admin.inc Returns HTML for a shortcut set customization form.
theme_simpletest_test_table drupal/modules/simpletest/simpletest.pages.inc Returns HTML for a test list generated by simpletest_test_form() into a table.
theme_simpletest_result_summary drupal/modules/simpletest/simpletest.pages.inc Returns HTML for the summary status of a simpletest result.
theme_system_date_time_settings drupal/modules/system/system.admin.inc Returns HTML for the date settings form.
theme_admin_block drupal/modules/system/system.admin.inc Returns HTML for an administrative block for display.
theme_admin_block_content drupal/modules/system/system.admin.inc Returns HTML for the content of an administrative block.
theme_admin_page drupal/modules/system/system.admin.inc Returns HTML for an administrative page.
theme_system_admin_index drupal/modules/system/system.admin.inc Returns HTML for the output of the dashboard page.
theme_status_report drupal/modules/system/system.admin.inc Returns HTML for the status report.
theme_system_modules_fieldset drupal/modules/system/system.admin.inc Returns HTML for the modules form.
theme_system_modules_incompatible drupal/modules/system/system.admin.inc Returns HTML for a message about incompatible modules.
theme_system_modules_uninstall drupal/modules/system/system.admin.inc Returns HTML for a table of currently disabled modules.
theme_system_themes_page drupal/modules/system/system.admin.inc Returns HTML for the Appearance page.
theme_system_powered_by drupal/modules/system/system.module Returns HTML for the Powered by Drupal text.
theme_system_compact_link drupal/modules/system/system.module Returns HTML for a link to show or hide inline help descriptions.
theme_confirm_form drupal/modules/system/system.module Returns HTML for a confirmation form.
theme_system_settings_form drupal/modules/system/system.module Returns HTML for a system settings form.
theme_exposed_filters drupal/modules/system/system.module Returns HTML for an exposed filter form.
theme_taxonomy_overview_vocabularies drupal/modules/taxonomy/taxonomy.admin.inc Returns HTML for the vocabulary overview form as a sortable list of vocabularies.
theme_taxonomy_overview_terms drupal/modules/taxonomy/taxonomy.admin.inc Returns HTML for a terms overview form as a sortable list of terms.
theme_trigger_display drupal/modules/trigger/trigger.admin.inc Returns HTML for the form showing actions assigned to a trigger.
theme_update_manager_update_form drupal/modules/update/update.manager.inc Returns HTML for the first page in the process of updating projects.
theme_update_last_check drupal/modules/update/update.module Returns HTML for the last time we checked for update data.
theme_update_report drupal/modules/update/update.report.inc Returns HTML for the project status report.
theme_update_status_label drupal/modules/update/update.report.inc Returns HTML for a label to display for a project's update status.
theme_update_version drupal/modules/update/update.report.inc Returns HTML for the version display of a project.
theme_user_admin_permissions drupal/modules/user/user.admin.inc Returns HTML for the administer permissions page.
theme_user_permission_description drupal/modules/user/user.admin.inc Returns HTML for an individual permission description.
theme_user_admin_roles drupal/modules/user/user.admin.inc Returns HTML for the role order and new role form.
theme_user_list drupal/modules/user/user.module Returns HTML for a list of users.
theme_user_signature drupal/modules/user/user.module Returns HTML for a user signature.

Files

Name Locationsort descending Description
aggregator-feed-source.tpl.php drupal/modules/aggregator/aggregator-feed-source.tpl.php Default theme implementation to present the source of the feed.
aggregator-item.tpl.php drupal/modules/aggregator/aggregator-item.tpl.php Default theme implementation to format an individual feed item for display on the aggregator page.
aggregator-summary-item.tpl.php drupal/modules/aggregator/aggregator-summary-item.tpl.php Default theme implementation to present a linked feed item for summaries.
aggregator-summary-items.tpl.php drupal/modules/aggregator/aggregator-summary-items.tpl.php Default theme implementation to present feeds as list items.
aggregator-wrapper.tpl.php drupal/modules/aggregator/aggregator-wrapper.tpl.php Default theme implementation to wrap aggregator content.
block-admin-display-form.tpl.php drupal/modules/block/block-admin-display-form.tpl.php Default theme implementation to configure blocks.
block.tpl.php drupal/modules/block/block.tpl.php Default theme implementation to display a block.
book-all-books-block.tpl.php drupal/modules/book/book-all-books-block.tpl.php Default theme implementation for rendering book outlines within a block.
book-export-html.tpl.php drupal/modules/book/book-export-html.tpl.php Default theme implementation for printed version of book outline.
book-navigation.tpl.php drupal/modules/book/book-navigation.tpl.php Default theme implementation to navigate books.
book-node-export-html.tpl.php drupal/modules/book/book-node-export-html.tpl.php Default theme implementation for a single node in a printer-friendly outline.
comment-wrapper.tpl.php drupal/modules/comment/comment-wrapper.tpl.php Default theme implementation to provide an HTML container for comments.
comment.tpl.php drupal/modules/comment/comment.tpl.php Default theme implementation for comments.
field.tpl.php drupal/modules/field/theme/field.tpl.php field.tpl.php Default template implementation to display the value of a field.
forum-icon.tpl.php drupal/modules/forum/forum-icon.tpl.php Displays an appropriate icon for a forum post.
forum-list.tpl.php drupal/modules/forum/forum-list.tpl.php Displays a list of forums and containers.
forum-submitted.tpl.php drupal/modules/forum/forum-submitted.tpl.php Formats a forum post submission string.
forum-topic-list.tpl.php drupal/modules/forum/forum-topic-list.tpl.php Displays a list of forum topics.
forums.tpl.php drupal/modules/forum/forums.tpl.php Displays a forum.
node.tpl.php drupal/modules/node/node.tpl.php Default theme implementation to display a node.
overlay.tpl.php drupal/modules/overlay/overlay.tpl.php Default theme implementation to display a page in the overlay.
poll-results.tpl.php drupal/modules/poll/poll-results.tpl.php Default theme implementation to display the poll results in a block.
poll-vote.tpl.php drupal/modules/poll/poll-vote.tpl.php Default theme implementation to display voting form for a poll.
search-result.tpl.php drupal/modules/search/search-result.tpl.php Default theme implementation for displaying a single search result.
search-results.tpl.php drupal/modules/search/search-results.tpl.php Default theme implementation for displaying search results.
html.tpl.php drupal/modules/system/html.tpl.php Default theme implementation to display the basic html structure of a single Drupal page.
maintenance-page.tpl.php drupal/modules/system/maintenance-page.tpl.php Default theme implementation to display a single Drupal page while offline.
page.tpl.php drupal/modules/system/page.tpl.php Default theme implementation to display a single Drupal page.
region.tpl.php drupal/modules/system/region.tpl.php Default theme implementation to display a region.
taxonomy-term.tpl.php drupal/modules/taxonomy/taxonomy-term.tpl.php Default theme implementation to display a term.
toolbar.tpl.php drupal/modules/toolbar/toolbar.tpl.php Default template for admin toolbar.
user-picture.tpl.php drupal/modules/user/user-picture.tpl.php Default theme implementation to present a picture configured for the user's account.
user-profile.tpl.php drupal/modules/user/user-profile.tpl.php Default theme implementation to present all user profile data.

File

drupal/modules/system/theme.api.php, line 3