Skip to main content
drupalreleases

Use direct release data with your AI assistant.

Learn more

Book Access Code

Security covered Under active development 13 sites

Part of the Book ecosystem · 16 projects

This module allows you to restrict read access to Drupal Books using custom access codes. Codes can be assigned to individual books or grant access to multiple books, and they are saved in a user's session to avoid repetitive entry. Access is restricted for both anonymous and authenticated users, requiring them to provide a valid code in addition to existing permissions.

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.

Drupal 9–10 · not 11

Ask your assistant about Book Access Code

Check compatibility with your Drupal and PHP version, maintenance and security coverage, from current release data. How it works

Depends on

Dependencies of the latest stable release

  • book Drupal core
  • node Drupal core

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

Tracked releases
1
Tracked since
Dec 2023
Latest release
2 years ago
Releases (12 mo)
0
Maintenance
Dormant

Releases

Version Type Core PHP Release date
2.0.1 Stable 9–10 Dec 1, 2023