Difference between revisions of "Enabling Error Reporting"

From WHMCS Documentation

m (Getting Error Information)
m (PHP Warnings/Notices)
 
(9 intermediate revisions by the same user not shown)
Line 42: Line 42:
  
 
''Again remember to return here and remove these lines when you are finished troubleshooting.  Leaving error display enabled can be a security concern.''
 
''Again remember to return here and remove these lines when you are finished troubleshooting.  Leaving error display enabled can be a security concern.''
 +
 +
==Disabling Error Reporting==
 +
===Disabling from the admin area===
 +
If you enabled error reporting via the admin area, please ensure you follow the steps below once troubleshooting is completed:
 +
 +
# Navigate to Setup > General Settings > Other
 +
# Untick the Display Errors checkbox located towards the bottom of the page
 +
# Click Save Changes
 +
===Disabling from the configuration.php file===
 +
If you enabled error reporting via the configuration.php file, please ensure you remove the following line from the configuration.php file once troubleshooting is completed:
 +
 +
<source lang="php">
 +
$display_errors = true;
 +
</source>
 +
 +
Occasionally we see the following lines in configuration.php files as well:
 +
 +
<source lang="php">
 +
$display_errors = E_NOTICE;
 +
$display_errors = E_ALL;
 +
</source>
 +
As a precaution, it is best to remove any lines starting with $display_errors from the configuration.php file.
 +
 +
==PHP Warnings/Notices==
 +
If the Display Error options are switched off and you're still seeing warning messages, it indicates the Error Reporting level in your server's PHP Configuration is too high. This is a PHP configuration level issue and therefore for shared or reseller users, may require the assistance of your web hosting provider.
 +
 +
If you have sufficient access and your server is configured to use WHM for administration, follow these steps:
 +
 +
# In WHM navigate to Software >> MultiPHP INI Editor:
 +
# Click the Editor Mode tab
 +
# Select your PHP version from the Select a PHP version dropdown.
 +
# Scroll down to the error_reporting setting
 +
# Change the value to the following
 +
<source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>

Latest revision as of 20:35, 18 January 2018

Getting Error Information

The Error_Management documentation provides a full description of the WHMCS Error Management system and all possible options at your ready. The following sections provide an abridged description of the Display Errors option and overview on how you should consider utilizing it.

When Should You Enable Display Errors

Display Errors option will often provide additional information when you are experiencing a critical error that is resulting in on of the following:

  • Friendly "Oops!" pages
  • Entirely blank pages
  • Partially rendered pages

In most cases, you will want to use the Log Errors and SQL Debug Mode first, if possible. These options usually will capture the same information that is rendered by the Display Errors option. In the event that these options are not viable or do not yield any information, Display Errors is a good alternative.

The Display Errors option is very handy however it will show your error information to anyone who is encountering the same error condition. Showing errors to visitors or non-privileged staff should be avoided when possible.

Typical Causes

Some of the most common causes of "Oops!", partial, or empty page rendering include:

  • Missing or corrupted files / incomplete uploads
  • Server not meeting minimum system requirements
  • PHP, Apache or Ioncube related errors
  • Incompatible hooks or addons
  • Syntax errors in custom modules, hooks or templates

Enabling Error Reporting

Enabling From The Admin Area

If the admin area is functioning enough to allow you to navigate to General Settings follow these steps to enable error display. Then retry the steps that previously led to the blank or partially rendered page and further error information should be displayed.

  1. Navigate to Setup > General Settings > Other
  2. Tick the Display Errors checkbox located towards the bottom of the page
  3. Click Save Changes

Remember to return here and uncheck Display Errors when you are finished troubleshooting. Leaving error display enabled can be a security concern.

Enabling From Your Configuration File

If the error is severe enough, you may find you are unable to login to the admin area. In those situations, there is a manual configuration file flag option that you can add to the configuration.php file in the WHMCS root directory to enable error reporting.

The lines needs to be added at the very end of the configuration.php file, right before the closing PHP tag (?>) if your configuration.php file has one, otherwise just the last line in the file.

$display_errors = true;

After adding the lines and saving/uploading the file, retry the steps that previously led to the "Oops!", blank, or partially rendered page and further error information should be displayed.

Again remember to return here and remove these lines when you are finished troubleshooting. Leaving error display enabled can be a security concern.

Disabling Error Reporting

Disabling from the admin area

If you enabled error reporting via the admin area, please ensure you follow the steps below once troubleshooting is completed:

  1. Navigate to Setup > General Settings > Other
  2. Untick the Display Errors checkbox located towards the bottom of the page
  3. Click Save Changes

Disabling from the configuration.php file

If you enabled error reporting via the configuration.php file, please ensure you remove the following line from the configuration.php file once troubleshooting is completed:

$display_errors = true;

Occasionally we see the following lines in configuration.php files as well:

$display_errors = E_NOTICE;
$display_errors = E_ALL;

As a precaution, it is best to remove any lines starting with $display_errors from the configuration.php file.

PHP Warnings/Notices

If the Display Error options are switched off and you're still seeing warning messages, it indicates the Error Reporting level in your server's PHP Configuration is too high. This is a PHP configuration level issue and therefore for shared or reseller users, may require the assistance of your web hosting provider.

If you have sufficient access and your server is configured to use WHM for administration, follow these steps:

  1. In WHM navigate to Software >> MultiPHP INI Editor:
  2. Click the Editor Mode tab
  3. Select your PHP version from the Select a PHP version dropdown.
  4. Scroll down to the error_reporting setting
  5. Change the value to the following
E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED