You are here

Home » API reference » Menu Item Role Access 8.2

README.txt in Menu Item Role Access 8.2

Same filename and directory in other branches
  1. 8 README.txt
Menu Item Role Access

INTRODUCTION
------------

Provides a the ability to restrict access to menu items by the users role

REQUIREMENTS
------------

This module requires the following modules to be installed:

 * menu_link_content
 * menu_ui

INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. See:
   https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules
   for further information.

CONFIGURATION
-------------

 * Go to the menu item you wish to restrict within the admin UI and select the 
   roles which should have access to the menu item.
 * Configuration options for the way menu_item_role_access behaves can be found
   at admin/config/menu-item-role-access

TROUBLESHOOTING
---------------

Trouble:
 * User see menu item, but his role not allowed for this menu item.
 * User don't see menu item, but his role allowed for this menu item.
Fix:
 By default, Drupal permissions are used (/admin/people/permissions).
 This means that menu item will be displayed for role that have view permissions, even if you set a limit for this menu item in "Menu Item Role".
 Also, the menu item will not be shown if the role does not have a Drupal permissions to view menu item.
 To fix this:
 - Navigate to admin/config/menu-item-role-access and press "Overwrite internal link target access check".
 - Clear the cache.
 - Enjoy.

MAINTAINERS
-----------

Current maintainers:
 * Liam Hiscock (LiamPower) - https://www.drupal.org/u/liampower

File

README.txt
View source 
  1. Menu Item Role Access

  2. 

  3. INTRODUCTION

  4. ------------

  5. 

  6. Provides a the ability to restrict access to menu items by the users role

  7. 

  8. REQUIREMENTS

  9. ------------

  10. 

  11. This module requires the following modules to be installed:

  12. 

  13.  * menu_link_content

  14.  * menu_ui

  15. 

  16. INSTALLATION

  17. ------------

  18. 

  19.  * Install as you would normally install a contributed Drupal module. See:

  20.    https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules

  21.    for further information.

  22. 

  23. CONFIGURATION

  24. -------------

  25. 

  26.  * Go to the menu item you wish to restrict within the admin UI and select the 

  27.    roles which should have access to the menu item.

  28.  * Configuration options for the way menu_item_role_access behaves can be found

  29.    at admin/config/menu-item-role-access

  30. 

  31. TROUBLESHOOTING

  32. ---------------

  33. 

  34. Trouble:

  35.  * User see menu item, but his role not allowed for this menu item.

  36.  * User don't see menu item, but his role allowed for this menu item.

  37. Fix:

  38.  By default, Drupal permissions are used (/admin/people/permissions).

  39.  This means that menu item will be displayed for role that have view permissions, even if you set a limit for this menu item in "Menu Item Role".

  40.  Also, the menu item will not be shown if the role does not have a Drupal permissions to view menu item.

  41.  To fix this:

  42.  - Navigate to admin/config/menu-item-role-access and press "Overwrite internal link target access check".

  43.  - Clear the cache.

  44.  - Enjoy.

  45. 

  46. MAINTAINERS

  47. -----------

  48. 

  49. Current maintainers:

  50.  * Liam Hiscock (LiamPower) - https://www.drupal.org/u/liampower