function BookManagerInterface::bookSubtreeData

Same name in other branches
  1. 9 core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::bookSubtreeData()
  2. 8.9.x core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::bookSubtreeData()
  3. 11.x core/modules/book/src/BookManagerInterface.php \Drupal\book\BookManagerInterface::bookSubtreeData()

Gets the data representing a subtree of the book hierarchy.

The root of the subtree will be the link passed as a parameter, so the returned tree will contain this item and all its descendants in the menu tree.

Parameters

array $link: A fully loaded book link.

Return value

array A subtree of book links in an array, in the order they should be rendered.

File

core/modules/book/src/BookManagerInterface.php, line 285

Class

BookManagerInterface
Provides an interface defining a book manager.

Namespace

Drupal\book

Code

public function bookSubtreeData($link);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.