Working with Module Templates - Revision history

PeterM: /* Customising Templates */

2022-01-27T10:01:02Z

‎Customising Templates

SarahK at 23:02, 20 November 2020

2020-11-20T23:02:43Z

SarahK at 21:07, 1 June 2020

2020-06-01T21:07:31Z

Nate: /* Customising Templates */

2015-08-19T14:06:14Z

‎Customising Templates

Matt: /* Customising Templates */

2015-06-25T08:32:28Z

‎Customising Templates

Matt: /* Version Specific Templates */

2015-06-25T08:32:07Z

‎Version Specific Templates

Matt: /* Version Specific Templates */

2015-06-25T08:29:27Z

‎Version Specific Templates

Matt at 08:29, 25 June 2015

2015-06-25T08:29:09Z

Matt at 08:27, 25 June 2015

2015-06-25T08:27:14Z

Matt: Created page with "Modules that provide user facing output typically use templates to define and control that output. There are some exceptions, most often in the case of older modules, but all..."

2015-06-22T13:55:59Z

Created page with "Modules that provide user facing output typically use templates to define and control that output. There are some exceptions, most often in the case of older modules, but all..."

New page

Modules that provide user facing output typically use templates to define and control that output. There are some exceptions, most often in the case of older modules, but all recent modules should be using templates.

==How Templates Work==

Module template files can exist in either the root directory of the module, or in a subfolder named "templates".

In addition, modules can ship with template files that are designed for specific templates. For example, in the case of the Licensing Addon module that we ship with WHMCS, we provide two templates, /modules/servers/licensing/templates/managelicense.tpl which is optimised and designed for Version 6 and specifically the six template and custom templates based on that. But in addition, we also provide a /modules/servers/licensing/templates/five/managelicense.tpl template file which is optimised and designed for the Version 5 "five" template.

If your custom theme is based on the five template, you would likely want to consider using the overrides system below to have your custom template define the version optimised for five is used.

==Customising Templates==

Module templates can be customised using an overrides system that allows customisations to be performed within your active client area template theme folder.

<div class="docs-alert-info">'''Recommended''' This functionality was introduced in WHMCS 6.0 and is present in 6.0.0-rc.1 and later.</div>

The advantages of customising module templates this way is that your customisations remain unaffected through upgrades, and all of your customisations become portable and possible to backup as part of your custom template folder.

To create an override template, simply make a copy of the original template file within the following folder structure inside your custom template: ''/templates/yourtemplatename/modules/moduletype/modulename/''.

For example, in the case of the provisioning module "cpanel", ''/modules/servers/cpanel/overview.tpl'' could be customised by creating the following template file: ''/templates/yourtemplatename/modules/servers/cpanel/overview.tpl''

Another example, this time based upon the provisioning module "licensing", ''/modules/servers/licensing/templates/managelicense.tpl'' can be customised by creating the following template file ''/templates/yourtemplatename/modules/servers/licensing/managelicense.tpl''

