Templates and Custom PHP Logic - Revision history

SarahK at 21:49, 26 January 2023

2023-01-26T21:49:50Z

SarahK at 19:20, 27 April 2022

2022-04-27T19:20:30Z

SarahK at 23:03, 20 November 2020

2020-11-20T23:03:27Z

SarahK at 20:59, 5 August 2020

2020-08-05T20:59:46Z

John: /* Example Hook File */

2017-04-20T09:04:24Z

‎Example Hook File

Matt at 10:58, 7 July 2015

2015-07-07T10:58:47Z

Matt: Matt moved page PHP Logic within Templates to Templates and Custom PHP Logic

2015-05-17T13:52:41Z

Matt moved page PHP Logic within Templates to Templates and Custom PHP Logic

Matt: Created page with "We strongly recommend that all custom PHP logic be performed via hooks. Hooks are the only future-proof way of performing your own PHP logic at the time of page rendering. H..."

2015-05-17T13:32:58Z

Created page with "We strongly recommend that all custom PHP logic be performed via hooks. Hooks are the only future-proof way of performing your own PHP logic at the time of page rendering. H..."

New page

We strongly recommend that all custom PHP logic be performed via hooks. Hooks are the only future-proof way of performing your own PHP logic at the time of page rendering.

Historically, Smarty has always allowed you to define custom PHP logic directly within template files. This has often been used by users and third party developers as a quick and convenient way of performing additional logic and defining additional template output.

However, as of Smarty 3, support for the {php} block has been removed, and we are only providing legacy support to ease the transition for developers and users who work with our platform and rely on this functionality.

<div class="docs-alert-info">
In WHMCS 6.0 and later, a Security setting "Allow Smarty PHP Tags" has been introduced in '''Setup > General Settings > Security''' which must be checked to enable the use of PHP tags. At the time of writing, this setting defaults to On. In the future, this setting will be defaulted to '''Off'''.
</div>

Below is an example of how a hook can be used to perform additional logic and define template variables for use in client area template files.

<source lang="php">
<?php
/**
* Hook sample for defining additional template variables
*
* @param array $vars Existing defined template variables
*
* @return array
*/
function hook_template_variables_example($vars)
{
$extraTemplateVariables = array();

// set a fixed value
$extraTemplateVariables['fixedValue'] = 'abc';

// fetch clients data if available
$clientsData = isset($vars['clientsdetails']) ? $vars['clientsdetails'] : null;

// determine if client is logged in
if (is_array($clientsData) && isset($clientsData['id'])) {
$userId = $clientsData['id'];
// perform calculation here
$extraTemplateVariables['userSpecificValue'] = '123';
$extraTemplateVariables['anotherUserOnlyValue'] = '456';
}

// return array of template variables to define
return $extraTemplateVariables;
}

add_hook('ClientAreaPage', 1, 'hook_template_variables_example');

</source>

@@ Line 1: / Line 1: @@
-We recommend that you perform all custom PHP logic via hooks. Hooks are the only future-proof way of performing your own PHP logic at the time of page rendering.
+If you want to include custom PHP logic in your customized templates, we recommend using hooks.
 <div class="docs-alert-warning">
