You are here

Home » API reference » User restrictions 8

README.txt in User restrictions 8

Same filename and directory in other branches
  1. 7 README.txt
ABOUT

This module is a replacement for the 'access rules' functionality which was removed from Drupal 7.

The module implement an API and custom hooks that allow third-party modules to add additional restrictions, or implement new type of restrictions.

USAGE

- Go to /admin/modules and enable User Restrictions.
- Go to /admin/config/people/user-restrictions, and click Add rule.
- Select Access type, Rule type, Expire time, and fill the pattern field.
  - use Access type to specifically deny or allow the matched mask;
  - Rule type is used to tell the module to restrict/allow based on user name, user email, or another plugin.;
  - use wildcard % or . in Mask field to match the username or email address. A % will match any number of characters, a . will match precisely one character.
  - Set up the expired hours/days for the restriction or alternatively leave for unlimited restriction.
- Click Save rule button and the matched user account will be restricted.
- edit/delete the restriction rules in /admin/config/people/user-restrictions.

VERSION NOTE

- There will be no releases for Drupal 5 or Drupal 6. If you're looking for this functionality in either of those versions, try admin/user/rules. You are most likely to need this module if upgrading from Drupal 6.x or earlier with existing access rules in place. A stripped down version of IP address blocking was left in core, so this module will focus on usernames and e-mail addresses. Third-party modules can implement additional restrictions using the API exposed by the module.

- Updating from a different release of the development snapshot is not supported. To install a newer development snapshot, you always need to uninstall the previous version before copying the new one.

- Development snapshots are intended for testing only. Don't use them in a production site, or for other purposes. If used in a production site, or for other purposes, there will be no support for any resulting problems.

REQUIREMENTS

- Drupal 8

EXAMPLES

- Blocking all users with hotmail email addresses:
  - Access Type: Denied
  - Rule Type: Email
  - Mask: %@hotmail.com

- Blocking all users with names starting with the letter 'a'
  - Access Type: Denied
  - Rule Type: Name
  - Mask: a%

- Only allowing users to register from gmail.com email addresses
  - Access Type: Allowed
  - Rule Type: Email
  - Mask: %@gmail.com
  - Access Type: Denied
  - Rule Type: Email
  - Mask: %@%

- Only allowing users with a '.' in the middle of their name
  - Access Type: Allowed
  - Rule Type: Name
  - Mask: %.%
  - Access Type: Denied
  - Rule Type: Name
  - Mask: %

File

README.txt
View source 
  1. ABOUT

  2. 

  3. This module is a replacement for the 'access rules' functionality which was removed from Drupal 7.

  4. 

  5. The module implement an API and custom hooks that allow third-party modules to add additional restrictions, or implement new type of restrictions.

  6. 

  7. USAGE

  8. 

  9. - Go to /admin/modules and enable User Restrictions.

  10. - Go to /admin/config/people/user-restrictions, and click Add rule.

  11. - Select Access type, Rule type, Expire time, and fill the pattern field.

  12.   - use Access type to specifically deny or allow the matched mask;

  13.   - Rule type is used to tell the module to restrict/allow based on user name, user email, or another plugin.;

  14.   - use wildcard % or . in Mask field to match the username or email address. A % will match any number of characters, a . will match precisely one character.

  15.   - Set up the expired hours/days for the restriction or alternatively leave for unlimited restriction.

  16. - Click Save rule button and the matched user account will be restricted.

  17. - edit/delete the restriction rules in /admin/config/people/user-restrictions.

  18. 

  19. VERSION NOTE

  20. 

  21. - There will be no releases for Drupal 5 or Drupal 6. If you're looking for this functionality in either of those versions, try admin/user/rules. You are most likely to need this module if upgrading from Drupal 6.x or earlier with existing access rules in place. A stripped down version of IP address blocking was left in core, so this module will focus on usernames and e-mail addresses. Third-party modules can implement additional restrictions using the API exposed by the module.

  22. 

  23. - Updating from a different release of the development snapshot is not supported. To install a newer development snapshot, you always need to uninstall the previous version before copying the new one.

  24. 

  25. - Development snapshots are intended for testing only. Don't use them in a production site, or for other purposes. If used in a production site, or for other purposes, there will be no support for any resulting problems.

  26. 

  27. REQUIREMENTS

  28. 

  29. - Drupal 8

  30. 

  31. EXAMPLES

  32. 

  33. - Blocking all users with hotmail email addresses:

  34.   - Access Type: Denied

  35.   - Rule Type: Email

  36.   - Mask: %@hotmail.com

  37. 

  38. - Blocking all users with names starting with the letter 'a'

  39.   - Access Type: Denied

  40.   - Rule Type: Name

  41.   - Mask: a%

  42. 

  43. - Only allowing users to register from gmail.com email addresses

  44.   - Access Type: Allowed

  45.   - Rule Type: Email

  46.   - Mask: %@gmail.com

  47.   - Access Type: Denied

  48.   - Rule Type: Email

  49.   - Mask: %@%

  50. 

  51. - Only allowing users with a '.' in the middle of their name

  52.   - Access Type: Allowed

  53.   - Rule Type: Name

  54.   - Mask: %.%

  55.   - Access Type: Denied

  56.   - Rule Type: Name

  57.   - Mask: %