summaryrefslogtreecommitdiff
path: root/includes/theme.inc
diff options
context:
space:
mode:
authorJennifer Hodgdon <yahgrp@poplarware.com>2013-06-06 09:15:28 -0700
committerJennifer Hodgdon <yahgrp@poplarware.com>2013-06-06 09:15:28 -0700
commitbb412015ea8b4680713ddca4402ab64447164556 (patch)
treeaa46c14271f7deaeccfa351ee5796b4bea982000 /includes/theme.inc
parent0811215768c48dd3a802c6dc91ca781964fd815f (diff)
downloadbrdo-bb412015ea8b4680713ddca4402ab64447164556.tar.gz
brdo-bb412015ea8b4680713ddca4402ab64447164556.tar.bz2
Issue #1811520 by JacobSanford, lirantal: Add section tags to theme, hook_menu, and t documentation.
Diffstat (limited to 'includes/theme.inc')
-rw-r--r--includes/theme.inc5
1 files changed, 5 insertions, 0 deletions
diff --git a/includes/theme.inc b/includes/theme.inc
index d1864c836..9f93d2004 100644
--- a/includes/theme.inc
+++ b/includes/theme.inc
@@ -874,6 +874,7 @@ function drupal_find_base_themes($themes, $key, $used_keys = array()) {
* @link themeable theme function or template @endlink, by checking the theme
* registry.
*
+ * @section sec_theme_hooks Theme Hooks
* Most commonly, the first argument to this function is the name of the theme
* hook. For instance, to theme a taxonomy term, the theme hook name is
* 'taxonomy_term'. Modules register theme hooks within a hook_theme()
@@ -885,6 +886,7 @@ function drupal_find_base_themes($themes, $key, $used_keys = array()) {
* underscores changed to hyphens, so for the 'taxonomy_term' theme hook, the
* default template is 'taxonomy-term.tpl.php'.
*
+ * @subsection sub_overriding_theme_hooks Overriding Theme Hooks
* Themes may also register new theme hooks within a hook_theme()
* implementation, but it is more common for themes to override default
* implementations provided by modules than to register entirely new theme
@@ -897,6 +899,7 @@ function drupal_find_base_themes($themes, $key, $used_keys = array()) {
* rendering engine, it overrides the default implementation of the 'page' theme
* hook by containing a 'page.tpl.php' file within its folder structure).
*
+ * @subsection sub_preprocess_templates Preprocessing for Template Files
* If the implementation is a template file, several functions are called
* before the template file is invoked, to modify the $variables array. These
* fall into the "preprocessing" phase and the "processing" phase, and are
@@ -945,12 +948,14 @@ function drupal_find_base_themes($themes, $key, $used_keys = array()) {
* - THEME_process_HOOK(&$variables): Allows the theme to process the
* variables specific to the theme hook.
*
+ * @subsection sub_preprocess_theme_funcs Preprocessing for Theme Functions
* If the implementation is a function, only the theme-hook-specific preprocess
* and process functions (the ones ending in _HOOK) are called from the
* list above. This is because theme hooks with function implementations
* need to be fast, and calling the non-theme-hook-specific preprocess and
* process functions for them would incur a noticeable performance penalty.
*
+ * @subsection sub_alternate_suggestions Suggesting Alternate Hooks
* There are two special variables that these preprocess and process functions
* can set: 'theme_hook_suggestion' and 'theme_hook_suggestions'. These will be
* merged together to form a list of 'suggested' alternate theme hooks to use,