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()
Dateien
| Name | Beschreibung |
|---|---|
| theme.inc | The theme system, which controls the output of Drupal. |
Funktionen & Methoden
| Name | Beschreibung |
|---|---|
| theme_admin_block | This function formats an administrative block for display. |
| theme_admin_block_content | This function formats the content of an administrative block. |
| theme_admin_page | This function formats an administrative page for viewing. |
| theme_aggregator_block_item | Format an individual feed item for display in the block. |
| theme_aggregator_categorize_items | Theme the page list form for assigning categories. |
| theme_aggregator_page_opml | Theme the OPML feed output. |
| theme_aggregator_page_rss | Theme the RSS output. |
| theme_book_admin_table | Theme function for the book administration page form. |
| theme_book_title_link | Generate the HTML output for a link to a book title when used as a block title. |
| theme_breadcrumb | Return a themed breadcrumb trail. |
| theme_button | Theme a form button. |
| theme_checkbox | Format a checkbox. |
| theme_checkboxes | Format a set of checkboxes. |
| theme_closure | Execute hook_footer() which is run at the end of the page right before the close of the body tag. |
| theme_color_scheme_form | Theme the color form. |
| theme_comment_block | Returns a formatted list of recent comments to be displayed in the comment block. |
| theme_comment_flat_collapsed | Theme comment flat collapsed view. |
| theme_comment_flat_expanded | Theme comment flat expanded view. |
| theme_comment_post_forbidden | Theme a "you can't post comments" notice. |
| theme_comment_submitted | Theme a "Submitted by ..." notice. |
| theme_comment_thread_collapsed | Theme comment thread collapsed view. |
| theme_comment_thread_expanded | Theme comment thread expanded view. |
| theme_comment_view | Theme a single comment block. |
| theme_date | Format a date selection element. |
| theme_dblog_filters | Theme dblog administration filter selector. |
| theme_feed_icon | Return code that emits an feed icon. |
| theme_fieldset | Format a group of form items. |
| theme_file | Format a file upload field. |
| theme_filter_admin_order | Theme filter order configuration form. |
| theme_filter_admin_overview | Theme the admin overview form. |
| theme_filter_guidelines | Format guidelines for a text format. |
| theme_filter_tips | Render HTML for a set of filter tips. |
| theme_filter_tips_more_info | Format a link to the more extensive filter tips. |
| theme_form | Format a form. |
| theme_form_element | Return a themed form element. |
| theme_hidden | Format a hidden form field. |
| theme_image | Return a themed image. |
| theme_image_button | Theme a form image button. |
| theme_indentation | Create a standard indentation div. Used for drag and drop tables. |
| theme_item_list | Return a themed list of items. |
| theme_links | Return a themed set of links. |
| theme_list | Return a themed list of items from a drupal_render() style array. |
| theme_locale_languages_overview_form | Theme the language overview form. |
| theme_locale_translation_filters | Theme locale translation filter selector. |
| theme_mark | Return a themed marker, useful for marking new or updated content. |
| theme_menu_item | Generate the HTML output for a menu item and submenu. |
| theme_menu_item_link | Generate the HTML output for a single menu link. |
| theme_menu_local_task | Generate the HTML output for a single local task link. |
| theme_menu_local_tasks | Returns the rendered local tasks. The default implementation renders them as tabs. |
| theme_menu_overview_form | Theme the menu overview form into a table. |
| theme_menu_tree | Generate the HTML output for a menu tree |
| theme_meta_generator_header | Send Drupal and the major version number in the HTTP headers. |
| theme_meta_generator_html | Send Drupal and the major version number in the META GENERATOR HTML. |
| theme_more_help_link | Returns code that emits the 'more help'-link. |
| theme_more_link | Returns code that emits the 'more' link used on blocks. |
| theme_node_add_list | Display the list of available node types for node creation. |
| theme_node_admin_nodes | Theme node administration overview. |
| theme_node_filters | Theme node administration filter selector. |
| theme_node_filter_form | Theme node administration filter form. |
| theme_node_form | Present a node submission form. |
| theme_node_links | Format a set of node links. |
| theme_node_list | Format a listing of links to nodes. |
| theme_node_log_message | Theme a log message. |
| theme_node_preview | Display a node preview for display during node creation and editing. |
| theme_node_search_admin | Theme the content ranking part of the search settings admin page. |
| theme_node_submitted | Format the "Submitted by username on date/time" for each node |
| theme_pager | Format a query pager. |
| theme_pager_first | Format a "first page" link. |
| theme_pager_last | Format a "last page" link. |
| theme_pager_link | Format a link to a specific query result page. |
| theme_pager_next | Format a "next page" link. |
| theme_pager_previous | Format a "previous page" link. |
| theme_password | Format a password field. |
| theme_placeholder | Formats text for emphasized display in a placeholder inside a sentence. Used automatically by t(). |
| theme_poll_choices | Theme the admin poll form for choices. |
| theme_profile_admin_overview | Theme the profile field overview into a drag and drop enabled table. |
| theme_progress_bar | Return a themed progress bar. |
| theme_radio | Format a radio button. |
| theme_radios | Format a set of radio buttons. |
| theme_select | Format a dropdown menu or scrolling selection box. |
| theme_status_messages | Return a themed set of status and/or error messages. The messages are grouped by type. |
| theme_status_report | Theme requirements status report. |
| theme_submenu | Return a themed submenu, typically displayed under the tabs. |
| theme_submit | Theme a form submit button. |
| theme_syslog_format | Format a system log entry. |
| theme_system_admin_by_module | Theme output of the dashboard page. |
| theme_system_compact_link | Display the link to show or hide inline help descriptions. |
| theme_system_modules_fieldset | Theme callback for the modules form. |
| theme_system_modules_incompatible | Themes an incompatible message. |
| theme_system_modules_uninstall | Themes a table of currently disabled modules. |
| theme_system_powered_by | Format the Powered by Drupal text. |
| theme_system_themes_form | Theme function for the system themes form. |
| theme_system_theme_select_form | Theme the theme select form. |
| theme_table | Return a themed table. |
| theme_tableselect | Format a table with radio buttons or checkboxes. |
| theme_tablesort_indicator | Return a themed sort icon. |
| theme_table_select_header_cell | Returns a header cell for tables that have a select all functionality. |
| theme_task_list | Return a themed list of maintenance tasks to perform. |
| theme_taxonomy_overview_terms | Theme the terms overview as a sortable list of terms. |
| theme_taxonomy_overview_vocabularies | Theme the vocabulary overview as a sortable list of vocabularies. |
| theme_taxonomy_term_select | Format the selection field for choosing terms (by default the default selection field is used). |
| theme_textarea | Format a textarea. |
| theme_textfield | Format a textfield. |
| theme_text_format_wrapper | Return a themed text format form element. |
| theme_trigger_display | Display actions assigned to this hook-op combination in a table. |
| theme_update_report | Theme project status report. |
| theme_update_version | Theme the version display of a project. |
| theme_upload_attachments | Displays file attachments in table |
| theme_upload_form_current | Theme the attachments list. |
| theme_upload_form_new | Theme the attachment form. Note: required to output prefix/suffix. |
| theme_username | Format a username. |
| theme_user_admin_account | Theme user administration overview. |
| theme_user_admin_new_role | Theme the new-role form. |
| theme_user_admin_perm | Theme the administer permissions page. |
| theme_user_filters | Theme user administration filter selector. |
| theme_user_filter_form | Theme user administration filter form. |
| theme_user_list | Make a list of users. |
| theme_user_signature | Theme output of user signature. |
includes/
Kommentar hinzufügen
Kommentare
Kommentar hinzufügen