Book Access Code module - Administration page where access codes for books are defined.
Book Access Code module - Anonymous users are prompted to provide an access code to view the book.

The Book Access Code module adds the ability to use access codes to grant read access to Books. This adds functionality to Drupal core's book module.

Features / Design Decisions

  • Multiple access codes can be assisted to each book, and/or one access code can grant access to multiple books.
  • Once an access code is provided it is saved in that user's session. This prevents the user from having to repetitively provide the access code when navigating between pages/chapters of a book, or when moving between books that share the same access code.
  • Access codes can be used with anonymous and authenticated users.
  • This module adds access restrictions on top of drupal's existing access system, meaning that the roles that the visitors must already be granted access to view published book page content, and if the book has an active access code, the user must also provide one of the active access codes for that book.
  • This access code module only restricts access to view the book node pages and does not restrict any other view mode. This allows users to browse/search books and view teaser view modes, but when they go to read the book they will be prompted for an access code.

Installation

composer require 'drupal/book_access_code:^2.0'

Configuration

You can edit the access denied, access code required message by navigating to /admin/config/system/book_access_code/settings.

You can add and manage book access codes at /admin/structure/book/access_code

There is a permission that can be added to any role to allow them to bypass the book access code. This can be helpful for content editor roles.

Supporting organizations: 
Supported Initial Development

Project information

Releases