From 78fbe9a5a557346bf6ff20eae663e809db29e90f Mon Sep 17 00:00:00 2001
From: TravisCarden <TravisCarden@236758.no-reply.drupal.org>
Date: Fri, 13 Apr 2012 11:33:31 -0500
Subject: [PATCH] Issue #1443202: Applied documentation standards for hook_preprocess_HOOK().

---
 core/modules/aggregator/aggregator.module          |    2 +-
 core/modules/book/book.module                      |    2 +-
 core/modules/comment/comment.api.php               |    5 ++-
 core/modules/comment/comment.module                |    2 +-
 core/modules/entity/entity.api.php                 |    3 +-
 core/modules/forum/forum.module                    |    2 +-
 core/modules/help/help.module                      |    2 +-
 core/modules/locale/locale.module                  |    2 +-
 core/modules/menu/menu.module                      |    2 +-
 core/modules/node/node.api.php                     |    5 ++-
 core/modules/node/node.module                      |    2 +-
 core/modules/overlay/overlay.module                |    8 ++----
 core/modules/poll/poll.module                      |    2 +-
 core/modules/rdf/rdf.module                        |   26 ++++++++++----------
 core/modules/search/search.module                  |    2 +-
 core/modules/shortcut/shortcut.module              |    4 +-
 core/modules/statistics/statistics.module          |    2 +-
 core/modules/system/system.module                  |    2 +-
 .../tests/modules/theme_test/theme_test.module     |    2 +-
 core/modules/system/tests/theme.test               |    4 +-
 core/modules/taxonomy/taxonomy.api.php             |    4 +-
 core/modules/toolbar/toolbar.module                |    4 +-
 core/modules/user/user.api.php                     |    5 ++-
 core/modules/user/user.module                      |    2 +-
 core/themes/bartik/template.php                    |    2 +-
 25 files changed, 50 insertions(+), 48 deletions(-)

diff --git a/core/modules/aggregator/aggregator.module b/core/modules/aggregator/aggregator.module
index 9a266ba..487098e 100644
--- a/core/modules/aggregator/aggregator.module
+++ b/core/modules/aggregator/aggregator.module
@@ -786,7 +786,7 @@ function _aggregator_items($count) {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function aggregator_preprocess_block(&$variables) {
   if ($variables['block']->module == 'aggregator') {
diff --git a/core/modules/book/book.module b/core/modules/book/book.module
index a29a331..408e02f 100644
--- a/core/modules/book/book.module
+++ b/core/modules/book/book.module
@@ -1067,7 +1067,7 @@ function _book_link_defaults($nid) {
 }
 
  /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function book_preprocess_block(&$variables) {
   if ($variables['block']-> module == 'book') {
diff --git a/core/modules/comment/comment.api.php b/core/modules/comment/comment.api.php
index eb9f34d..256a804 100644
--- a/core/modules/comment/comment.api.php
+++ b/core/modules/comment/comment.api.php
@@ -85,8 +85,9 @@ function hook_comment_view(Comment $comment, $view_mode, $langcode) {
  *
  * If the module wishes to act on the rendered HTML of the comment rather than
  * the structured content array, it may use this hook to add a #post_render
- * callback. Alternatively, it could also implement hook_preprocess_comment().
- * See drupal_render() and theme() documentation respectively for details.
+ * callback. Alternatively, it could also implement hook_preprocess_HOOK() for
+ * comment.tpl.php. See drupal_render() and theme() documentation respectively
+ * for details.
  *
  * @param $build
  *   A renderable array representing the comment.
diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module
index a714419..729b90c 100644
--- a/core/modules/comment/comment.module
+++ b/core/modules/comment/comment.module
@@ -2105,7 +2105,7 @@ function comment_form_submit($form, &$form_state) {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function comment_preprocess_block(&$variables) {
   if ($variables['block']->module == 'comment') {
diff --git a/core/modules/entity/entity.api.php b/core/modules/entity/entity.api.php
index e983778..ce75b18 100644
--- a/core/modules/entity/entity.api.php
+++ b/core/modules/entity/entity.api.php
@@ -399,7 +399,8 @@ function hook_entity_view($entity, $type, $view_mode, $langcode) {
  *
  * If a module wishes to act on the rendered HTML of the entity rather than the
  * structured content array, it may use this hook to add a #post_render
- * callback. Alternatively, it could also implement hook_preprocess_ENTITY().
+ * callback. Alternatively, it could also implement hook_preprocess_HOOK() for
+ * the particular entity type template, if there is one (e.g., node.tpl.php).
  * See drupal_render() and theme() for details.
  *
  * @param $build
diff --git a/core/modules/forum/forum.module b/core/modules/forum/forum.module
index 180f1c9..4599921 100644
--- a/core/modules/forum/forum.module
+++ b/core/modules/forum/forum.module
@@ -970,7 +970,7 @@ function forum_get_topics($tid, $sortby, $forum_per_page) {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function forum_preprocess_block(&$variables) {
   if ($variables['block']->module == 'forum') {
diff --git a/core/modules/help/help.module b/core/modules/help/help.module
index 9e74751..ed9e52f 100644
--- a/core/modules/help/help.module
+++ b/core/modules/help/help.module
@@ -66,7 +66,7 @@ function help_help($path, $arg) {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function help_preprocess_block(&$variables) {
   if ($variables['block']->module == 'help') {
diff --git a/core/modules/locale/locale.module b/core/modules/locale/locale.module
index 6f81480..d5140a8 100644
--- a/core/modules/locale/locale.module
+++ b/core/modules/locale/locale.module
@@ -861,7 +861,7 @@ function locale_form_system_file_system_settings_alter(&$form, $form_state) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK().
+ * Implements hook_preprocess_HOOK() for node.tpl.php.
  */
 function locale_preprocess_node(&$variables) {
   if ($variables['langcode'] != LANGUAGE_NOT_SPECIFIED) {
diff --git a/core/modules/menu/menu.module b/core/modules/menu/menu.module
index 1f8bd3a..b4497a8 100644
--- a/core/modules/menu/menu.module
+++ b/core/modules/menu/menu.module
@@ -794,7 +794,7 @@ function menu_get_menus($all = TRUE) {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function menu_preprocess_block(&$variables) {
   if ($variables['block']->module == 'menu') {
diff --git a/core/modules/node/node.api.php b/core/modules/node/node.api.php
index 2324b47..9accd6b 100644
--- a/core/modules/node/node.api.php
+++ b/core/modules/node/node.api.php
@@ -834,8 +834,9 @@ function hook_node_view($node, $view_mode, $langcode) {
  *
  * If the module wishes to act on the rendered HTML of the node rather than the
  * structured content array, it may use this hook to add a #post_render
- * callback.  Alternatively, it could also implement hook_preprocess_node(). See
- * drupal_render() and theme() documentation respectively for details.
+ * callback.  Alternatively, it could also implement hook_preprocess_HOOK() for
+ * node.tpl.php. See drupal_render() and theme() documentation respectively
+ * for details.
  *
  * @param $build
  *   A renderable array representing the node content.
diff --git a/core/modules/node/node.module b/core/modules/node/node.module
index a59a5c7..1dcc904 100644
--- a/core/modules/node/node.module
+++ b/core/modules/node/node.module
@@ -1491,7 +1491,7 @@ function node_is_page($node) {
 }
 
  /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function node_preprocess_block(&$variables) {
   if ($variables['block']->module == 'node') {
diff --git a/core/modules/overlay/overlay.module b/core/modules/overlay/overlay.module
index 144c2ab..7842aaf 100644
--- a/core/modules/overlay/overlay.module
+++ b/core/modules/overlay/overlay.module
@@ -443,7 +443,7 @@ function overlay_system_info_alter(&$info, $file, $type) {
 }
 
 /**
- * Implements hook_preprocess_html().
+ * Implements hook_preprocess_HOOK() for html.tpl.php.
  *
  * If the current page request is inside the overlay, add appropriate classes
  * to the <body> element, and simplify the page title.
@@ -458,12 +458,10 @@ function overlay_preprocess_html(&$variables) {
 }
 
 /**
- * Implements hook_preprocess_maintenance_page().
+ * Implements hook_preprocess_HOOK() for maintenance-page.tpl.php.
  *
  * If the current page request is inside the overlay, add appropriate classes
  * to the <body> element, and simplify the page title.
- *
- * @see overlay_preprocess_maintenance_page()
  */
 function overlay_preprocess_maintenance_page(&$variables) {
   overlay_preprocess_html($variables);
@@ -493,7 +491,7 @@ function template_process_overlay(&$variables) {
 }
 
 /**
- * Implements hook_preprocess_page().
+ * Implements hook_preprocess_HOOK() for page.tpl.php.
  *
  * Hide tabs inside the overlay.
  *
diff --git a/core/modules/poll/poll.module b/core/modules/poll/poll.module
index c801579..e6c374e 100644
--- a/core/modules/poll/poll.module
+++ b/core/modules/poll/poll.module
@@ -773,7 +773,7 @@ function poll_vote($form, &$form_state) {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function poll_preprocess_block(&$variables) {
   if ($variables['block']->module == 'poll') {
diff --git a/core/modules/rdf/rdf.module b/core/modules/rdf/rdf.module
index 8f9c025..43ee4ed 100644
--- a/core/modules/rdf/rdf.module
+++ b/core/modules/rdf/rdf.module
@@ -461,7 +461,7 @@ function rdf_process(&$variables, $hook) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK()
+ * Implements hook_preprocess_HOOK() for html.tpl.php.
  */
 function rdf_preprocess_html(&$variables) {
   // Adds RDF namespace prefix bindings in the form of an RDFa 1.1 prefix
@@ -473,7 +473,7 @@ function rdf_preprocess_html(&$variables) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK().
+ * Implements hook_preprocess_HOOK() for node.tpl.php.
  */
 function rdf_preprocess_node(&$variables) {
   // Adds RDFa markup to the node container. The about attribute specifies the
@@ -556,7 +556,7 @@ function rdf_preprocess_node(&$variables) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK().
+ * Implements hook_preprocess_HOOK() for field.tpl.php.
  */
 function rdf_preprocess_field(&$variables) {
   $element = $variables['element'];
@@ -584,7 +584,7 @@ function rdf_preprocess_field(&$variables) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK().
+ * Implements hook_preprocess_HOOK() for user-profile.tpl.php.
  */
 function rdf_preprocess_user_profile(&$variables) {
   $account = $variables['elements']['#account'];
@@ -621,7 +621,7 @@ function rdf_preprocess_user_profile(&$variables) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK().
+ * Implements hook_preprocess_HOOK() for theme_username().
  */
 function rdf_preprocess_username(&$variables) {
   // Because lang is set on the HTML element that wraps the page, the
@@ -676,7 +676,7 @@ function rdf_preprocess_username(&$variables) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK().
+ * Implements hook_preprocess_HOOK() for comment.tpl.php.
  */
 function rdf_preprocess_comment(&$variables) {
   $comment = $variables['comment'];
@@ -734,7 +734,7 @@ function rdf_preprocess_comment(&$variables) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK().
+ * Implements hook_preprocess_HOOK() for taxonomy-term.tpl.php.
  */
 function rdf_preprocess_taxonomy_term(&$variables) {
   // Adds the RDF type of the term and the term name in a <meta> tag.
@@ -778,7 +778,7 @@ function rdf_field_attach_view_alter(&$output, $context) {
 }
 
 /**
- * Implements MODULE_preprocess_HOOK().
+ * Implements hook_preprocess_HOOK() for theme_image().
  */
 function rdf_preprocess_image(&$variables) {
   // Adds the RDF type for image.  We cannot use the usual entity-based mapping
@@ -830,11 +830,11 @@ function rdf_preprocess_image(&$variables) {
  *     wrapped by a <span> tag. Modules implementing preprocess functions that
  *     set 'rdf_template_variable_attributes_array' for a particular template
  *     variable that might contain block level HTML must also implement
- *     hook_preprocess_rdf_template_variable_wrapper() and set 'inline' to FALSE
- *     for that context. Themes that render normally inline content with block
- *     level HTML must similarly implement
- *     hook_preprocess_rdf_template_variable_wrapper() and set 'inline'
- *     accordingly.
+ *     hook_preprocess_HOOK() for theme_rdf_template_variable_wrapper() and set
+ *     'inline' to FALSE for that context. Themes that render normally inline
+ *     content with block level HTML must similarly implement
+ *     hook_preprocess_HOOK() for theme_rdf_template_variable_wrapper() and set
+ *     'inline' accordingly.
  *
  * @see rdf_process()
  * @ingroup themeable
diff --git a/core/modules/search/search.module b/core/modules/search/search.module
index 587ef43..86a8a6a 100644
--- a/core/modules/search/search.module
+++ b/core/modules/search/search.module
@@ -154,7 +154,7 @@ function search_block_view($delta = '') {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function search_preprocess_block(&$variables) {
   if ($variables['block']->module == 'search' && $variables['block']->delta == 'form') {
diff --git a/core/modules/shortcut/shortcut.module b/core/modules/shortcut/shortcut.module
index aa43503..bd3c1e0 100644
--- a/core/modules/shortcut/shortcut.module
+++ b/core/modules/shortcut/shortcut.module
@@ -640,7 +640,7 @@ function shortcut_renderable_links($shortcut_set = NULL) {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function shortcut_preprocess_block(&$variables) {
   if ($variables['block']->module == 'shortcut') {
@@ -649,7 +649,7 @@ function shortcut_preprocess_block(&$variables) {
 }
 
 /**
- * Implements hook_preprocess_page().
+ * Implements hook_preprocess_HOOK() for page.tpl.php.
  */
 function shortcut_preprocess_page(&$variables) {
   // Only display the shortcut link if the user has the ability to edit
diff --git a/core/modules/statistics/statistics.module b/core/modules/statistics/statistics.module
index af1f833..e2ad4e7 100644
--- a/core/modules/statistics/statistics.module
+++ b/core/modules/statistics/statistics.module
@@ -429,7 +429,7 @@ function statistics_update_index() {
   variable_set('node_cron_views_scale', 1.0 / max(1, db_query('SELECT MAX(totalcount) FROM {node_counter}')->fetchField()));
 }
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function statistics_preprocess_block(&$variables) {
   if ($variables['block']->module == 'statistics') {
diff --git a/core/modules/system/system.module b/core/modules/system/system.module
index a3594b9..149b1bb 100644
--- a/core/modules/system/system.module
+++ b/core/modules/system/system.module
@@ -2125,7 +2125,7 @@ function system_block_view($delta = '') {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function system_preprocess_block(&$variables) {
   if ($variables['block']->module == 'system') {
diff --git a/core/modules/system/tests/modules/theme_test/theme_test.module b/core/modules/system/tests/modules/theme_test/theme_test.module
index f2cd4a0..42bbffc 100644
--- a/core/modules/system/tests/modules/theme_test/theme_test.module
+++ b/core/modules/system/tests/modules/theme_test/theme_test.module
@@ -136,7 +136,7 @@ function _theme_test_suggestion() {
 }
 
 /**
- * Implements hook_preprocess_html().
+ * Implements hook_preprocess_HOOK() for html.tpl.php.
  */
 function theme_test_preprocess_html(&$variables) {
   $variables['html_attributes_array']['theme_test_html_attribute'] = 'theme test html attribute value';
diff --git a/core/modules/system/tests/theme.test b/core/modules/system/tests/theme.test
index 978887c..92d7cb7 100644
--- a/core/modules/system/tests/theme.test
+++ b/core/modules/system/tests/theme.test
@@ -578,9 +578,9 @@ class ThemeHtmlTplPhpAttributesTestCase extends DrupalWebTestCase {
   function testThemeHtmlTplPhpAttributes() {
     $this->drupalGet('');
     $attributes = $this->xpath('/html[@theme_test_html_attribute="theme test html attribute value"]');
-    $this->assertTrue(count($attributes) == 1, t('Attribute set in the html element via hook_preprocess_html() found.'));
+    $this->assertTrue(count($attributes) == 1, 'Attribute set in the html element via hook_preprocess_HOOK() for html.tpl.php found.');
     $attributes = $this->xpath('/html/body[@theme_test_body_attribute="theme test body attribute value"]');
-    $this->assertTrue(count($attributes) == 1, t('Attribute set in the body element via hook_preprocess_html() found.'));
+    $this->assertTrue(count($attributes) == 1, 'Attribute set in the body element via hook_preprocess_HOOK() for html.tpl.php found.');
   }
 }
 
diff --git a/core/modules/taxonomy/taxonomy.api.php b/core/modules/taxonomy/taxonomy.api.php
index 84fdfc7..88a0ff5 100644
--- a/core/modules/taxonomy/taxonomy.api.php
+++ b/core/modules/taxonomy/taxonomy.api.php
@@ -232,8 +232,8 @@ function hook_taxonomy_term_delete(TaxonomyTerm $term) {
  * If the module wishes to act on the rendered HTML of the term rather than the
  * structured content array, it may use this hook to add a #post_render
  * callback. Alternatively, it could also implement
- * hook_preprocess_taxonomy_term(). See drupal_render() and theme()
- * documentation respectively for details.
+ * hook_preprocess_HOOK() for taxonomy-term.tpl.php. See drupal_render() and
+ * theme() documentation respectively for details.
  *
  * @param $build
  *   A renderable array representing the taxonomy term content.
diff --git a/core/modules/toolbar/toolbar.module b/core/modules/toolbar/toolbar.module
index e2bff73..904a2f8 100644
--- a/core/modules/toolbar/toolbar.module
+++ b/core/modules/toolbar/toolbar.module
@@ -140,7 +140,7 @@ function toolbar_pre_render($toolbar) {
 }
 
 /**
- * Implements hook_preprocess_html().
+ * Implements hook_preprocess_HOOK() for html.tpl.php.
  *
  * Add some page classes, so global page theming can adjust to the toolbar.
  */
@@ -154,7 +154,7 @@ function toolbar_preprocess_html(&$vars) {
 }
 
 /**
- * Implements hook_preprocess_toolbar().
+ * Implements hook_preprocess_HOOK() for toolbar.tpl.php.
  *
  * Adding the 'overlay-displace-top' class to the toolbar pushes the overlay
  * down, so it appears below the toolbar.
diff --git a/core/modules/user/user.api.php b/core/modules/user/user.api.php
index dc16906..b9a5b5d 100644
--- a/core/modules/user/user.api.php
+++ b/core/modules/user/user.api.php
@@ -363,8 +363,9 @@ function hook_user_view($account, $view_mode, $langcode) {
  *
  * If the module wishes to act on the rendered HTML of the user rather than the
  * structured content array, it may use this hook to add a #post_render callback.
- * Alternatively, it could also implement hook_preprocess_user_profile(). See
- * drupal_render() and theme() documentation respectively for details.
+ * Alternatively, it could also implement hook_preprocess_HOOK() for
+ * user-profile.tpl.php. See drupal_render() and theme() documentation
+ * respectively for details.
  *
  * @param $build
  *   A renderable array representing the user.
diff --git a/core/modules/user/user.module b/core/modules/user/user.module
index 3b1d9cb..e525592 100644
--- a/core/modules/user/user.module
+++ b/core/modules/user/user.module
@@ -1333,7 +1333,7 @@ function user_block_view($delta = '') {
 }
 
 /**
- * Implements hook_preprocess_block().
+ * Implements hook_preprocess_HOOK() for block.tpl.php.
  */
 function user_preprocess_block(&$variables) {
   if ($variables['block']->module == 'user') {
diff --git a/core/themes/bartik/template.php b/core/themes/bartik/template.php
index 459a593..a9f4c44 100644
--- a/core/themes/bartik/template.php
+++ b/core/themes/bartik/template.php
@@ -70,7 +70,7 @@ function bartik_process_page(&$variables) {
 }
 
 /**
- * Implements hook_preprocess_maintenance_page().
+ * Implements hook_preprocess_HOOK() for maintenance-page.tpl.php.
  */
 function bartik_preprocess_maintenance_page(&$variables) {
   // By default, site_name is set to Drupal if no db connection is available
-- 
1.7.4.1