function BookManagerInterface::loadBookLink

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

Loads a single book entry.

The entries of a book entry is documented in \Drupal\book\BookOutlineStorageInterface::loadMultiple.

If $translate is TRUE, it also checks access ('access' key) and loads the title from the node itself.

Parameters

int $nid: The node ID of the book.

bool $translate: If TRUE, set access, title, and other elements.

Return value

array The book data of that node.

See also

\Drupal\book\BookOutlineStorageInterface::loadMultiple

1 method overrides BookManagerInterface::loadBookLink()
BookManager::loadBookLink in core/modules/book/src/BookManager.php
Loads a single book entry.

File

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

Class

BookManagerInterface
Provides an interface defining a book manager.

Namespace

Drupal\book

Code

public function loadBookLink($nid, $translate = TRUE);

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