-WHMCS 6.0 and later include a backwards compatibility '''Allow Smarty PHP Tags''' setting in the '''[[Security Tab|Security]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
+We deprecated support for Smarty's legacy tags in WHMCS 6.0 and plan to permanently remove support in WHMCS 9.0. You '''must''' disable and remove them. For more information, see [[Eliminating Legacy Smarty Tags]].
 </div>
-==Example Hook File==
+== Hook Points ==
-<div class="docs-alert-info">
+Hook points for every page of the Client Area allow you to define system theme and order form template variables. For a full list, see our [https://developers.whmcs.com/hooks-reference/client-area-interface/ Client Area Interface Hooks Reference].
 <source lang="php">
 <?php
@@ Line 31: / Line 25: @@
+{
      $extraTemplateVariables = array();
-−
      // set a fixed value
      $extraTemplateVariables['fixedValue'] = 'abc';
-−
      // fetch clients data if available
      $clientsData = isset($vars['clientsdetails']) ? $vars['clientsdetails'] : null;
-−
      // determine if client is logged in
      if (is_array($clientsData) && isset($clientsData['id'])) {
@@ Line 45: / Line 39: @@
          $extraTemplateVariables['anotherUserOnlyValue'] = '456';
+     }
-−
      // return array of template variables to define
      return $extraTemplateVariables;
+}
-−
 add_hook('ClientAreaPageViewTicket', 1, 'hook_template_variables_example');
-−
 </source>
-The hook code above defines the additional system theme and order form template <tt>{$fixedValue}</tt> variable and, in the case of a logged-in user, the <tt>{$userSpecificValue}</tt> and <tt>{$anotherUserOnlyValue}</tt> variables. You can them use them in the associated system theme and order form template file (in this case, <tt>viewticket.tpl</tt>).
+You can them use them in the associated system theme and order form template file (in this case, <tt>viewticket.tpl</tt>):
-−
 <source lang="php">
 <p>The fixed value is {$fixedValue}.</p>
-−
 {if $userSpecificValue && $anotherUserOnlyValue}
      <p>I also have this {$userSpecificValue} and {$anotherUserOnlyValue} to show you.</p>
 {/if}
 </source>

@@ Line 1: / Line 1: @@
-We recommend that all custom PHP logic be performed via hooks. Hooks are the only future-proof way of performing your own PHP logic at the time of page rendering.
+We recommend that you perform all custom PHP logic via hooks. Hooks are the only future-proof way of performing your own PHP logic at the time of page rendering.
-Historically, Smarty has allowed you to define custom PHP logic directly within system theme and order form template files. This has often been used by users and third-party developers as a quick and convenient way of performing additional logic and defining additional system theme and order form template output.
+Historically, Smarty has allowed you to define custom PHP logic directly within system theme and order form template files. This allowed for a quick and convenient way of performing additional logic and defining additional system theme and order form template output.
-However, as of Smarty 3, support for the <tt>{php}</tt> block has been removed, and we are only providing legacy support to ease the transition for developers and users who work with our platform and rely on this functionality.
+However, Smarty 3 removed support for the <tt>{php}</tt> block. WHMCS now only provides legacy support to ease the transition for developers and users who rely on this functionality.
 <div class="docs-alert-warning">
-WHMCS 6.0 and later include a backwards compatibility '''Allow Smarty PHP Tags''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security''' or, prior to WHMCS 8.0, '''Setup > General Settings > Security'''. You must select this to enable the use of PHP tags. This setting defaults to '''Off''' and may be removed in a future version.
+WHMCS 6.0 and later include a backwards compatibility '''Allow Smarty PHP Tags''' setting in the '''[[Security Tab|Security]]''' tab at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings''' or, prior to WHMCS 8.0, '''Setup > General Settings'''.
 </div>
@@ Line 14: / Line 16: @@
 <div class="docs-alert-info">