The same thing applies to addon modules too. For example the client area view template located in ''/modules/addons/project_management/templates/clientview.tpl''' could be customised by creating the template file ''/templates/yourtemplatename/modules/project_management/templates/clientview.tpl''.

@@ Line 21: / Line 21: @@
 <div class="source-cli">/templates/yourtemplatename/modules/moduletype/modulename/</div>
-For example, in the case of the <tt>cpanel</tt> provisioning module, you could customize <tt>/modules/servers/cpanel/overview.tpl</tt> by creating the following template file:
+For example, in the case of the <tt>cpanel</tt> provisioning module, you could customize <tt>/modules/servers/cpanel/templates/overview.tpl</tt> by creating the following template file:
 <div class="source-cli">/templates/yourtemplatename/modules/servers/cpanel/overview.tpl</div>
@@ Line 32: / Line 32: @@
 <div class="source-cli">/templates/yourtemplatename/modules/addons/project_management/clientview.tpl</div>
-−
 ==Version-Specific Templates==

@@ Line 1: / Line 1: @@
-[[Modules]] that provide user facing output typically use templates to define and control that output.
+[[Modules]] that provide user-facing output typically use templates to define and control that output.
-−
-Module template files can exist in either the root directory of the module, or in a <tt>templates</tt> subfolder.
+Module template files can exist in either the root directory of the module or in a <tt>templates</tt> subdirectory.
-−
 ==Customising Templates==
-−
-You can customize module templates using an overrides system that allows customisations within your active client area template theme folder. We recommend this for several reasons:
+<div class="docs-alert-warning">
+<span class="title">WHMCS 6.0</span><br />
 * Customizations remain unaffected through upgrades.
 * All of your customisations remain in a centralized location.
 * Customizations of module templates are portable with themes.
 * Backing up customizations is easier.
-−
-<div class="docs-alert-warning">This functionality was introduced in WHMCS 6.0.</div>
+To create an override template, make a copy of the original template file within the following directory structure inside your custom template:
-−
-To create an override template, make a copy of the original template file within the following folder structure inside your custom template: <tt>/templates/yourtemplatename/modules/moduletype/modulename/</tt>
+<div class="source-cli">/templates/yourtemplatename/modules/moduletype/modulename/</div>
-−
-For example, in the case of the provisioning module <tt>cpanel</tt>, you could customize <tt>/modules/servers/cpanel/overview.tpl</tt> by creating the following template file: <tt>/templates/yourtemplatename/modules/servers/cpanel/overview.tpl</tt>
+For example, in the case of the <tt>cpanel</tt> provisioning module, you could customize <tt>/modules/servers/cpanel/overview.tpl</tt> by creating the following template file:
-−
-Another example, this time based upon the provisioning module <tt>licensin</tt>, you can customize <tt>/modules/servers/licensing/templates/managelicense.tpl</tt> by creating the following template file: <tt>/templates/yourtemplatename/modules/servers/licensing/managelicense.tpl</tt>
+<div class="source-cli">/templates/yourtemplatename/modules/servers/cpanel/overview.tpl</div>
-−
-This also applies to addon modules. For example, you can customize the client area view template in <tt>/modules/addons/project_management/templates/clientview.tpl</tt> by creating this template file: <tt>/templates/yourtemplatename/modules/addons/project_management/clientview.tpl</tt>
+Another example, this time based upon the <tt>licensing</tt> provisioning module, you can customize <tt>/modules/servers/licensing/templates/managelicense.tpl</tt> by creating the following template file:
-−
-==Version Specific Templates==
+<div class="source-cli">/templates/yourtemplatename/modules/servers/licensing/managelicense.tpl</div>
-−
-Modules can also provide templates that work with specific client area templates.
+This also applies to addon modules. For example, you can customize the Client Area view template in <tt>/modules/addons/project_management/templates/clientview.tpl</tt> by creating this template file:
-−
-In WHMCS 6.0, for example, there are two themes included by default: five and six. The six theme implements the Bootstrap 3 framework, while the five theme implements Bootstrap 2. Because of differences in how they apply styling and structures, a template that works for may not work for the other. Because of this, WHMCS supports Version Specific Templates.
+<div class="source-cli">/templates/yourtemplatename/modules/addons/project_management/clientview.tpl</div>
-−
-This allows you to define a default template with additional templates to use in conjunction with specific system templates. For example, this could provide an older Bootstrap 2-compatible template for use with the five theme. We do this in a few of our included addons and modules, in which the default is optimized for the six theme with Bootstrap 3, while a five version is provided in addition for older based themes.
+==Version-Specific Templates==
-−
-<div class="docs-alert-warning">
+Modules can also provide templates that work with specific Client Area themes.
-<span class="title">Note</span><br />
-If your custom theme is based on the five template, you might want to consider using the overrides system to have your custom template define the version optimised for five.
+In WHMCS 8.1 and higher, for example, there are two themes included by default: Twenty-One and Six. Six implements the Bootstrap 3 framework, while Twenty-One uses Bootstrap 4. Because of differences in how they apply styling and structures, a template that works for one may not work for the other. Because of this, WHMCS supports Version Specific Templates.
-</div>

@@ Line 1: / Line 1: @@
-Modules that provide user facing output typically use templates to define and control that output.
+[[Modules]] that provide user facing output typically use templates to define and control that output.
-Module template files can exist in either the root directory of the module, or in a subfolder named "templates".
+Module template files can exist in either the root directory of the module, or in a <tt>templates</tt> subfolder.
 ==Customising Templates==
-Module templates can be customised using an overrides system that allows customisations to be made within your active client area template theme folder.  We recommend this for a number of reasons:
+You can customize module templates using an overrides system that allows customisations within your active client area template theme folder. We recommend this for several reasons:
-* Customisations remain unaffected through upgrades
+* Customizations remain unaffected through upgrades.
-* All of your customisations are kept in a centralised location
+* All of your customisations remain in a centralized location.
-* Customisations of module templates are portable with themes
+* Customizations of module templates are portable with themes.
-* Backing up customisations is easier
+* Backing up customizations is easier.
 <div class="docs-alert-warning">This functionality was introduced in WHMCS 6.0.</div>
-To create an override template, simply make a copy of the original template file within the following folder structure inside your custom template: ''/templates/yourtemplatename/modules/moduletype/modulename/''.
+To create an override template, make a copy of the original template file within the following folder structure inside your custom template: <tt>/templates/yourtemplatename/modules/moduletype/modulename/</tt>
-For example, in the case of the provisioning module "cpanel", ''/modules/servers/cpanel/overview.tpl'' could be customised by creating the following template file: ''/templates/yourtemplatename/modules/servers/cpanel/overview.tpl''
+For example, in the case of the provisioning module <tt>cpanel</tt>, you could customize <tt>/modules/servers/cpanel/overview.tpl</tt> by creating the following template file: <tt>/templates/yourtemplatename/modules/servers/cpanel/overview.tpl</tt>
-Another example, this time based upon the provisioning module "licensing", ''/modules/servers/licensing/templates/managelicense.tpl'' can be customised by creating the following template file ''/templates/yourtemplatename/modules/servers/licensing/managelicense.tpl''
+Another example, this time based upon the provisioning module <tt>licensin</tt>, you can customize <tt>/modules/servers/licensing/templates/managelicense.tpl</tt> by creating the following template file: <tt>/templates/yourtemplatename/modules/servers/licensing/managelicense.tpl</tt>
-The same thing applies to addon modules too.  For example the client area view template located in ''/modules/addons/project_management/templates/clientview.tpl''' could be customised by creating the template file ''/templates/yourtemplatename/modules/addons/project_management/clientview.tpl''.
+This also applies to addon modules. For example, you can customize the client area view template in <tt>/modules/addons/project_management/templates/clientview.tpl</tt> by creating this template file: <tt>/templates/yourtemplatename/modules/addons/project_management/clientview.tpl</tt>
 ==Version Specific Templates==
