function book_get_flat_menu

Gets the book menu tree for a page and returns it as a linear array.

Parameters

array $book_link: A fully loaded menu link that is part of the book hierarchy.

Return value

array: A linear array of menu links in the order that the links are shown in the menu, so the previous and next pages are the elements before and after the element corresponding to the current node. The children of the current node (if any) will come immediately after it in the array, and links will only be fetched as deep as one level deeper than $book_link.

File

core/modules/book/book.module, line 720

Allows users to create and organize related content in an outline.

Code

function book_get_flat_menu($book_link) {
  $flat = &backdrop_static(__FUNCTION__, array());

  if (!isset($flat[$book_link['mlid']])) {
    // Call menu_tree_all_data() to take advantage of the menu system's caching.
    $tree = menu_tree_all_data($book_link['menu_name'], $book_link, $book_link['depth'] + 1);
    $flat[$book_link['mlid']] = array();
    _book_flatten_menu($tree, $flat[$book_link['mlid']]);
  }

  return $flat[$book_link['mlid']];
}