function BookManager::loadBookLink

Same name and namespace in other branches
  1. 8.9.x core/modules/book/src/BookManager.php \Drupal\book\BookManager::loadBookLink()
  2. 10 core/modules/book/src/ProxyClass/BookManager.php \Drupal\book\ProxyClass\BookManager::loadBookLink()
  3. 10 core/modules/book/src/BookManager.php \Drupal\book\BookManager::loadBookLink()
  4. 11.x core/modules/book/src/ProxyClass/BookManager.php \Drupal\book\ProxyClass\BookManager::loadBookLink()
  5. 11.x core/modules/book/src/BookManager.php \Drupal\book\BookManager::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.

Overrides BookManagerInterface::loadBookLink

3 calls to BookManager::loadBookLink()
BookManager::deleteFromBook in core/modules/book/src/BookManager.php
Deletes node's entry from book table.
BookManager::saveBookLink in core/modules/book/src/BookManager.php
Saves a link for a single book entry to the book.
BookManager::updateOutline in core/modules/book/src/BookManager.php
Handles additions and updates to the book outline.

File

core/modules/book/src/BookManager.php, line 822

Class

BookManager
Defines a book manager.

Namespace

Drupal\book

Code

public function loadBookLink($nid, $translate = TRUE) {
    $links = $this->loadBookLinks([
        $nid,
    ], $translate);
    return $links[$nid] ?? FALSE;
}

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