-Modules can also provide templates that are designed to work with specific client area templates.
+Modules can also provide templates that work with specific client area templates.
-Take WHMCS 6.0 for example, there are two themes we ship by default: five and six.  The six theme implements the Bootstrap 3 framework, while the five theme implements Bootstrap 2.  As there are differences between the two in the way styling and structures are applied, a template that works for one doesn't work so well for the other.  And that's where Version Specific Templates come in.
+In WHMCS 6.0, for example, there are two themes included by default: five and six. The six theme implements the Bootstrap 3 framework, while the five theme implements Bootstrap 2. Because of differences in how they apply styling and structures, a template that works for may not work for the other. Because of this, WHMCS supports Version Specific Templates.
-What this allows is for you to define a template that is used by default, regardless of template, with additional templates which are used in conjunction with specific system templates, for example such as providing an older Bootstrap 2 compatible template for use with the five theme.  We do this in a few of our included addons and modules, whereby the default is optimised for the Six theme with Bootstrap 3, while a five version is provided in addition for older based themes.
+This allows you to define a default template with additional templates to use in conjunction with specific system templates. For example, this could provide an older Bootstrap 2-compatible template for use with the five theme. We do this in a few of our included addons and modules, in which the default is optimized for the six theme with Bootstrap 3, while a five version is provided in addition for older based themes.
-<div class="docs-alert-info">If your custom theme is based on the five template, you might want to consider using the overrides system to have your custom template define the version optimised for five is used.</div>
+<div class="docs-alert-warning">

