function BookOutlineStorageInterface::loadMultiple
Same name in other branches
- 8.9.x core/modules/book/src/BookOutlineStorageInterface.php \Drupal\book\BookOutlineStorageInterface::loadMultiple()
- 10 core/modules/book/src/BookOutlineStorageInterface.php \Drupal\book\BookOutlineStorageInterface::loadMultiple()
- 11.x core/modules/book/src/BookOutlineStorageInterface.php \Drupal\book\BookOutlineStorageInterface::loadMultiple()
Loads books.
Each book entry consists of the following keys:
- bid: The node ID of the main book.
- nid: The node ID of the book entry itself.
- pid: The parent node ID of the book.
- has_children: A boolean to indicate whether the book has children.
- weight: The weight of the book entry to order siblings.
- depth: The depth in the menu hierarchy the entry is placed into.
Parameters
array $nids: An array of node IDs.
bool $access: Whether access checking should be taken into account.
Return value
array Array of loaded book items.
1 method overrides BookOutlineStorageInterface::loadMultiple()
- BookOutlineStorage::loadMultiple in core/
modules/ book/ src/ BookOutlineStorage.php - Loads books.
File
-
core/
modules/ book/ src/ BookOutlineStorageInterface.php, line 45
Class
- BookOutlineStorageInterface
- Defines a common interface for book outline storage classes.
Namespace
Drupal\bookCode
public function loadMultiple($nids, $access = TRUE);
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.