Enabling Error Reporting - Revision history

AlexN: /* PHP Warnings and Notices */

2023-07-12T11:39:10Z

‎PHP Warnings and Notices

AlexN: /* PHP Warnings and Notices */

2023-07-12T11:38:20Z

‎PHP Warnings and Notices

SarahK: /* Typical Causes */

2022-08-18T17:09:12Z

‎Typical Causes

SarahK: /* Getting Error Information */

2022-07-06T17:57:49Z

‎Getting Error Information

SarahK at 18:22, 22 April 2022

2022-04-22T18:22:03Z

SarahK: /* Enabling Error Reporting */

2022-04-19T16:11:38Z

‎Enabling Error Reporting

SarahK at 16:04, 5 August 2020

2020-08-05T16:04:25Z

SarahK at 13:53, 29 April 2020

2020-04-29T13:53:12Z

Lawrence: /* PHP Warnings/Notices */

2018-01-18T20:35:28Z

‎PHP Warnings/Notices

Lawrence: /* PHP Warnings/Notices */

2018-01-18T20:34:54Z

‎PHP Warnings/Notices

← Older revision		Revision as of 11:39, 12 July 2023
Line 94:		Line 94:
	<source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>		<source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>

−	~~When~~ correctly ~~set~~, the <tt>error_reporting</tt> variable within the server's PHP configuration will show a numerical value of <tt>4597</tt>.	+	If you have set it correctly, the <tt>error_reporting</tt> variable within the server's PHP configuration will show a numerical value of <tt>4597</tt>.

← Older revision		Revision as of 11:38, 12 July 2023
Line 93:		Line 93:
	# Change the value to the following string:		# Change the value to the following string:
	<source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>		<source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>
		+
		+	When correctly set, the <tt>error_reporting</tt> variable within the server's PHP configuration will show a numerical value of <tt>4597</tt>.

@@ Line 21: / Line 21: @@
 * Missing or corrupted files or incomplete uploads.
 * The server doesn't meet the [[System Requirements|minimum system requirements]].
-* PHP, Apache or ionCube Loader®-related errors.
+* PHP, Apache, or ionCube Loader®-related errors.
 * Incompatible hooks or addons.
 * Syntax errors in custom modules, hooks, or templates.

@@ Line 1: / Line 1: @@
 ==Getting Error Information==
-The WHMCS [[Error_Management]] system includes many useful options. '''Display Errors''' allows you to view additional information about critical errors.
+The WHMCS [[Error Management]] system includes many useful options. '''Display Errors''' allows you to view additional information about critical errors.
 ===When Should You Enable Display Errors===

@@ Line 1: / Line 1: @@
 ==Getting Error Information==
-The WHMCS [[Error_Management]] system includes many useful options.  The Display Errors option allows you to view additional information about critical errors.
+The WHMCS [[Error_Management]] system includes many useful options. '''Display Errors''' allows you to view additional information about critical errors.
 ===When Should You Enable Display Errors===
-The Display Errors option provides additional information when you experience a critical error that results in one of the following issues:
+'''Display Errors''' provides additional information when you experience a critical error that results in one of the following issues:
 * Friendly "Oops!" pages
@@ Line 11: / Line 11: @@
 * Partially rendered pages
-In most cases, use the Log Errors and SQL Debug Mode options first. These options will usually capture the same information that the Display Errors option renders. In the event that these options are not viable or do not yield any information, Display Errors is a good alternative.
+In most cases, use the '''Log Errors''' and '''SQL Debug Mode''' options first. These options will usually capture the same information that '''Display Errors''' renders. 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 helpful. However, it will show your error information to anyone who is encountering the same error condition. Avoid showing errors to visitors or non-privileged staff whenever possible.''
+'''Display Errors''' will show your error information to anyone who is encountering the same error condition. Avoid showing errors to visitors or non-privileged staff whenever possible.''
 ===Typical Causes===
@@ Line 51: / Line 51: @@
 After adding the lines and saving and uploading the file, retry the steps that previously led to the blank or partially rendered page. The system will display additional error information.
-''Remember to disable Display Errors when you are finished troubleshooting. Leaving error display enabled can be a security concern.''
+''Remember to disable '''Display Errors''' when you are finished troubleshooting. Leaving error display enabled can be a security concern.''
 ==Disabling Error Reporting==
@@ Line 59: / Line 59: @@
 If you enabled error reporting via the admin area, make sure to follow the steps below after you finish troubleshooting:
-# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Other''' or, prior to WHMCS 8.0, '''Setup > General Settings > Other'''.
+# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
-# Deselect the Display Errors checkbox at the bottom of the page.
+# Choose the '''[[Other Tab|Other]]''' tab.
-# Click Save Changes.
+# Deselect '''Display Errors''' at the bottom of the page.
 ===Disabling from the configuration.php file===
@@ Line 87: / Line 88: @@
 # In WHM, navigate to '''Software >> MultiPHP INI Editor'''.
-# Click the Editor Mode tab.
+# Click the '''Editor Mode''' tab.
 # Select your PHP version from the '''Select a PHP version''' menu.
 # Scroll down to the <tt>error_reporting</tt> setting.
 # Change the value to the following string:
 <source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>

