From 769f1867555e922374a142a17bffe1217aa52d43 Mon Sep 17 00:00:00 2001
From: Angie Byron <webchick@24967.no-reply.drupal.org>
Date: Thu, 5 Aug 2010 07:56:50 +0000
Subject: [PATCH] #851348 by mr.baileys: Fixed Fix doc: menu_tree() returns a
renderable array, not rendered HTML.
---
includes/menu.inc | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/includes/menu.inc b/includes/menu.inc
index d79621f932e2..4f610f39dba5 100644
--- a/includes/menu.inc
+++ b/includes/menu.inc
@@ -865,7 +865,7 @@ function menu_get_object($type = 'node', $position = 1, $path = NULL) {
}
/**
- * Render a menu tree based on the current path.
+ * Renders a menu tree based on the current path.
*
* The tree is expanded based on the current path and dynamic paths are also
* changed according to the defined to_arg functions (for example the 'My
@@ -875,7 +875,8 @@ function menu_get_object($type = 'node', $position = 1, $path = NULL) {
* The name of the menu.
*
* @return
- * The rendered HTML of that menu on the current page.
+ * A structured array representing the specified menu on the current page, to
+ * be rendered by drupal_render().
*/
function menu_tree($menu_name) {
$menu_output = &drupal_static(__FUNCTION__, array());
--
GitLab