PHP 7 Migration Troubleshooting Guide - Revision history

SarahK: Redirected page to PHP Upgrade Troubleshooting Guide

2022-11-23T17:10:37Z

Redirected page to PHP Upgrade Troubleshooting Guide

SarahK at 16:15, 23 November 2022

2022-11-23T16:15:35Z

SarahK at 19:12, 27 April 2022

2022-04-27T19:12:00Z

SarahK at 20:34, 28 September 2021

2021-09-28T20:34:26Z

SarahK at 20:32, 28 September 2021

2021-09-28T20:32:56Z

SarahK: /* Enabling From The Admin Area */

2020-08-05T19:07:04Z

‎Enabling From The Admin Area

Matt at 16:18, 30 March 2018

2018-03-30T16:18:35Z

Matt: /* Resolving the Issue */

2018-03-30T16:17:49Z

‎Resolving the Issue

Matt: /* Resolving the Issue */

2018-03-29T15:22:52Z

‎Resolving the Issue

David at 14:45, 29 March 2018

2018-03-29T14:45:23Z

← Older revision		Revision as of 17:10, 23 November 2022
Line 1:		Line 1:
−	~~If,~~ [[PHP Upgrade Guide\|after changing your PHP version]], you encounter an '''Oops''' error or a blank or partially-rendered page, it is likely that there is a file in your installation that is not compatible with the new PHP version.	+	#REDIRECT [[PHP Upgrade Troubleshooting Guide]]
−
−	~~This may indicate one of these problems:~~
−
−	* Syntax Error — A file uses deprecated or removed functionality that is no longer available in the newer version of PHP.
−	* Decoding — A file is encoded with an ionCube® encoding that is not compatible with the newer version of PHP or the installed ionCube Loader® extension.
−
−	~~To confirm the exact cause of the issue, you must enable error reporting.~~
−
−	~~==Enabling Error Reporting==~~
−
−	~~===Enabling From The Admin Area===~~
−
−	~~If possible, log in to the [[Admin Area]] and perform the following steps to enable error display:~~
−
−	~~# 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 '''[[Other Tab\|Other]]''' tab.~~
−	~~# Check '''Display Errors'''.~~
−	~~# Click '''Save Changes'''.~~
−
−	~~After error reporting is enabled, retry the steps that previously led to the '''Oops!''', blank, or partially rendered page. More information will display.~~
−
−	~~===Enabling From Your Configuration File===~~
−
−	~~If you cannot log in, use these steps to enable error reporting in the configuration file directly:~~
−
−	~~# In the WHMCS root directory, open the <tt>configuration.php</tt> file for editing.~~
−	~~# Add the following line at the end of the configuration file, below any other lines but above the closing <tt>?></tt> line, if it is present:<div class="source-cli">$display_errors = true;</div>~~
−
−	~~After error reporting is enabled, retry the steps that previously led to the '''Oops!''', blank, or partially rendered page. More information will display.~~
−
−	~~==Common Errors/Resolutions==~~
−
−	~~After you enable error reporting, you will see the full error message that WHMCS generates when the problem occurs:~~
−
−	~~===Oops! Something went wrong and we couldn't process your request===~~
−
−	~~[[File:Oops_error_page.png]]~~
−
−	~~This error indicates that a fatal error is occurring. Usually, this is due to one of two causes:~~
−
−	* '''Missing PHP Extensions''' — Your version of PHP is missing some of the [[System_Environment_Guide#Extensions_2\|required extensions]] ~~for WHMCS.<div class="docs-alert-warning">If you compile PHP using EasyApache, you must include both the '''PDO''' and '''mysqlnd''' PHP extensions to allow MySQL® connections.</div>~~
−	* '''Incompatible PHP Files''' — PHP files using deprecated or unavailable functions are triggering an error page. To debug this, enable error reporting to find the file and PHP error output.
−
−	~~===The file was encoded by the ionCube Encoder for PHP x.x and cannot run...===~~
−
−	~~You may see an error message that looks like this:~~
−
−	The file /path/to/file.php was encoded by the ionCube Encoder for PHP 5.6 and cannot run under PHP 7.1 or later. Please ask the provider of the script to provide a version encoded with the ionCube Encoder for PHP 7.1.
−
−	~~This error indicates that the file encoding uses an older version of ionCube Encoder® that does not support PHP 7.1 or later. Contact the original author of the file for an updated version.~~
−
−	~~If the file is a WHMCS file, we may no longer maintain or distribute it.~~
−
−	* To identify WHMCS files, check for the WHMCS copyright notice at the beginning of the file.
−	* Typically, built-in routine updates remove these files automatically. However, permissions issues may prevent removal.
−	* Normally, the current version of WHMCS does not use these files and you can delete them.

← Older revision		Revision as of 16:15, 23 November 2022
Line 1:		Line 1:
−	If, [[PHP ~~7 Migration~~ Guide\|after changing your PHP version]], you encounter an '''Oops''' error or a blank or partially-rendered page, it is likely that there is a file in your installation that is not compatible with the new PHP version.	+	If, [[PHP Upgrade Guide\|after changing your PHP version]], you encounter an '''Oops''' error or a blank or partially-rendered page, it is likely that there is a file in your installation that is not compatible with the new PHP version.

	This may indicate one of these problems:		This may indicate one of these problems:

@@ Line 1: / Line 1: @@
-[[PHP 7 Migration Guide|&laquo; Back to the PHP 7 Migration Guide]]
+If, [[PHP 7 Migration Guide|after changing your PHP version]], you encounter an '''Oops''' error or a blank or partially-rendered page, it is likely that there is a file in your installation that is not compatible with the new PHP version.
 This may indicate one of these problems:
@@ Line 14: / Line 12: @@
 ===Enabling From The Admin Area===
-If you can log in to the Admin Area and navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''', use these steps to enable error display:
+If possible, log in to the [[Admin Area]] and perform the following steps to enable error display:
-# 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'''.
+# 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 '''Other''' tab.
+# Select the '''[[Other Tab|Other]]''' tab.
 # Check '''Display Errors'''.
 # Click '''Save Changes'''.
@@ Line 27: / Line 25: @@
 If you cannot log in, use these steps to enable error reporting in the configuration file directly:
-# In the WHMCS root directory, edit the <tt>configuration.php</tt> file.
+# In the WHMCS root directory, open the <tt>configuration.php</tt> file for editing.
-# Add these lines at the end of the configuration file, below any other lines but above the closing <tt>?></tt> line, if it is present:<div class="source-cli">$display_errors = true;</div>
+# Add the following line at the end of the configuration file, below any other lines but above the closing <tt>?></tt> line, if it is present:<div class="source-cli">$display_errors = true;</div>
 After error reporting is enabled, retry the steps that previously led to the '''Oops!''', blank, or partially rendered page. More information will display.
@@ Line 34: / Line 32: @@
 ==Common Errors/Resolutions==
-With error reporting enabled, you should see the full error message that WHMCS generates when the problem occurs.
+After you enable error reporting, you will see the full error message that WHMCS generates when the problem occurs:
 ===Oops! Something went wrong and we couldn't process your request===
@@ Line 40: / Line 38: @@
 [[File:Oops_error_page.png]]
-This indicates that a fatal error is occurring. Usually, this is due to these causes:
+This error indicates that a fatal error is occurring. Usually, this is due to one of two causes:
-* '''Missing PHP Extensions''' — You may see this error if your version of PHP is missing some of the [[System_Environment_Guide#Extensions_2|required extensions]] for WHMCS.<div class="docs-alert-warning">If you compile PHP using EasyApache, you must include both the '''PDO''' and '''mysqlnd''' PHP extensions to allow MySQL® connections.</div>
+* '''Missing PHP Extensions''' — Your version of PHP is missing some of the [[System_Environment_Guide#Extensions_2|required extensions]] for WHMCS.<div class="docs-alert-warning">If you compile PHP using EasyApache, you must include both the '''PDO''' and '''mysqlnd''' PHP extensions to allow MySQL® connections.</div>
-* '''Incompatible PHP Files''' — PHP files using deprecated or unavailable functions may trigger an error page. To debug this, enable error reporting to find the file and PHP error output.
+* '''Incompatible PHP Files''' — PHP files using deprecated or unavailable functions are triggering an error page. To debug this, enable error reporting to find the file and PHP error output.
 ===The file was encoded by the ionCube Encoder for PHP x.x and cannot run...===
@@ Line 51: / Line 49: @@
   The file /path/to/file.php was encoded by the ionCube Encoder for PHP 5.6 and cannot run under PHP 7.1 or later. Please ask the provider of the script to provide a version encoded with the ionCube Encoder for PHP 7.1.
-Seeing the above error message indicates that the file was encoded using an older version of ionCube Encoder® that does not include support for PHP 7.1 or later. Contact the original author of the file for an updated version.
+This error indicates that the file encoding uses an older version of ionCube Encoder® that does not support PHP 7.1 or later. Contact the original author of the file for an updated version.
 If the file is a WHMCS file, we may no longer maintain or distribute it.
-* You can identify WHMCS files by checking for the WHMCS copyright notice at the beginning of the file.
 * Typically, built-in routine updates remove these files automatically. However, permissions issues may prevent removal.
-* Normally, these files are not in use by the current version of WHMCS and you can delete them.
+* Normally, the current version of WHMCS does not use these files and you can delete them.

@@ Line 28: / Line 28: @@
 # In the WHMCS root directory, edit the <tt>configuration.php</tt> file.
-# Add these lines at the end of the configuration file, below any other lines but above the closing <tt>?></tt> line, if it is present:<div class="source-cli">
+# Add these lines at the end of the configuration file, below any other lines but above the closing <tt>?></tt> line, if it is present:<div class="source-cli">$display_errors = true;</div>
 After error reporting is enabled, retry the steps that previously led to the '''Oops!''', blank, or partially rendered page. More information will display.

@@ Line 1: / Line 1: @@
 [[PHP 7 Migration Guide|&laquo; Back to the PHP 7 Migration Guide]]
-If following a change of PHP version you encounter an Oops error page, or blank or partially rendered page, the most likely cause is that there is a file present in your installation that is not compatible with the new PHP version.
+If, after changing your PHP version, you encounter an '''Oops''' error or a blank or partially-rendered page, it is likely that there is a file in your installation that is not compatible with the new PHP version.
-Possible causes include:
+This may indicate one of these problems:
-* Syntax Error - A file uses deprecated or removed functionality which is no longer available in the newer version of PHP.
+* Syntax Error — A file uses deprecated or removed functionality that is no longer available in the newer version of PHP.
-* Decoding - A file is encoded with an ionCube encoding that is not compatible with the newer version of PHP or the installed ionCube Loader extension.
+* Decoding — A file is encoded with an ionCube® encoding that is not compatible with the newer version of PHP or the installed ionCube Loader® extension.
-To confirm the exact cause of the issue, you will need to enable error reporting.
+To confirm the exact cause of the issue, you must enable error reporting.
 ==Enabling Error Reporting==
 ===Enabling From 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'''.
+If you can log in to the Admin Area and navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''', use these steps to enable error display:
-# Tick the '''Display Errors''' checkbox located towards the bottom of the page
-# Click Save Changes
+# 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'''.
 ===Enabling From Your Configuration File===
-The lines needs to be added at the very end of the configuration.php file, below any other statements (but right before the closing PHP tag ''?>'', if present).
+If you cannot log in, use these steps to enable error reporting in the configuration file directly:
-<div class="source-cli">
+# In the WHMCS root directory, edit the <tt>configuration.php</tt> file.
 $display_errors = true;
 </div>
-After adding this line 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 error reporting is enabled, retry the steps that previously led to the '''Oops!''', blank, or partially rendered page. More information will display.
 ==Common Errors/Resolutions==
-With error reporting enabled, you should see the full error message being generated at the time the problematic PHP file is attempted to be included/executed.  Below are some of the most common errors you may encounter.
+With error reporting enabled, you should see the full error message that WHMCS generates when the problem occurs.
 ===Oops! Something went wrong and we couldn't process your request===
@@ Line 38: / Line 42: @@
 [[File:Oops_error_page.png]]
-Seeing an error page like the one pictured above indicates a fatal error is occurring.
+This indicates that a fatal error is occurring. Usually, this is due to these causes:
-Two of the most common causes are listed below:
+* '''Missing PHP Extensions''' — You may see this error if your version of PHP is missing some of the [[System_Environment_Guide#Extensions_2|required extensions]] for WHMCS.<div class="docs-alert-warning">If you compile PHP using EasyApache, you must include both the '''PDO''' and '''mysqlnd''' PHP extensions to allow MySQL® connections.</div>
-* '''Missing PHP Extensions''' - You may see this error if the version of PHP you switched to is missing some of the [[System_Environment_Guide#Extensions_2|required extensions]] for WHMCS.  Required extensions include: IonCube Loader, PDO, PDO_MYSQL, cURL with SSL Support, GD2 & IMAP.<div class="docs-alert-warning">Please note that if you are compiling PHP using EasyApache, be sure to include both the '''PDO''' and '''mysqlnd''' PHP extensions for MySQL connections to be possible.</div>
+===The file was encoded by the ionCube Encoder for PHP x.x and cannot run...===
-* '''Incompatible PHP Files''' - PHP files using deprecated or non-longer available functions may also trigger an error page such as this. To debug these types of issues, follow the instructions above to enable error reporting and a more detailed error output should be provided indicating the file and PHP error output.
+You may see an error message that looks like this:
-You may see an error message that looks like this:<br>
+ The file /path/to/file.php was encoded by the ionCube Encoder for PHP 5.6 and cannot run under PHP 7.1 or later. Please ask the provider of the script to provide a version encoded with the ionCube Encoder for PHP 7.1.
-Seeing the above error message indicates the itemised file was encoded using an older version of ionCube Encoder that does not include support for PHP 7.1 or later. You will need to contact the original vendor/author of the file to ask for an updated version of the file.
+Seeing the above error message indicates that the file was encoded using an older version of ionCube Encoder® that does not include support for PHP 7.1 or later. Contact the original author of the file for an updated version.
-If the file is a WHMCS file (you can determine this by looking at first several lines of the file for the WHMCS copyright notice), it is possible that it is a file that we no longer maintain or distribute.  Typically these files are removed automatically by the update routines built into WHMCS, but if at any time permissions did not allow for its removal, it is possible for it to remain on your system.  In most cases such files are no longer in use or valid for the current version of WHMCS. If it relates to a module that you do not use, it should be safe to simply delete it.  If you are unsure, our support team will be able to assist you in making this determination.
+If the file is a WHMCS file, we may no longer maintain or distribute it.
 [[PHP 7 Migration Guide|&laquo; Back to the PHP 7 Migration Guide]]

← Older revision		Revision as of 15:22, 29 March 2018
Line 35:		Line 35:

	* ''The file /path/to/file.php was encoded by the ionCube Encoder for PHP 5.6 and cannot run under PHP 7.1 or later. Please ask the provider of the script to provide a version encoded with the ionCube Encoder for PHP 7.1.''		* ''The file /path/to/file.php was encoded by the ionCube Encoder for PHP 5.6 and cannot run under PHP 7.1 or later. Please ask the provider of the script to provide a version encoded with the ionCube Encoder for PHP 7.1.''
−	* ''The file /path/to/file.php was encoded by the ionCube Encoder for PHP 5.6 and cannot run under PHP 7.2 or later. Please ask the provider of the script to provide a version encoded with the ionCube Encoder for PHP 7.2.''

	Seeing the above error message indicates the itemised file was encoded using an older version of ionCube Encoder that does not include support for PHP 7.1 or later. You will need to contact the original vendor/author of the file to ask for an updated version of the file.		Seeing the above error message indicates the itemised file was encoded using an older version of ionCube Encoder that does not include support for PHP 7.1 or later. You will need to contact the original vendor/author of the file to ask for an updated version of the file.

@@ Line 5: / Line 5: @@
 Possible causes include:
-* Use of old deprecated or removed functions that are no longer available in the newer version of PHP
+* Syntax Error - A file uses deprecated or removed functionality which is no longer available in the newer version of PHP.
-* Use of old ionCube encoding that is no longer compatible with the newer version of PHP
+* Decoding - A file is encoded with an ionCube encoding that is not compatible with the newer version of PHP or the installed ionCube Loader extension.
 To confirm the exact cause of the issue, you will need to enable error reporting.
@@ Line 13: / Line 13: @@
 ===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.
+If you can login to the admin area and navigate to '''General Settings''' then follow these steps below to enable error display.  After enabling Display Errors, retry the steps that previously led to the "Oops!", blank, or partially rendered page and further error information should be displayed.
 # Navigate to '''Setup > General Settings > Other'''
@@ Line 22: / Line 22: @@
 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.
+The lines needs to be added at the very end of the configuration.php file, below any other statements (but right before the closing PHP tag ''?>'', if present).
 <div class="source-cli">
@@ Line 28: / Line 28: @@
 </div>
-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 this line 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.
 ==Resolving the Issue==
@@ Line 39: / Line 39: @@
 Seeing the above error message indicates the itemised file was encoded using an older version of ionCube Encoder that does not include support for PHP 7.1 or later. You will need to contact the original vendor/author of the file to ask for an updated version of the file.
-If the file is a WHMCS file (you can determine this by looking at head of the file and looking for the WHMCS copyright notice), it is highly possible that it is a file that we no longer maintain or distribute.  Typically these files will have been removed automatically by the update routines built into WHMCS, but if at any time permissions did not allow for its' removal, it is possible for some files to remain.  In most cases it will no longer be being used, and if it relates to a module that you do not use, it should be safe to simply delete it.  If you are unsure, our support team will be able to assist you in making this determination.
+If the file is a WHMCS file (you can determine this by looking at first several lines of the file for the WHMCS copyright notice), it is possible that it is a file that we no longer maintain or distribute.  Typically these files are removed automatically by the update routines built into WHMCS, but if at any time permissions did not allow for its removal, it is possible for it to remain on your system.  In most cases such files are no longer in use or valid for the current version of WHMCS. If it relates to a module that you do not use, it should be safe to simply delete it.  If you are unsure, our support team will be able to assist you in making this determination.
 [[PHP 7 Migration Guide|&laquo; Back to the PHP 7 Migration Guide]]