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