WHMCS Base URL Template Variable - Revision history

SarahK at 12:54, 24 May 2023

2023-05-24T12:54:35Z

SarahK at 20:43, 11 May 2022

2022-05-11T20:43:16Z

SarahK at 23:04, 20 November 2020

2020-11-20T23:04:49Z

SarahK at 22:45, 20 November 2020

2020-11-20T22:45:33Z

SarahK at 22:45, 20 November 2020

2020-11-20T22:45:08Z

SarahK at 22:44, 20 November 2020

2020-11-20T22:44:57Z

SarahK at 22:44, 20 November 2020

2020-11-20T22:44:34Z

AlexN at 12:26, 10 November 2020

2020-11-10T12:26:03Z

Matt: Created page with "The WHMCS Base URL must be defined in all client side template files for javascript ajax calls to function correctly. If this variable is not defined in your active system te..."

2018-04-17T14:11:20Z

Created page with "The WHMCS Base URL must be defined in all client side template files for javascript ajax calls to function correctly. If this variable is not defined in your active system te..."

New page

The WHMCS Base URL must be defined in all client side template files for javascript ajax calls to function correctly.

If this variable is not defined in your active system template then you will see a warning notice in the browser console as follows:

<div class="docs-alert-warning">
Warning: The WHMCS Base URL definition is missing from your active template. Please refer to https://docs.whmcs.com/WHMCS_Base_URL_Template_Variable for more information and details of how to resolve this warning.
</div>

To resolve this warning, you must add the following to the ''<head>'' section of your template:

<div class="source-cli">
<script>
var whmcsBaseUrl = "{\WHMCS\Utility\Environment\WebHelper::getBaseUrl()}";
</script>
</div>

It is important that this variable is defined before the templates ''scripts.min.js'' file is included.

By default, the Six template defines this parameter within the ''/includes/head.tpl'' template file along with a number of other required javascript variables.

You can refer to https://github.com/WHMCS/templates-six/blob/master/includes/head.tpl for a copy of the latest version of the head.tpl template file.

← Older revision		Revision as of 12:54, 24 May 2023
Line 1:		Line 1:
−	The [[General Tab\|WHMCS ~~Base~~ URL]] must be defined in all system theme template files for JavaScript AJAX calls to function correctly. It determines the path to the WHMCS directory on your server. WHMCS requires this in order to determine the location of relative resources that the system theme template requires.	+	The [[General Tab\|WHMCS System URL]] must be defined in all system theme template files for JavaScript AJAX calls to function correctly. It determines the path to the WHMCS directory on your server. WHMCS requires this in order to determine the location of relative resources that the system theme template requires.

	If this variable is not defined in your active system theme template, you will see a warning in the browser console:		If this variable is not defined in your active system theme template, you will see a warning in the browser console:

← Older revision		Revision as of 20:43, 11 May 2022
Line 1:		Line 1:
−	The WHMCS Base URL must be defined in all system theme template files for JavaScript AJAX calls to function correctly. It determines the path to the WHMCS directory on your server. WHMCS requires this in order to determine the location of relative resources that the system theme template requires.	+	The [[General Tab\|WHMCS Base URL]] must be defined in all system theme template files for JavaScript AJAX calls to function correctly. It determines the path to the WHMCS directory on your server. WHMCS requires this in order to determine the location of relative resources that the system theme template requires.

	If this variable is not defined in your active system theme template, you will see a warning in the browser console:		If this variable is not defined in your active system theme template, you will see a warning in the browser console:

