This repository is archived. Issues and patches should be submitted back on the drupal.org issue queue.
The Agreement module allows the administrator to present a text-based agreement (think "Terms of Service") that users of a particular role must accept before they are allowed to access the site. The agreement is presented to users right after login, and must be accepted before the user can navigate to another page. Users will still be able to access the homepage (<front>) and /logout without accepting the agreement; all other pages will redirect the user to the agreement acceptance form.
The following options are configurable from the module's settings page:
- User role to which the agreement is restricted
- The agreement page title
- The agreement text
- The agreement page URL
- The success & failure messages presented to the user
- The checkbox & submit button texts
Additionally, theme developers can also override theme_agreement_page(), which is the theme function responsible for agreement page presentation.
There are modules (Terms of Use and Legal) which provide similar functionality during registration. The Agreement module provides the functionality to show an agreement to an existing user base, without requiring the users to re-register.
It is important to set visibility pages correctly when displaying agreement all pages in order to support one-time login URLs.
The following is the recommended setting content for visibility pages:
<front>
user/*/edit
user/*
user