@@ Line 20: / Line 20: @@
 Another example, this time based upon the provisioning module "licensing", ''/modules/servers/licensing/templates/managelicense.tpl'' can be customised by creating the following template file ''/templates/yourtemplatename/modules/servers/licensing/managelicense.tpl''
-The same thing applies to addon modules too.  For example the client area view template located in ''/modules/addons/project_management/templates/clientview.tpl''' could be customised by creating the template file ''/templates/yourtemplatename/modules/project_management/templates/clientview.tpl''.
+The same thing applies to addon modules too.  For example the client area view template located in ''/modules/addons/project_management/templates/clientview.tpl''' could be customised by creating the template file ''/templates/yourtemplatename/modules/addons/project_management/clientview.tpl''.
 ==Version Specific Templates==

@@ Line 12: / Line 12: @@
 * Backing up customisations is easier
-<div class="docs-alert-info">'''Recommended''' This functionality was introduced in WHMCS 6.0.</div>
+<div class="docs-alert-warning">This functionality was introduced in WHMCS 6.0.</div>
 To create an override template, simply make a copy of the original template file within the following folder structure inside your custom template: ''/templates/yourtemplatename/modules/moduletype/modulename/''.

@@ Line 1: / Line 1: @@
-Modules that provide user facing output typically use templates to define and control that output.  There are some exceptions, most often in the case of older modules, but all recent modules should be using templates.
+Modules that provide user facing output typically use templates to define and control that output.
 ==How Templates Work==
@@ Line 5: / Line 5: @@
 Module template files can exist in either the root directory of the module, or in a subfolder named "templates".
-In addition, modules can ship with template files that are designed for specific templates.  For example, in the case of the Licensing Addon module that we ship with WHMCS, we provide two templates, /modules/servers/licensing/templates/managelicense.tpl which is optimised and designed for Version 6 and specifically the six template and custom templates based on that.  But in addition, we also provide a /modules/servers/licensing/templates/five/managelicense.tpl template file which is optimised and designed for the Version 5 "five" template.
+==Version Specific Templates==
 If your custom theme is based on the five template, you would likely want to consider using the overrides system below to have your custom template define the version optimised for five is used.
@@ Line 11: / Line 17: @@
 ==Customising Templates==
-Module templates can be customised using an overrides system that allows customisations to be performed within your active client area template theme folder.
+Module templates can be customised using an overrides system that allows customisations to be made within your active client area template theme folder.  This has a number of advantages:
-<div class="docs-alert-info">'''Recommended''' This functionality was introduced in WHMCS 6.0 and is present in 6.0.0-rc.1 and later.</div>
+* Customisations remain unaffected through upgrades
-The advantages of customising module templates this way is that your customisations remain unaffected through upgrades, and all of your customisations become portable and possible to backup as part of your custom template folder.
+<div class="docs-alert-info">'''Recommended''' This functionality was introduced in WHMCS 6.0.</div>
 To create an override template, simply make a copy of the original template file within the following folder structure inside your custom template: ''/templates/yourtemplatename/modules/moduletype/modulename/''.