-The example below executes on the '''View Ticket''' page within the client area. There are hook points available for every page of the WHMCS client area. They allow you to define system theme and order form template variables. For a full list, see [https://developers.whmcs.com/hooks-reference/client-area-interface/ Client Area Interface Hooks Index Listing].
+The example below executes on the '''View Ticket''' page within the Client Area. Hook points for every page of the Client Area allow you to define system theme and order form template variables. For a full list, see [https://developers.whmcs.com/hooks-reference/client-area-interface/ Client Area Interface Hooks Index Listing].
 </div>
@@ Line 52: / Line 54: @@
 </source>
-The above hook defines the additional system theme and order form template <tt>{$fixedValue}</tt> variable and, in the case of a logged-in user, <tt>{$userSpecificValue}</tt> and <tt>{$anotherUserOnlyValue}</tt> variables. You can them use them inside the associated system theme and order form template file (in this case, <tt>viewticket.tpl</tt>).
+The hook code above defines the additional system theme and order form template <tt>{$fixedValue}</tt> variable and, in the case of a logged-in user, the <tt>{$userSpecificValue}</tt> and <tt>{$anotherUserOnlyValue}</tt> variables. You can them use them in the associated system theme and order form template file (in this case, <tt>viewticket.tpl</tt>).
 <source lang="php">

@@ Line 1: / Line 1: @@
-We recommend that all custom PHP logic be performed via hooks.  Hooks are the only future-proof way of performing your own PHP logic at the time of page rendering.
+We recommend that all custom PHP logic be performed via hooks. Hooks are the only future-proof way of performing your own PHP logic at the time of page rendering.
-−
-Historically, Smarty has allowed you to define custom PHP logic directly within template files.  This has often been used by users and third party developers as a quick and convenient way of performing additional logic and defining additional template output.
+Historically, Smarty has allowed you to define custom PHP logic directly within system theme and order form template files. This has often been used by users and third-party developers as a quick and convenient way of performing additional logic and defining additional system theme and order form template output.
-−
-However, as of Smarty 3, support for the {php} block has been removed, and we are only providing legacy support to ease the transition for developers and users who work with our platform and rely on this functionality.
+However, as of Smarty 3, support for the <tt>{php}</tt> block has been removed, and we are only providing legacy support to ease the transition for developers and users who work with our platform and rely on this functionality.
-−
 <div class="docs-alert-warning">
-In WHMCS 6.0 and later, a backwards compatibility Security setting "Allow Smarty PHP Tags" has been introduced in  '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security''' or, prior to WHMCS 8.0, '''Setup > General Settings > Security''' which must be checked to enable the use of PHP tags.  This setting defaults to '''Off''', and may be removed in a future versions.
+WHMCS 6.0 and later include a backwards compatibility '''Allow Smarty PHP Tags''' setting at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security''' or, prior to WHMCS 8.0, '''Setup > General Settings > Security'''. You must select this to enable the use of PHP tags. This setting defaults to '''Off''' and may be removed in a future version.
 </div>
-−
 ==Example Hook File==
-−
-The below example demonstrates how a hook can be used to perform additional PHP logic and define template variables for use in client area template files.
+The below example demonstrates how a hook can be used to perform additional PHP logic and define variables for use in system theme and order form template files.
-−
-<div class="docs-alert-info">This example below executes on the View Ticket page within the client area. There are hook points available for every page of the WHMCS client area that allow you to defined template variables in this way.  For a full list, please refer to the [https://developers.whmcs.com/hooks-reference/client-area-interface/ Client Area Interface Hooks Index Listing].</div>
+<div class="docs-alert-info">
+The example below executes on the '''View Ticket''' page within the client area. There are hook points available for every page of the WHMCS client area. They allow you to define system theme and order form template variables. For a full list, see [https://developers.whmcs.com/hooks-reference/client-area-interface/ Client Area Interface Hooks Index Listing].
 <source lang="php">
 <?php
@@ Line 27: / Line 29: @@
+{
      $extraTemplateVariables = array();
-−
      // set a fixed value
      $extraTemplateVariables['fixedValue'] = 'abc';
-−
      // fetch clients data if available
      $clientsData = isset($vars['clientsdetails']) ? $vars['clientsdetails'] : null;
-−
      // determine if client is logged in
      if (is_array($clientsData) && isset($clientsData['id'])) {
@@ Line 41: / Line 43: @@
          $extraTemplateVariables['anotherUserOnlyValue'] = '456';
+     }
-−
      // return array of template variables to define
      return $extraTemplateVariables;
+}
-−
 add_hook('ClientAreaPageViewTicket', 1, 'hook_template_variables_example');
-−
 </source>
-−
-The above hook defines the additional template variables {$fixedValue} - and, in the case of a logged in user, {$userSpecificValue} and {$anotherUserOnlyValue}.  These can then be used inside the associated template file (in this case, viewticket.tpl) in the regular way.
+The above hook defines the additional system theme and order form template <tt>{$fixedValue}</tt> variable and, in the case of a logged-in user, <tt>{$userSpecificValue}</tt> and <tt>{$anotherUserOnlyValue}</tt> variables. You can them use them inside the associated system theme and order form template file (in this case, <tt>viewticket.tpl</tt>).
-−
 <source lang="php">
 <p>The fixed value is {$fixedValue}.</p>
-−
 {if $userSpecificValue && $anotherUserOnlyValue}
      <p>I also have this {$userSpecificValue} and {$anotherUserOnlyValue} to show you.</p>
 {/if}
 </source>

@@ Line 6: / Line 6: @@
 <div class="docs-alert-warning">
-In WHMCS 6.0 and later, a backwards compatibility Security setting "Allow Smarty PHP Tags" has been introduced in '''Setup > General Settings > Security''' which must be checked to enable the use of PHP tags.  This setting defaults to '''Off''', and may be removed in a future versions.
+In WHMCS 6.0 and later, a backwards compatibility Security setting "Allow Smarty PHP Tags" has been introduced in  '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > General Settings > Security''' or, prior to WHMCS 8.0, '''Setup > General Settings > Security''' which must be checked to enable the use of PHP tags.  This setting defaults to '''Off''', and may be removed in a future versions.
 </div>

@@ Line 13: / Line 13: @@
 The below example demonstrates how a hook can be used to perform additional PHP logic and define template variables for use in client area template files.
-<div class="docs-alert-info">This example below executes on the View Ticket page within the client area. There are hook points available for every page of the WHMCS client area that allow you to defined template variables in this way.  For a full list, please refer to the [[Hooks:Index#Client_Area_Interface|Client Area Interface Hooks Index Listing]]</div>
+<div class="docs-alert-info">This example below executes on the View Ticket page within the client area. There are hook points available for every page of the WHMCS client area that allow you to defined template variables in this way.  For a full list, please refer to the [https://developers.whmcs.com/hooks-reference/client-area-interface/ Client Area Interface Hooks Index Listing].</div>
 <source lang="php">

← Older revision	Revision as of 13:52, 17 May 2015
(No difference)