function book_toc

1 book.module book_toc($bid, $depth_limit, $exclude = array())

Returns an array of book pages in table of contents order.

Parameters

int $bid: The ID of the book whose pages are to be listed.

int $depth_limit: Any link deeper than this value will be excluded (along with its children).

array $exclude: Optional array of menu link ID values. Any link whose menu link ID is in this array will be excluded (along with its children).

Return value

array: An array of (menu link ID, title) pairs for use as options for selecting a book page.

1 call to book_toc()

_book_parent_select in core/modules/book/book.module: Builds the parent selection form element for the node form or outline tab.

File

core/modules/book/book.module, line 1137: Allows users to create and organize related content in an outline.

Code

function book_toc($bid, $depth_limit, $exclude = array()) {
  $tree = menu_tree_all_data(book_menu_name($bid));
  $toc = array();
  _book_toc_recurse($tree, '', $toc, $exclude, $depth_limit);

  return $toc;
}