Encountering errors while accessing pages within the admin or client area of your WHMCS installation can be frustrating. Here are some common errors you may come across:
“Oops! Something went wrong and we couldn’t process your request. Please go back to the previous page and try again.”
Entirely blank page.
500 Internal Server error.
To resolve these errors and ensure smooth functionality, follow the professional instructions provided below:
Steps to Enable Debugging Mode in WHMCS
-
-
- Step 1. Log in as WHMCS Admin
- Step 2. Go to Configuration >> System Settings >> General Settings >> Other Tab or Setup >> General Settings >> Other Tab (prior to WHMCS 8.0)
- Step 3. Tick the Display Errors checkbox located towards the bottom of the page.
-
| Display Errors | Tick to enable Displaying PHP Errors (Not recommended for production use) |
| Log Errors | Tick to enable logging of PHP Errors when possible (Not recommended for daily production use) |
| SQL Debug Mode | Tick to enable logging of SQL Errors (Use only for testing purposes) |
| Hooks Debug Mode | Tick to enable logging of Hook Calls (Use only for testing purposes) |
Debugging Mode enabled in WHMCS!
Once you are done with the above steps, try to access/reload that page where you are getting an error and after that, you will find the exact error and then you can contact your third-party vendor or module provider with that error screenshot.
Note: Don’t forget to uncheck the “Display Errors” option when you are finished troubleshooting. Leaving the error display enabled can be a security concern.
Enable Debugging Mode in the Configuration File
If you are unable to log in with the WHMCS admin area or don’t have access to enable debugging mode, then in that situation, there is a manual way to enable it with the configuration file. You can enable error reporting in the configuration.php file in the WHMCS root directory.
Access WHMCS files via FTP/cPanel/Plesk/etc, edit the configuration.php file, and add the below line at the end of the configuration.php file before the PHP tag closing (?>).
$display_errors = true;
After adding this line and saving and uploading the file on the correct path, retry the same previous steps to reload that error page, and then you will get additional error information, and you can contact your third-party vendor for that error.
Note: Do not forget to remove this code line when you are finished troubleshooting. Leaving the error display enabled can be a security concern.
How to Enable Debugging Mode in cPanel and Plesk?
To enable debugging mode in cPanel and Plesk, the specific steps may vary depending on the version and configuration of your hosting environment. However, follow these general guidelines for both cPanel and Plesk.
Enabling Debugging Mode in cPanel:
-Log in to your cPanel account.
-In the “Software” section, look for the “Advanced” or “Advanced Options” category.
-Find and click on the “PHP Configuration” or “Select PHP Version” option.
-In the PHP configuration settings, look for the “error_reporting” option. Set it to “E_ALL” to display all errors.
-Look for the “display_errors” option and set it to “On” to enable error display.
-Save the changes.
Enabling Debugging Mode in Plesk:
-Log in to your Plesk control panel.
-Navigate to the domain or subscription you want to enable debugging for.
-Go to the “Websites & Domains” section.
-Depending on your Plesk version, you may find different paths to enable debugging:
-If you have Plesk Onyx or Obsidian, click on “PHP Settings” under the “Hosting Settings” section.
-If you have Plesk 12.x, go to “Website Scripting and Security” and click on “PHP Settings.”
In the PHP settings page, find the “error_reporting” option and set it to “E_ALL” to -display all errors.
-Look for the “display_errors” option and set it to “On” to enable error display.
-Save the changes.
Note: After enabling debugging mode in either cPanel or Plesk, error messages and warnings will be displayed on the website if any issues occur. Remember to disable debugging mode once you have resolved the problems, as error messages can expose sensitive information and impact the performance of your website.
Why Enable Debugging Mode in WHMCS?
Importance of Enabling Debugging Mode: Enabling Debugging Mode in WHMCS is an essential step for effectively troubleshooting and resolving errors that may arise within your WHMCS installation. By following the outlined steps, you can access detailed error messages that provide insight into the underlying issues affecting your system. This information is invaluable for diagnosing problems, whether they stem from custom modules, third-party integrations, or configuration settings.
Benefits of Detailed Error Reporting: When you enable debugging, you can identify specific errors that may not be visible under normal circumstances, allowing you to take appropriate action. For instance, if you encounter a vague error message or a blank page, enabling error reporting can reveal the exact nature of the problem, such as missing files, incorrect database connections, or syntax errors in custom code.
Security Factors of Debugging Mode: However, it is crucial to remember that while debugging mode is a powerful tool for development and troubleshooting, it should be used with caution. Displaying errors in a production environment can expose sensitive information to potential attackers, leading to security vulnerabilities. Therefore, always ensure that you disable error display once you have resolved the issues.
Best Practices for Enabling Debugging Mode: In addition to the steps provided for enabling debugging mode through the WHMCS admin interface, configuration files, cPanel, and Plesk, it is advisable to maintain a regular backup of your WHMCS installation. This practice ensures that you can quickly restore your system to a stable state if any issues arise during troubleshooting.
Conclusion
In summary, enabling Debugging Mode in WHMCS not only aids in identifying and fixing errors but also enhances your overall understanding of the system’s functionality. By taking the necessary precautions and following best practices, you can ensure a smoother experience for both administrators and clients, ultimately leading to improved performance and reliability of your WHMCS installation.
Related Articles:
