Skip to main content
Drupal is a registered trademark of Dries Buytaert
Release: Views Bootstrap 5.5.4 — Minor update available for module views_bootstrap (5.5.4). Release: Rightup theme 1.0.3 — Minor update available for theme vartheme_bs5_rightup (1.0.3). Release: CommentOn 1.0.6 — Minor update available for module commenton (1.0.6). Release: ChatGPT Ads 1.0.3 — Minor update available for module chatgpt_ads (1.0.3). Release: Opensolr Search 5.1.3 — Minor update available for module opensolr_search (5.1.3). Release: ServiceM8 Webform Integration 1.2.1 — Minor update available for module servicem8_webform (1.2.1). Release: PostfixAdmin 1.0.0 — Initial release available for module postfix_admin (1.0.0)! Release: ip_analyser 1.0.3 — Minor update available for module ip_analyser (1.0.3). Module Revived: Swagger-PHP OpenAPI 3 documentation generator 1.0.0 — Module swagger_php updated after 10 months of inactivity (1.0.0). Security Coverage: Microsoft Azure AI — Module ai_provider_azure now has official Drupal security advisory coverage.

Entity Agree

Security covered

Part of the Entity ecosystem · 235 projects

View on drupal.org

This module allows entities (commonly nodes) to be identified as agreements that users of a site are required to accept.

Usage

  1. Add an "Agreement" field onto a entity type/bundle
  2. Create or edit an the entity that is to be an agreement, and in the agreement field enable the entity to be used as an agreement and add handlers to control the agreement behavior
  3. Users of the site which the agreement applies to will then be prompted to agree to the agreement. See below for handlers to control applies to and notifications.
  4. As the agreement entity is updated (new revisions), users will be again prompted to agree to the new version of the agreement.

Handlers

  • Applies to: Mark the agreement as applying to all users or users of a specific role.
  • Agreement form: A standard agreement form is provided and may be displayed for the agreement field when displaying the agreement entity.
  • Notification block: A block is available to notify users of agreement that have not been agreed-to.
  • User form widget: A section may be added to the user profile and registration forms that will allow users to agree on initial registration and account updating.

Notes

It's recommended to have only 1 agreement field per entity/bundle. It is possible to configure multiple agreement fields, but the behavior may be unpredictable. It is also recommended utilize a single value (cardinality 1) for the agreement fields. The default field widget and formatter will only allow this.

The agreement handlers utilize CTools plugins and developers may add custom implementations. To do so, add a plugin definition file and add a plugin class conforming to the proper interfaces--extend the existing classes. If you'd like to provide an entire new plugin type, that is possible too. Reference the existing code for more information on these.

Depends on

Dependencies of the latest stable release

No dependencies recorded for this project.

Required by

Tracked projects that depend on this one

No tracked projects depend on this one yet.

Activity

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

Releases

Version Type Core Release date
2.0.0-alpha2 Pre-release Jul 20, 2023