You are here

README.txt in Disable Messages 2.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
INTRODUCTION
============

Gives a site owner options to disable specific messages shown to end users.
The core drupal message system as offered by drupal_set_message
is an excellent way for modules to send out messages to the end users.
However not all drupal site owners are keen to show all the messages
sent out by drupal core and all modules to their users. This module
gives site administrators a reasonably powerful way to filter out
messages shown to the end users.


FEATURES
--------

1. Filter out messages that match a full text string exactly.
2. Filter out messages that match a regular expression.
3. Permissions to specifically hide all messages of a given type from
   any role.
4. Disable all filtering for specific users.
5. Disable all filtering for specific paths.
6. Apply filtering only for specific paths.
7. Debug system to get messages in the HTML without showing it to the end users.


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

1. Extract the tar.gz into your 'modules' or directory.
2. Enable the module at 'administer >> modules'.
   Note: The installation process will grant view permissions
   for all three types of messages (warning, status, and error)
   when it is first installed.  If you wish to hide certain types
   of messages by user role, you can do so by removing these
   permissions.
3. Configure options in Administration >> Configuration >>
   Development >> Disable Messages.
4. Configure permissions in Administration >> People >> Permissions.


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

The module has releases for Drupal 7, 8 and 9.


CONFIGURATION
-------------
1. Visit the configuration page at:
   'Administration >> Configuration >> Development >> Disable Messages'

2. Add the specific messages you wish to filter out to the 'Messages
   to be disabled' text area.  These messages should be in the form
   of Regular Expressions, with one entered per line.  You do not
   have to include the opening and closing forward slashes for each
   regular expression. The system will automatically add /^ and $/
   at the beginning and end of the pattern to ensure that the match is
   always a full match instead of a partial match. This will help
   prevent unexpected filtering of messages. So if you want to filter
   out a specific message ensure that you add the full message including
   any punctuation and additional HTML if any.

   If you are familiar with wildcard searches using *, and not Regular
   Expressions, you can achieve the exact same thing by using .* as your
   wildcard character.  For example, you could wildcard filter out
   any Article creation messages using the following Regular Expression:
     Article .* has been created.

3. Next configure 'Page and User Level Filtering Options'.  By default,
   filtering is enabled for all users on all pages.  Here you can
   specify the pages where filtering should be applied or excluded by
   setting the 'Apply filters by page' radio and textarea and entering
   page paths, one per line.  These standard visibility controls work
   just like the core Block system's.

   You may also turn filtering off for certain Drupal User ID's (uid).
   This can be useful to turn off filtering for the Admin user uid of 1.
   You can also turn off filtering for Anonymous users, whose uid is 0.

4. If you are setting up the module for the first time, you should
   enable one or both of the checkboxes under 'Debug options'.  These
   will output information about which messages are being excluded,
   and why.  If you are on a development site, check both boxes and
   the debugging output will be printed at the bottom of each page.

5. Hit 'Save Configuration' to save the settings.

6. Visit 'Administration >> People >> Permissions' to set permissions.
   When the module is first enabled it will granted permissions
   to view all message types to each site role.
   Assign the 'view <type> message' to roles who should be able to see
   the given <type> of messages. Users who do not have the permissions
   to see a given type of messages will not be able to see any of the
   messages of the given type. Useful to hide warning and error
   messages from end users on a production site.


CREDITS
-------
Written by Zyxware, http://www.zyxware.com/

File

README.txt
View source
  1. INTRODUCTION
  2. ============
  3. Gives a site owner options to disable specific messages shown to end users.
  4. The core drupal message system as offered by drupal_set_message
  5. is an excellent way for modules to send out messages to the end users.
  6. However not all drupal site owners are keen to show all the messages
  7. sent out by drupal core and all modules to their users. This module
  8. gives site administrators a reasonably powerful way to filter out
  9. messages shown to the end users.
  10. FEATURES
  11. --------
  12. 1. Filter out messages that match a full text string exactly.
  13. 2. Filter out messages that match a regular expression.
  14. 3. Permissions to specifically hide all messages of a given type from
  15. any role.
  16. 4. Disable all filtering for specific users.
  17. 5. Disable all filtering for specific paths.
  18. 6. Apply filtering only for specific paths.
  19. 7. Debug system to get messages in the HTML without showing it to the end users.
  20. INSTALLATION
  21. ------------
  22. 1. Extract the tar.gz into your 'modules' or directory.
  23. 2. Enable the module at 'administer >> modules'.
  24. Note: The installation process will grant view permissions
  25. for all three types of messages (warning, status, and error)
  26. when it is first installed. If you wish to hide certain types
  27. of messages by user role, you can do so by removing these
  28. permissions.
  29. 3. Configure options in Administration >> Configuration >>
  30. Development >> Disable Messages.
  31. 4. Configure permissions in Administration >> People >> Permissions.
  32. REQUIREMENTS
  33. ------------
  34. The module has releases for Drupal 7, 8 and 9.
  35. CONFIGURATION
  36. -------------
  37. 1. Visit the configuration page at:
  38. 'Administration >> Configuration >> Development >> Disable Messages'
  39. 2. Add the specific messages you wish to filter out to the 'Messages
  40. to be disabled' text area. These messages should be in the form
  41. of Regular Expressions, with one entered per line. You do not
  42. have to include the opening and closing forward slashes for each
  43. regular expression. The system will automatically add /^ and $/
  44. at the beginning and end of the pattern to ensure that the match is
  45. always a full match instead of a partial match. This will help
  46. prevent unexpected filtering of messages. So if you want to filter
  47. out a specific message ensure that you add the full message including
  48. any punctuation and additional HTML if any.
  49. If you are familiar with wildcard searches using *, and not Regular
  50. Expressions, you can achieve the exact same thing by using .* as your
  51. wildcard character. For example, you could wildcard filter out
  52. any Article creation messages using the following Regular Expression:
  53. Article .* has been created.
  54. 3. Next configure 'Page and User Level Filtering Options'. By default,
  55. filtering is enabled for all users on all pages. Here you can
  56. specify the pages where filtering should be applied or excluded by
  57. setting the 'Apply filters by page' radio and textarea and entering
  58. page paths, one per line. These standard visibility controls work
  59. just like the core Block system's.
  60. You may also turn filtering off for certain Drupal User ID's (uid).
  61. This can be useful to turn off filtering for the Admin user uid of 1.
  62. You can also turn off filtering for Anonymous users, whose uid is 0.
  63. 4. If you are setting up the module for the first time, you should
  64. enable one or both of the checkboxes under 'Debug options'. These
  65. will output information about which messages are being excluded,
  66. and why. If you are on a development site, check both boxes and
  67. the debugging output will be printed at the bottom of each page.
  68. 5. Hit 'Save Configuration' to save the settings.
  69. 6. Visit 'Administration >> People >> Permissions' to set permissions.
  70. When the module is first enabled it will granted permissions
  71. to view all message types to each site role.
  72. Assign the 'view message' to roles who should be able to see
  73. the given of messages. Users who do not have the permissions
  74. to see a given type of messages will not be able to see any of the
  75. messages of the given type. Useful to hide warning and error
  76. messages from end users on a production site.
  77. CREDITS
  78. -------
  79. Written by Zyxware, http://www.zyxware.com/