@@ Line 29: / Line 29: @@
 ===Enabling From The Admin Area===
-If the admin area still allows you to navigate to '''General Settings''', follow the steps below to enable error display. Then, retry the steps that previously led to the blank or partially rendered page. The system will display additional error information.
+If possible, attempt the following steps to enable '''Display Errors''' via the [[Admin Area]]:
-# Navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Other''' or, prior to WHMCS 8.0, '''Setup > General Settings > Other'''.
+# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[General Settings]]''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
-# Select the '''Display Errors''' checkbox at the bottom of the page.
+# Choose the '''[[Other Tab|Other]]''' tab.
 # Click '''Save Changes'''.
 ''Remember to disable Display Errors when you are finished troubleshooting. Leaving error display enabled can be a security concern.''

@@ Line 1: / Line 1: @@
 ==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.
+In most cases, use the Log Errors and SQL Debug Mode options first. These options will usually capture the same information that the Display Errors option renders. 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.''
+''The Display Errors option is very helpful. However, it will show your error information to anyone who is encountering the same error condition. Avoid showing errors to visitors or non-privileged staff whenever possible.''
 ===Typical Causes===
 Some of the most common causes of "Oops!", partial, or empty page rendering include:
-* Missing or corrupted files / incomplete uploads
+* Missing or corrupted files or incomplete uploads.
-* Server not meeting [[System Requirements|minimum system requirements]]
+* The server doesn't meet the [[System Requirements|minimum system requirements]].
-* PHP, Apache or Ioncube related errors
+* PHP, Apache or ionCube Loader®-related errors.
-* Incompatible hooks or addons
+* Incompatible hooks or addons.
-* Syntax errors in custom modules, hooks or templates
+* Syntax errors in custom modules, hooks, or templates.
 ==Enabling Error Reporting==
 ===Enabling From The Admin Area===
-# Navigate to '''Setup > General Settings > Other'''
+If the admin area still allows you to navigate to '''General Settings''', follow the steps below to enable error display. Then, retry the steps that previously led to the blank or partially rendered page. The system will display additional error information.
-# Tick the '''Display Errors''' checkbox located towards the bottom of the page
-# Click Save Changes
+# Navigate to '''Setup > General Settings > Other'''.
-''Remember to return here and uncheck Display Errors when you are finished troubleshooting.  Leaving error display enabled can be a security concern.''
+''Remember to disable Display Errors when you are finished troubleshooting. Leaving error display enabled can be a security concern.''
 ===Enabling From Your Configuration File===
-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.
+If the error is severe enough, you may not be able to log in to the admin area. In those situations, there is a manual configuration file flag option that you can add to the <tt>configuration.php</tt> file in the WHMCS root directory to enable error reporting.
 <source lang="php">
@@ Line 39: / Line 47: @@
 </source>
-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.
+After adding the lines and saving and uploading the file, retry the steps that previously led to the blank or partially rendered page. The system will display additional error information.
-''Again remember to return here and remove these lines when you are finished troubleshooting.  Leaving error display enabled can be a security concern.''
+''Remember to disable Display Errors when you are finished troubleshooting. Leaving error display enabled can be a security concern.''
 ==Disabling Error Reporting==
 ===Disabling from the admin area===
-# Navigate to Setup > General Settings > Other
+If you enabled error reporting via the admin area, make sure to follow the steps below after you finish troubleshooting:
-# Untick the Display Errors checkbox located towards the bottom of the page
-# Click Save Changes
+# Navigate to Setup > General Settings > Other.
 ===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">
@@ Line 57: / Line 69: @@
 </source>
-Occasionally we see the following lines in configuration.php files as well:
+Sometimes, you may also see the following lines in <tt>configuration.php</tt> file:
 <source lang="php">
@@ Line 63: / Line 75: @@
 $display_errors = E_ALL;
 </source>
-==PHP Warnings/Notices==
+As a precaution, remove any lines starting with <tt>$display_errors</tt> from the <tt>configuration.php</tt> file.
-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:
+If you have sufficient access and have configured your server to use WHM for administration, follow these steps:
-# In WHM navigate to Software >> MultiPHP INI Editor:
+# In WHM, navigate to Software >> MultiPHP INI Editor.
-# Click the Editor Mode tab
+# Click the Editor Mode tab.
-# Select your PHP version from the Select a PHP version dropdown.
+# Select your PHP version from the Select a PHP version menu.
-# Scroll down to the error_reporting setting
+# Scroll down to the <tt>error_reporting</tt> setting.
-# Change the value to the following
+# Change the value to the following string:
 <source lang="sql">E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED</source>

@@ Line 74: / Line 74: @@
 # Select your PHP version from the Select a PHP version dropdown.
 # Scroll down to the error_reporting setting
-# Change the value to: E_ALL & ~E_WARNING & ~E_USER_WARNING & ~E_NOTICE & ~E_USER_NOTICE & ~E_STRICT & ~E_DEPRECATED & ~E_USER_DEPRECATED
+# Change the value to: