Since #283723: Make menu_tree_output() return renderable output, menu_tree() returns a renderable array instead of rendered HTML as claimed by the doxygen @return directive.

CommentFileSizeAuthor
#2 851348-menu-returns-array-2.patch970 bytesmr.baileys
menu-returns-array.patch911 bytesmr.baileys
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

Good catch.

Do you think that the @return should still be specific about the structured array being related to the requested menu tree, as it did before? I mean, " A structured array to be rendered by drupal_render()." is not very specific. The previous line there was "The rendered HTML of that menu on the current page.", which is more specific.

mr.baileys’s picture

mr.baileys
Primary language Dutch
Location 🇧🇪 (Ghent)
CreditAttribution: mr.baileys commented
FileSize
851348-menu-returns-array-2.patch970 bytes

Yes, agreed that it should be more specific, patch attached.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community

Thanks - this version looks fine to me.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Title: menu_tree() returns a renderable array, not rendered HTML » Fix doc: menu_tree() returns a renderable array, not rendered HTML
webchick’s picture

webchick
she/they
Primary language English
Location Vancouver 🇨🇦
CreditAttribution: webchick commented
Status: Reviewed & tested by the community » Fixed

Committed to HEAD!

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.