Difference between revisions of "Troubleshooting Client Area Template Issues"
(→Check the Logs) |
|||
| Line 1: | Line 1: | ||
| − | You've upgraded your installation, but now your custom | + | You've upgraded your installation, but now your custom system theme template is no longer working. The steps below may help you. |
| − | + | ||
==Why does this happen?== | ==Why does this happen?== | ||
| − | + | ||
| − | A blank or partially rendered page indicates a fatal PHP error | + | A blank or partially rendered page indicates a fatal PHP error that stops the execution from being able to continue. This can be caused by a number of reasons. For example: |
| − | + | ||
| − | * Using PHP code blocks in your template without the '''Allow Smarty PHP Tags''' setting enabled at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security'''. | + | * Using PHP code blocks in your system theme template without the '''Allow Smarty PHP Tags''' setting enabled at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security'''. |
| − | * A custom or third party module or hook that is incompatible with the new version | + | * A custom or third-party module or hook that is incompatible with the new version. |
| − | * A syntax issue in your template | + | * A syntax issue in your system theme template. |
| − | * Using features | + | * Using Smarty features that have been removed in the upstream Smarty package. |
| − | + | ||
| − | For more detailed information, | + | For more detailed information, see [[Blank or Partially Rendered Pages]]. |
| − | + | ||
==Check the Logs== | ==Check the Logs== | ||
| − | + | ||
| − | + | When you encounter an error of this nature, check the '''[[Activity_Logs|Activity Log]]'''. This can be acccessed by navigating to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' ('''Utilities > Logs > Activity Log''' in WHMCS 7.x and earlier) within the admin area. All of the errors encountered by the Smarty templating engine are logged here. They should help you find the exact system theme template and section of code that is causing the problem. | |
| − | + | ||
| − | ==Try a Different Template== | + | ==Try a Different System Theme Template== |
| − | + | ||
| − | If you don't find anything in the activity logs, switching to a different template will help determine | + | If you don't find anything in the activity logs, switching to a different system theme template will help determine the cause of the issue. |
| − | + | ||
| − | If changing to a different template allows the client area to load successfully, | + | If changing to a different system theme template allows the client area to load successfully, the issue is in your system theme template itself. If you continue to experience problems loading the client area with other system theme templates, then your issue is more likely related to a module or hook and not a specific individual system theme template. |
| − | + | ||
| − | To change the template your WHMCS system uses, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' and choose one of the default templates in the ''' | + | To change the system theme template your WHMCS system uses, navigate to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' and choose one of the default system theme templates in the '''System Theme''' setting in the '''General''' tab. Then, click '''Save''' and attempt to visit your client area. |
| − | + | ||
| − | ==Check Your Templates for Legacy Smarty Functions== | + | ==Check Your System Theme Templates for Legacy Smarty Functions== |
| − | + | ||
| − | Most custom templates won't need any updates to be compatible with newer versions of Smarty, | + | Most custom system theme templates won't need any updates to be compatible with newer versions of Smarty. However, features that are only available in Smarty 2 will need to be migrated to ensure a smooth transition to the latest version. |
| − | + | ||
| − | For more information | + | For more information, see our [[Version 6 Template Migration Guide]]. |
| − | + | ||
==Contact our Support Team== | ==Contact our Support Team== | ||
| − | + | ||
| − | If none of the above help, | + | If none of the above help, [http://www.whmcs.com/support/ contact our support team]. |
Revision as of 23:05, 20 November 2020
You've upgraded your installation, but now your custom system theme template is no longer working. The steps below may help you.
Contents
Why does this happen?
A blank or partially rendered page indicates a fatal PHP error that stops the execution from being able to continue. This can be caused by a number of reasons. For example:
- Using PHP code blocks in your system theme template without the Allow Smarty PHP Tags setting enabled at Configuration () > System Settings > General Settings > Security.
- A custom or third-party module or hook that is incompatible with the new version.
- A syntax issue in your system theme template.
- Using Smarty features that have been removed in the upstream Smarty package.
For more detailed information, see Blank or Partially Rendered Pages.
Check the Logs
When you encounter an error of this nature, check the Activity Log. This can be acccessed by navigating to Configuration () > System Logs (Utilities > Logs > Activity Log in WHMCS 7.x and earlier) within the admin area. All of the errors encountered by the Smarty templating engine are logged here. They should help you find the exact system theme template and section of code that is causing the problem.
Try a Different System Theme Template
If you don't find anything in the activity logs, switching to a different system theme template will help determine the cause of the issue.
If changing to a different system theme template allows the client area to load successfully, the issue is in your system theme template itself. If you continue to experience problems loading the client area with other system theme templates, then your issue is more likely related to a module or hook and not a specific individual system theme template.
To change the system theme template your WHMCS system uses, navigate to Configuration () > System Settings > General Settings and choose one of the default system theme templates in the System Theme setting in the General tab. Then, click Save and attempt to visit your client area.
Check Your System Theme Templates for Legacy Smarty Functions
Most custom system theme templates won't need any updates to be compatible with newer versions of Smarty. However, features that are only available in Smarty 2 will need to be migrated to ensure a smooth transition to the latest version.
For more information, see our Version 6 Template Migration Guide.
Contact our Support Team
If none of the above help, contact our support team.