From 8ad5cba994367f5b5fe35a2caaae7ec321ecaebd Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Tue, 9 Dec 2008 11:36:04 +0000
Subject: - Patch #344661 by Dave Reid: API doc improvements for
 hook_translation_link_alter.

---
 modules/system/system.api.php | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

(limited to 'modules/system/system.api.php')

diff --git a/modules/system/system.api.php b/modules/system/system.api.php
index 03e9b4618..faac9a174 100644
--- a/modules/system/system.api.php
+++ b/modules/system/system.api.php
@@ -397,21 +397,22 @@ function hook_link($type, $object, $teaser = FALSE) {
 }
 
 /**
- * Perform alterations before links on a node are rendered. One popular use of
- * this hook is to add/delete links from other modules.
+ * Perform alterations before links on a node are rendered.
+ *
+ * One popular use of this hook is to add/delete links from other modules.
  *
  * @param $links
- *   Nested array of links for the node
+ *   Nested array of links for the node keyed by providing module.
  * @param $node
- *   A node object for editing links on
+ *   A node object that contains the links.
  * @return
  *   None.
  */
-function hook_link_alter(&$links, $node) {
-  foreach ($links AS $module => $link) {
+function hook_link_alter(array &$links, $node) {
+  foreach ($links as $module => $link) {
     if (strstr($module, 'taxonomy_term')) {
       // Link back to the forum and not the taxonomy term page
-      $links[$module]['#href'] = str_replace('taxonomy/term', 'forum', $link['#href']);
+      $links[$module]['href'] = str_replace('taxonomy/term', 'forum', $link['href']);
     }
   }
 }
-- 
cgit v1.2.3