You are here

Home » API reference » Customerror 5

README.txt in Customerror 5

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
  3. 7 README.txt
Copyright 2005 http://2bits.com

Description
-----------
This module allows the site admin to create custom error pages for
404 (not found), and 403 (access denied).

Since the error pages are not real nodes, they do not belong a category
term, and hence will not show up in node listings.

It also allows the site admin to setup redirects for 404s. For example
if you had a page called foo and a page called xyz, then you moved them
to a page called bar, and abc respectively, you can setup a redirect pair
of:

  ^foo$ bar
  ^xyz$ abc

Users trying to access example.com/foo will be transparently redirected
to example.com/bar.

Features
--------
* Configurable page title and descriptions.
* Any HTML formatted text can be be put in the page body.
* Handles 404 and 403 errors at present. Drupal only allows those two
  errors to be assigned custom pages. The design of this module is 
  flexible though and can accommodate future codes easily.
* The pages are themeable using the phptemplate_customerror() function
  in the template.php. The first argument is the error code (currently
  403 or 404), and the message content.
* The messages can contain PHP, using one of two methods:
  - By using the phptemplate_customerror() function (see above).
  - By using the PHP checkbox in the settings.
* Users who are not logged in and try to access an area that requires
  login will be redirected to the page they were trying to access after
  they login.
  (Requires a minor change to common.inc, see INSTALL.txt for details).

Redirecting upon login
----------------------
Here is an example of how to add custom PHP to a 403 to give the user the
option to login then redirect them to what they were after.

<?php
global $user;
if ($user->uid == 0) {
  print '<p>If your user account has access to this page, please <a href="/user?' .
    drupal_get_destination() . '">log</a>.</p>';
}
?>

That way when there's a 403 they get redirected back to the page they were trying to access.
The above should be better refined to fit "best practices", such as doing this in a template.php
rather than code stored in the database, and probably call l() or url() so it works when clean
URL's are disabled.

