book_toc

• Drupal 4.6
• Drupal 4.7
• Drupal 5
• Drupal 6
• Drupal 7

Versions

4.6 – 5

book_toc($exclude = 0)

6

book_toc($bid, $exclude = array(), $depth_limit)

7

book_toc($bid, $depth_limit, $exclude = array())

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

Parameters

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

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

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

Return value

An array of mlid, title pairs for use as options for selecting a book page.

Code

modules/book/book.module, line 1035

<?php
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;
}
?>

Login or register to post comments