public function BookManagerInterface::getTableOfContents in Drupal 10
Same name and namespace in other branches
- 8 core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::getTableOfContents()
- 9 core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::getTableOfContents()
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) An array of menu link ID values. Any link whose menu link ID is in this array will be excluded (along with its children). Defaults to an empty array.
Return value
array An array of (menu link ID, title) pairs for use as options for selecting a book page.
File
- core/
modules/ book/ src/ BookManagerInterface.php, line 110
Class
- BookManagerInterface
- Provides an interface defining a book manager.
Namespace
Drupal\bookCode
public function getTableOfContents($bid, $depth_limit, array $exclude = []);