Thanks to: Andrew Berry (http://drupal.org/user/71291 deviantintegral).

Database
--------
This module does not require any new database tables to be installed.

Installation:
-------------
Please see the INSTALL.txt document for details.

1. Copy the customerror.module to the Drupal modules/ directory.

2. Go to Administer -> Build -> Modules
   - Enable the customerror module, click on Save

3. Configure the module:
   - Go to Administer -> Site configuration -> Custom error
   - Enter any title and description you want for the 404 (not found)
     and 403 (access denied) pages.
   - You can use any HTML tags to format the text.
   - Ensure the Enable checkbox is checked. That sets or unsets the Error
     Reporting settings for you.

4. Configure Error reporting
   - Go to Administer -> Site configuration -> Error reporting
   - For 403 (access denied), enter the value:
       customerror/403
   - For 40 (not found), enter the value:
       customerror/404

5. Test your error pages.
   - Copy your present admin page url.
   - Try to go to a non-existent Drupal page on your site.
   You should see your custom error page for 404 (not found) page.

   - Log out from your site.
   - Paste the admin page url and try to go there.
   You should see your custom error page for 403 (access denied) page.

Bugs/Features/Patches
---------------------
If you want to report bugs, feature requests, or submit a patch, please do so
at the project page on the Drupal web site.
http://drupal.org/project/customerror

Author
------

Khalid Baheyeldin (http://baheyeldin.com/khalid and http://2bits.com)

If you use this module, find it useful, and want to send the author
a thank you note, then use the Feedback/Contact page at the URL above.

The author can also be contacted for paid customizations of this
and other modules.

File

README.txt
View source 
  1. 

  2. Copyright 2005 http://2bits.com

  3. 

  4. Description

  5. -----------

  6. This module allows the site admin to create custom error pages for

  7. 404 (not found), and 403 (access denied).

  8. 

  9. Since the error pages are not real nodes, they do not belong a category

  10. term, and hence will not show up in node listings.

  11. 

  12. It also allows the site admin to setup redirects for 404s. For example

  13. if you had a page called foo and a page called xyz, then you moved them

  14. to a page called bar, and abc respectively, you can setup a redirect pair

  15. of:

  16. 

  17.   ^foo$ bar

  18.   ^xyz$ abc

  19. 

  20. Users trying to access example.com/foo will be transparently redirected

  21. to example.com/bar.

  22. 

  23. Features

  24. --------

  25. * Configurable page title and descriptions.

  26. * Any HTML formatted text can be be put in the page body.

  27. * Handles 404 and 403 errors at present. Drupal only allows those two

  28.   errors to be assigned custom pages. The design of this module is 

  29.   flexible though and can accommodate future codes easily.

  30. * The pages are themeable using the phptemplate_customerror() function

  31.   in the template.php. The first argument is the error code (currently

  32.   403 or 404), and the message content.

  33. * The messages can contain PHP, using one of two methods:

  34.   - By using the phptemplate_customerror() function (see above).

  35.   - By using the PHP checkbox in the settings.

  36. * Users who are not logged in and try to access an area that requires

  37.   login will be redirected to the page they were trying to access after

  38.   they login.

  39.   (Requires a minor change to common.inc, see INSTALL.txt for details).

  40. 

  41. Redirecting upon login

  42. ----------------------

  43. Here is an example of how to add custom PHP to a 403 to give the user the

  44. option to login then redirect them to what they were after.

  45. 

  47. global $user;

  48. if ($user->uid == 0) {

  49.   print '
    If your user account has access to this page, please log.
    ';

  50. }

  51. ?>

  52. 

  53. That way when there's a 403 they get redirected back to the page they were trying to access.

  54. The above should be better refined to fit "best practices", such as doing this in a template.php

  55. rather than code stored in the database, and probably call l() or url() so it works when clean

  56. URL's are disabled.

  57. 

  58. Thanks to: Andrew Berry (http://drupal.org/user/71291 deviantintegral).

  59. 

  60. Database

  61. --------

  62. This module does not require any new database tables to be installed.

  63. 

  64. Installation:

  65. -------------

  66. Please see the INSTALL.txt document for details.

  67. 

  68. 1. Copy the customerror.module to the Drupal modules/ directory.

  69. 

  70. 2. Go to Administer -> Build -> Modules

  71.    - Enable the customerror module, click on Save

  72. 

  73. 3. Configure the module:

  74.    - Go to Administer -> Site configuration -> Custom error

  75.    - Enter any title and description you want for the 404 (not found)

  76.      and 403 (access denied) pages.

  77.    - You can use any HTML tags to format the text.

  78.    - Ensure the Enable checkbox is checked. That sets or unsets the Error

  79.      Reporting settings for you.

  80. 

  81. 4. Configure Error reporting

  82.    - Go to Administer -> Site configuration -> Error reporting

  83.    - For 403 (access denied), enter the value:

  84.        customerror/403

  85.    - For 40 (not found), enter the value:

  86.        customerror/404

  87. 

  88. 5. Test your error pages.

  89.    - Copy your present admin page url.

  90.    - Try to go to a non-existent Drupal page on your site.

  91.    You should see your custom error page for 404 (not found) page.

  92. 

  93.    - Log out from your site.

  94.    - Paste the admin page url and try to go there.

  95.    You should see your custom error page for 403 (access denied) page.

  96. 

  97. Bugs/Features/Patches

  98. ---------------------

  99. If you want to report bugs, feature requests, or submit a patch, please do so

  100. at the project page on the Drupal web site.

  101. http://drupal.org/project/customerror

  102. 

  103. Author

  104. ------

  105. 

  106. Khalid Baheyeldin (http://baheyeldin.com/khalid and http://2bits.com)

  107. 

  108. If you use this module, find it useful, and want to send the author

  109. a thank you note, then use the Feedback/Contact page at the URL above.

  110. 

  111. The author can also be contacted for paid customizations of this

  112. and other modules.