How to create custom provisioning modules and hook custom .tpl files with WHMCS?

[Keval Bhogayata]

I know how to add provisioning modules in WHMCS. But how to hook my custom .tpl (which are inside my module) files with WHMCS.

Also php code inside my .tpl files do not show any effect (Only html tags are executed).

[twhiting9275]

To start with, do NOT use php code inside of template files. This has been deprecated for years now. Follow basic common sense practices and you'll be fine

<edit>
My bad, a bit more research shows that this can be done with provisioning modules.

You'll want to take a look at their sample provisioning module . Download it, dissect it, then go from there. Once you're done with that you should understand how to add your template files in

Edited January 31, 2018 by twhiting9275
corrected a couple things

[twhiting9275]

If you're just starting out, you don't. Find a way to implement this outside of the template

PHP code inside of smarty templating has been deprecated for quite some time, and will eventually be removed. You need to find a proper method to doing what is being done. There's always a way to do that.

[sentq]

10 hours ago, Keval Bhogayata said:

I do not know how to include and run php code inside .tpl file.

what you need to do is to write your PHP logic inside the PHP file, then pass the results as Smarty variables to be displayed in your .TPL file,

check this file: https://github.com/WHMCS/sample-provisioning-module/blob/master/modules/servers/provisioningmodule/provisioningmodule.php#L744

function provisioningmodule_ClientArea(array $params)
{
    // Determine the requested action and set service call parameters based on
    // the action.
    $requestedAction = isset($_REQUEST['customAction']) ? $_REQUEST['customAction'] : '';
    if ($requestedAction == 'manage') {
        $serviceAction = 'get_usage';
        $templateFile = 'templates/manage.tpl';
    } else {
        $serviceAction = 'get_stats';
        $templateFile = 'templates/overview.tpl';
    }
    try {
        // Call the service's function based on the request action, using the
        // values provided by WHMCS in `$params`.
        $response = array();
        $extraVariable1 = 'abc';
        $extraVariable2 = '123';
        return array(
            'tabOverviewReplacementTemplate' => $templateFile,
            'templateVariables' => array(
                'extraVariable1' => $extraVariable1,
                'extraVariable2' => $extraVariable2,
            ),
        );
    } catch (Exception $e) {
        // Record the error in WHMCS's module log.
        logModuleCall(
            'provisioningmodule',
            __FUNCTION__,
            $params,
            $e->getMessage(),
            $e->getTraceAsString()
        );
        // In an error condition, display an error page.
        return array(
            'tabOverviewReplacementTemplate' => 'error.tpl',
            'templateVariables' => array(
                'usefulErrorHelper' => $e->getMessage(),
            ),
        );
    }
}

as you can see the "templateVariables" include "extraVariable1" and "extraVariable2",  these variables for example will have the result of your logic (PHP code executed to do certain task), so in your tpl file you can write {$extraVariable1} and it should display the value of that variable.

it should be as easy as that, but if you need further explanation just ask

[sentq]

6 hours ago, Keval Bhogayata said:

Thank you very much, it worked for me. How to know which action will be triggered on which client area buttons/links if you can help?

the following part check if "custom" action were called, if so you can specify different options for each action (template file, variables, etc):

$requestedAction = isset($_REQUEST['customAction']) ? $_REQUEST['customAction'] : '';
if ($requestedAction == 'manage') {
	$serviceAction = 'get_usage';
    $templateFile = 'templates/manage.tpl';
} else {
   	$serviceAction = 'get_stats';
    $templateFile = 'templates/overview.tpl';
}

 

[Keval Bhogayata]

14 hours ago, twhiting9275 said:

To start with, do NOT use php code inside of template files. This has been deprecated for years now. Follow basic common sense practices and you'll be fine

<edit>
My bad, a bit more research shows that this can be done with provisioning modules.

You'll want to take a look at their sample provisioning module . Download it, dissect it, then go from there. Once you're done with that you should understand how to add your template files in

I have already downloaded similar module earlier,  but I do not know how to include and run php code inside .tpl file.

[Keval Bhogayata]

On 2/2/2018 at 4:31 AM, sentq said:

what you need to do is to write your PHP logic inside the PHP file, then pass the results as Smarty variables to be displayed in your .TPL file,

check this file: https://github.com/WHMCS/sample-provisioning-module/blob/master/modules/servers/provisioningmodule/provisioningmodule.php#L744

function provisioningmodule_ClientArea(array $params)
{
    // Determine the requested action and set service call parameters based on
    // the action.
    $requestedAction = isset($_REQUEST['customAction']) ? $_REQUEST['customAction'] : '';
    if ($requestedAction == 'manage') {
        $serviceAction = 'get_usage';
        $templateFile = 'templates/manage.tpl';
    } else {
        $serviceAction = 'get_stats';
        $templateFile = 'templates/overview.tpl';
    }
    try {
        // Call the service's function based on the request action, using the
        // values provided by WHMCS in `$params`.
        $response = array();
        $extraVariable1 = 'abc';
        $extraVariable2 = '123';
        return array(
            'tabOverviewReplacementTemplate' => $templateFile,
            'templateVariables' => array(
                'extraVariable1' => $extraVariable1,
                'extraVariable2' => $extraVariable2,
            ),
        );
    } catch (Exception $e) {
        // Record the error in WHMCS's module log.
        logModuleCall(
            'provisioningmodule',
            __FUNCTION__,
            $params,
            $e->getMessage(),
            $e->getTraceAsString()
        );
        // In an error condition, display an error page.
        return array(
            'tabOverviewReplacementTemplate' => 'error.tpl',
            'templateVariables' => array(
                'usefulErrorHelper' => $e->getMessage(),
            ),
        );
    }
}

as you can see the "templateVariables" include "extraVariable1" and "extraVariable2",  these variables for example will have the result of your logic (PHP code executed to do certain task), so in your tpl file you can write {$extraVariable1} and it should display the value of that variable.

it should be as easy as that, but if you need further explanation just ask

Thank you very much, it worked for me. How to know which action will be triggered on which client area buttons/links if you can help?

[Keval Bhogayata]

20 hours ago, sentq said:

the following part check if "custom" action were called, if so you can specify different options for each action (template file, variables, etc):

$requestedAction = isset($_REQUEST['customAction']) ? $_REQUEST['customAction'] : '';
if ($requestedAction == 'manage') {
	$serviceAction = 'get_usage';
    $templateFile = 'templates/manage.tpl';
} else {
   	$serviceAction = 'get_stats';
    $templateFile = 'templates/overview.tpl';
}

 

Ok, got it. Thanks again.