Template Syntax - Revision history

John: Replaced content with "
Note
This page has moved to [https://developers.whmcs.com/themes/variables/ https://developers.whmcs.com/the..."

2017-01-04T11:02:10Z

Replaced content with "<div class="docs-alert-info"> <span class="title">Note</span><br /> This page has moved to [https://developers.whmcs.com/themes/variables/ https://developers.whmcs.com/the..."

Cole at 15:33, 5 October 2016

2016-10-05T15:33:19Z

Matt: /* Custom Template Variables */

2016-03-21T09:14:28Z

‎Custom Template Variables

Matt: /* Common Template Variables Available on All Pages */

2016-03-21T09:11:34Z

‎Common Template Variables Available on All Pages

Cole at 21:03, 15 January 2016

2016-01-15T21:03:30Z

Andrew: DOCS-6349

2015-12-29T11:12:43Z

DOCS-6349

Matt: /* Displaying Text if Certain Conditions Are Met */

2015-11-09T14:32:48Z

‎Displaying Text if Certain Conditions Are Met

Matt at 15:32, 4 August 2015

2015-08-04T15:32:25Z

Show changes

Matt at 07:22, 25 June 2015

2015-06-25T07:22:38Z

John at 16:23, 29 July 2014

2014-07-29T16:23:32Z

@@ Line 1: / Line 1: @@
-The basic template syntax can be seen by looking at the templates. Template files use regular HTML along with tags for where the WHMCS data is inserted into them. All pages have specific variables which you can use. A complete list of variables on a page is available by entering the following tag into the template:
+<div class="docs-alert-info">
+<span class="title">Note</span><br />
-<div class="docs-alert-info"><center>'''{debug}'''</center></div>
+This page has moved to [https://developers.whmcs.com/themes/variables/ https://developers.whmcs.com/themes/variables/]
+</div>

@@ Line 98: / Line 98: @@
 <p>{lang key="clientHomePanels.creditBalance" creditBalance="$100"}</p>
 </syntaxhighlight>
 ==More Information==

@@ Line 34: / Line 34: @@
 ===Custom Template Variables===
-Not all variables are available on every page. If the variable you wish to use isn't there, then you would need to get this yourself.
+The template parameters available in templates will vary depending upon the page/object being requested.
-[[Hooks:EmailPreSend]] can be used to create custom smarty variables. These variables can be used within email templates.
+Should you require additional content or variables that are not defined by default, you can add to them using hooks.  The following hooks are available for these purposes:
 ==Displaying Text to Logged In Users Only==

@@ Line 16: / Line 16: @@
 *{$client} - The currently logged in [http://docs.whmcs.com/classes/classes/WHMCS.User.Client.html Client], or ''null'' if a client is not logged in.
 *{$companyname} - The configured company name
-*{date_day} - The current calendar day.
+*{$date_day} - The current calendar day.
-*{date_month} - The current calendar month.
+*{$date_month} - The current calendar month.
-*{date_year} - The current calendar year.
+*{$date_year} - The current calendar year.
 *{filename} - The basename of the current file requested by the web browser.
 *{$language} - The name of the language to display to the user.

@@ Line 51: / Line 51: @@
 ==Displaying Text if Certain Conditions Are Met==
-It can often be necessary to display text or messages when certain conditions are met. For example, you might want to add extra text output when iterating through products. (Or, payment gateways, or display card scheme logos associated with your merchant account, etc.). Achieved this by using the if statement syntax:
+It can often be necessary to display text or messages when certain conditions are met. For example, you might want to add extra text output when iterating through products. (Or, payment gateways, or display card scheme logos associated with your merchant account, etc.). Achieve this by using the if statement syntax:
 <syntaxhighlight lang="smarty">{if $gateway.name eq "PayPal"}We accept PayPal{/if}</syntaxhighlight>
-Would display the message "We accept PayPal" if that option is available on the checkout page. This can be used for any variable.
+This example would display the message "We accept PayPal" if that option is available on the checkout page. This can be used for any variable.
 ==Translating Language Strings==

@@ Line 1: / Line 1: @@
-The basic template syntax can be seen by looking at the templates. Template files simply use regular HTML along with tags for where the WHMCS data is inserted into them.  All pages have specific variables which you can use.  To view a complete list of variables available on a given page, enter the following tag into the template file:
+The basic template syntax can be seen by looking at the templates. Template files use regular HTML along with tags for where the WHMCS data is inserted into them. All pages have specific variables which you can use. A complete list of variables on a page is available by entering the following tag into the template:
 <div class="docs-alert-info"><center>'''{debug}'''</center></div>
-When you next access the page containing that template file in your browser after adding this code, a popup window will appear showing you all the different variables which you can use on the page.  Variables can be accessed using the {$variable} syntax.
+The next access to the page using that template file after adding this code will show a popup window. This window will show all the different variables which you can use on the page. Access variables using the {$variable} syntax.
 ==Common Template Variables Available on All Pages==
-The following is a list of template variables available for use in all the template files of WHMCS
+The following is a list of template variables available for use in all the template files of WHMCS:
 *{$BASE_PATH_CSS} - The base URL to common CSS assets.
@@ Line 13: / Line 13: @@
 *{$BASE_PATH_IMG} - The base URL to common image assets.
 *{$BASE_PATH_JS} - The base URL to common Javascript assets.
-*{$charset} - Your configured character set.
+*{$charset} - The configured character set.
 *{$client} - The currently logged in [http://docs.whmcs.com/classes/classes/WHMCS.User.Client.html Client], or ''null'' if a client is not logged in.
-*{$companyname} - Your configured company name
+*{$companyname} - The configured company name
 *{date_day} - The current calendar day.
 *{date_month} - The current calendar month.
@@ Line 21: / Line 21: @@
 *{filename} - The basename of the current file requested by the web browser.
 *{$language} - The name of the language to display to the user.
-*{$loggedin} - ''true'' or ''false'' depending on whether or not a client is logged in.
+*{$loggedin} - ''true'' or ''false'' depending on if a client is logged in.
-*{$logo} - The path to your configured logo image.
+*{$logo} - The path to the configured logo image.
 *{$pagetitle} - The current page's title.
-*{$reCaptchaPublicKey} - Your configured [https://www.google.com/recaptcha/intro/index.html reCAPTCHA] site key, or an empty string if your WHMCS installation does not use Google reCAPTCHA.
+*{$reCaptchaPublicKey} - The configured [https://www.google.com/recaptcha/intro/index.html reCAPTCHA] site key. This can be an empty string if the WHMCS installation does not use Google reCAPTCHA.
-*{$systemNonSSLURL} - Your configured non-SSL URL.
+*{$systemNonSSLURL} - The configured non-SSL URL.
-*{$systemsslurl} - Your configured SSL URL.
+*{$systemsslurl} - The configured SSL URL.
-*{$systemurl} - The URL to your WHMCS system, either the SSL or non-SSL URL depending on whether the current page is accessed via HTTPS.
+*{$systemurl} - The URL to the WHMCS system. Either the SSL or non-SSL URL depending on whether the current page loaded via HTTPS.
 *{$template} - The name of the template used for display.
 *{$todaysdate} - The current date, presented in "l, jS F Y" format.
@@ Line 34: / Line 34: @@
 ===Custom Template Variables===
-Not all variables are available on every page, and if the variable you wish to use isn't there, then you would need to obtain this yourself.
+Not all variables are available on every page. If the variable you wish to use isn't there, then you would need to get this yourself.
-[[Hooks:EmailPreSend]] can be used to create your own smarty variables to use on email templates.
+[[Hooks:EmailPreSend]] can be used to create custom smarty variables. These variables can be used within email templates.
 ==Displaying Text to Logged In Users Only==
@@ Line 51: / Line 51: @@
 ==Displaying Text if Certain Conditions Are Met==
-It can often be necessary to display text or messages when certain conditions are met. For example you might want to add additional text output when iterating through products or payment gateways, or display card scheme logos associated with your merchant account. This can be achieved using the if statement syntax:
+It can often be necessary to display text or messages when certain conditions are met. For example, you might want to add extra text output when iterating through products. (Or, payment gateways, or display card scheme logos associated with your merchant account, etc.). Achieved this by using the if statement syntax:
 <syntaxhighlight lang="smarty">{if $gateway.name eq "PayPal"}We accept PayPal{/if}</syntaxhighlight>
@@ Line 59: / Line 59: @@
 ==Translating Language Strings==
-WHMCS provides the '''{lang}''' function for custom templates to present text in your users' configured language. Call it with the "key" parameter representing the key in the language to translate.
+WHMCS provides the {lang} function for templates to present text in the user's language. Call it with the "key" parameter representing the key in the language to translate.
 <syntaxhighlight lang="smarty">

@@ Line 1: / Line 1: @@
 The basic template syntax can be seen by looking at the templates. Template files simply use regular HTML along with tags for where the WHMCS data is inserted into them.  All pages have specific variables which you can use.  To view a complete list of variables available on a given page, enter the following tag into the template file:
-<center>'''{debug}'''</center>
+<div class="docs-alert-info">
 When you next access the page containing that template file in your browser after adding this code, a popup window will appear showing you all the different variables which you can use on the page.  Variables can be accessed using the {$variable} syntax.
@@ Line 21: / Line 24: @@
 *{$clientsdetails.firstname}
 *{$clientsdetails.lastname}
 ==Using curly braces for literal statements==
@@ Line 27: / Line 35: @@
 Example:
    {literal}
    <script type="text/javascript">
@@ Line 34: / Line 44: @@
    </script>
    {/literal}
 Everything within the {literal} {/literal} tags will not be parsed (such as the template variables above). However, you would be able to accomplish adding the template variables by using multiple literal statements, such as this:
    {literal}
    <script type="text/javascript">
@@ Line 42: / Line 55: @@
+   }
    {/literal}
 ==Displaying Text to Logged In Users Only==
 To display something on the page only if a user is logged in, use the following syntax:
+<source lang="php">
   {if $loggedin}
   User is logged in so display client only information
@@ Line 52: / Line 66: @@
   User is not logged in so display this
   {/if}
 ==Displaying Text if Certain Conditions Are Met==
@@ Line 57: / Line 72: @@
 In a similar vein it can be useful to display things only if certain conditions are met. For example you might want to display card scheme logos associated with your different payment gateways, or show information based upon what is displayed on the page. This is done using if commands:
-{if $gateway.name eq "PayPal"}We accept PayPal{/if}
+<source lang="php">{if $gateway.name eq "PayPal"}We accept PayPal{/if}</source>
 Would display the message "We accept PayPal" if that option is available on the checkout page. This can be used for any variable.
@@ Line 67: / Line 82: @@
 One of the most common reasons for using PHP code in the templates is to query the database for additional information.  An example of how this can be done is below.
   {php}
   $userid = $this->_tpl_vars['clientsdetails']['userid'];
@@ Line 74: / Line 90: @@
   echo $firstname;
   {/php}
 The first line in the above code is also demonstrating how you can retrieve and use template variables within your custom PHP code.
@@ Line 79: / Line 96: @@
 ==More Information==
-For furthur documentation on template customisations, see the official Smarty documentation @ http://smarty.net/docs.php
+For further documentation on template customisations, see the official Smarty documentation @ http://smarty.net/docs.php
 {{Developer_Links}}