@@ Line 1: / Line 1: @@
-The WHMCS Base URL must be defined in all client side template files for javascript ajax calls to function correctly, it determines the path to the WHMCS directory on your server. It is required for WHMCS to determine where relative resources required by the template are located.
+The WHMCS Base URL must be defined in all system theme template files for JavaScript AJAX calls to function correctly. It determines the path to the WHMCS directory on your server. WHMCS requires this in order to determine the location of relative resources that the system theme template requires.
-−
-If this variable is not defined in your active system template then you will see a warning notice in the browser console as follows:
+If this variable is not defined in your active system theme template, you will see a warning in the browser console:
-−
-<div class="docs-alert-warning">
+<div class="source-cli">
-Warning: The WHMCS Base URL definition is missing from your active template. Please refer to [[WHMCS_Base_URL_Template_Variable|WHMCS Base URL Template Variable]] for more information and details of how to resolve this warning.
+Warning: The WHMCS Base URL definition is missing from your active template. Please refer to https://docs.whmcs.com/WHMCS_Base_URL_Template_Variable for more information and details of how to resolve this warning.
 </div>
-−
-To resolve this warning, you must add the following to the ''<head>'' section of your template:
+To resolve this warning, you must add the following to the <tt><head></tt> section of your template:
-−
 <div class="source-cli">
 <script>
-var whmcsBaseUrl = "{\WHMCS\Utility\Environment\WebHelper::getBaseUrl()}";
+<br/>var whmcsBaseUrl = "{\WHMCS\Utility\Environment\WebHelper::getBaseUrl()}";
-</script>
+<br/></script>
 </div>
-<div class="docs-alert-warning">
+It is important that this variable is defined before the templates <tt>scripts.min.js</tt> file is included.
-<span class="title">Client Area Templates</span><br />
-We introduced Twenty-One in WHMCS 8.1. We plan to remove Six in a future version.
+By default, the Six template defines this parameter within the <tt>/includes/head.tpl</tt> system theme template file along with a number of other required JavaScript variables.
-See [https://github.com/WHMCS/templates-six/blob/master/includes/head.tpl our GitHub repository] for a copy of the latest version of the <tt>/includes/head.tpl</tt> system theme template file.
+[https://github.com/WHMCS/templates-six/blob/master/includes/head.tpl Visit GitHub] for a copy of the latest version of the <tt>head.tpl</tt> template file for the Six theme, or look in the appropriate directories in your WHMCS installation for Twenty-One.

@@ Line 4: / Line 4: @@
 <div class="docs-alert-warning">
-Warning: The WHMCS Base URL definition is missing from your active template. Please refer to [WHMCS_Base_URL_Template_Variable] for more information and details of how to resolve this warning.
+Warning: The WHMCS Base URL definition is missing from your active template. Please refer to [[WHMCS_Base_URL_Template_Variable|WHMCS Base URL Template Variable]] for more information and details of how to resolve this warning.
 </div>

@@ Line 4: / Line 4: @@
 <div class="docs-alert-warning">
-Warning: The WHMCS Base URL definition is missing from your active template. Please refer to [[WHMCS_Base_URL_Template_Variable]] for more information and details of how to resolve this warning.
+Warning: The WHMCS Base URL definition is missing from your active template. Please refer to [WHMCS_Base_URL_Template_Variable] for more information and details of how to resolve this warning.
 </div>

@@ Line 17: / Line 17: @@
 It is important that this variable is defined before the templates ''scripts.min.js'' file is included.
-By default, the Six template defines this parameter within the ''/includes/head.tpl'' template file along with a number of other required javascript variables.
+By default, the Twenty-One and Six system themes define this parameter and many other required JavaScript variables in the <tt>/includes/head.tpl</tt> system theme template.
-−
-You can refer to https://github.com/WHMCS/templates-six/blob/master/includes/head.tpl for a copy of the latest version of the head.tpl template file.
+<div class="docs-alert-warning">

← Older revision		Revision as of 12:26, 10 November 2020
Line 1:		Line 1:
−	The WHMCS Base URL must be defined in all client side template files for javascript ajax calls to function correctly.	+	The WHMCS Base URL must be defined in all client side template files for javascript ajax calls to function correctly, it determines the path to the WHMCS directory on your server. It is required for WHMCS to determine where relative resources required by the template are located.

	If this variable is not defined in your active system template then you will see a warning notice in the browser console as follows:		If this variable is not defined in your active system template then you will see a warning notice in the browser console as follows: