Client Area Interface

The following hooks are provided for Client Area Interface related events.

ClientAreaHomepage

Executes on rendering of the client area homepage.

Parameters

Response

Accepts HTML to be output before the closing body tag of the admin area output

Example Code

<?php
add_hook('ClientAreaHomepage', 1, function($vars)
{
   return "HTML output here";
});

ClientAreaPage

Executes on all pages of the client area and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPage', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageAddContact

Executes on the client area add contact page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageAddContact', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageAddFunds

Executes on the client area add funds page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageAddFunds', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageAffiliates

Executes on the client area affiliates page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageAffiliates', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageAnnouncements

Executes on the client area announcements page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageAnnouncements', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageCancellation

Executes on the client area cancellation request page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageCancellation', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageCart

Executes on the shopping cart page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageCart', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageChangePassword

Executes on the client area change password page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageChangePassword', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageContact

Executes on the contact form page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageContact', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageDomainContacts

Executes on the client area domain WHOIS contact information page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageDomainContacts', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageDomainDNSManagement

Executes on the client area domain DNS Host Record management page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageDomainDNSManagement', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageDomainDetails

Executes on the client area domain overview page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageDomainDetails', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageDomainEPPCode

Executes on the client area domain EPP Code page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageDomainEPPCode', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageDomainRegisterNameservers

Executes on the client area domain Register Private Nameservers page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageDomainRegisterNameservers', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageDomains

Executes on the client area domains list page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageDomains', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageDownloads

Executes on the client area downloads page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageDownloads', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageEmails

Executes on the client area email history page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageEmails', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageInvoices

Executes on the client area invoices page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageInvoices', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageKnowledgebase

Executes on the client area knowledgebase page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageKnowledgebase', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageLogin

Executes on the login page of the client area. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageLogin', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageNetworkIssues

Executes on the client area network issues page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageNetworkIssues', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPagePasswordReset

Executes on the client area password reset page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPagePasswordReset', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageProductDetails

Executes on the client area product overview page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageProductDetails', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageProductsServices

Executes on the client area product and services list page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageProductsServices', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageProfile

Executes on the client area profile page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageProfile', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageQuotes

Executes on the client area quotes page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageQuotes', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageRegister

Executes on the client registration page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageRegister', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageSecurity

Executes on the client area security page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageSecurity', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageViewInvoice

Executes on the client area view invoice page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageViewInvoice', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPageViewQuote

Executes on the client area view quote page and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

Parameters

Response

A key/value pair array of additional template variables to define.

Example Code

<?php
add_hook('ClientAreaPageViewQuote', 1, function($vars)
{
    return ["key"=>"value","key2"=>"value2","key3"=>"value3"];
});

ClientAreaPrimaryNavbar

Executes when generating the primary navigation bar in the client area

Parameters

Response

A key/value pair array.

Example Code

<?php
add_hook('ClientAreaPrimaryNavbar', 1, function($vars)
{
	$array = [];
        //Menu Return Format = HTML or ARRAY 
	$array['Format']='HTML';

        //Custom Menu Stracture if Needed
	$array['Stracture']=[
	'nav_tag_open'        => '<ul class="navbar-nav ml-auto">',            
	'parentl1_tag_open'   => '<li class="nav__item">',
	'parentl1_anchor'     => '<a tabindex="0" data-toggle="dropdown" href="%s" aria-expanded="false">%s<span class="caret"></span></a>',
	'item_tag_open'       => '<li class="nav__item %s">',
	'item_anchor'         => '<a href="%s" class="nav__item-link">%s</a>',
	'parent_tag_open'     => '<li class="nav__item has-dropdown">',
	'parent_anchor'       => '<a href="%s" data-toggle="dropdown" class="dropdown-toggle nav__item-link">%s</a>',
	'children_tag_open'   => '<ul class="dropdown-menu" style="max-height: 300px;overflow-y: auto;">'
	];		    
	
	//Add New Menus
	$array['Add']['Features']=['name'=>'Features','order'=>0,'slug'=>'#','parent'=>'','icon'=>''];
	
	//Removal of any menu
	$array['Remove']=['Dashboard','Domains','Services'];
	
	return $array;
});

ClientAreaFooterNavbar

Executes when generating the footer navigations in the client area

Parameters

Response

A key/value pair array.

Example Code

<?php
add_hook('ClientAreaPrimaryNavbar', 1, function($vars)
{
	$array = [];
        //Menu Return Format = HTML or ARRAY 
	$array['Format']='HTML';

        //Custom Menu Stracture if Needed
	$array['Stracture']=[
	'nav_tag_open'        => '<ul class="navbar-nav ml-auto">',            
	'parentl1_tag_open'   => '<li class="nav__item">',
	'parentl1_anchor'     => '<a tabindex="0" data-toggle="dropdown" href="%s" aria-expanded="false">%s<span class="caret"></span></a>',
	'item_tag_open'       => '<li class="nav__item %s">',
	'item_anchor'         => '<a href="%s" class="nav__item-link">%s</a>',
	'parent_tag_open'     => '<li class="nav__item has-dropdown">',
	'parent_anchor'       => '<a href="%s" data-toggle="dropdown" class="dropdown-toggle nav__item-link">%s</a>',
	'children_tag_open'   => '<ul class="dropdown-menu" style="max-height: 300px;overflow-y: auto;">'
	];		    
	
	//Add New Menus
	$array['Add']['Features']=['name'=>'Features','order'=>0,'slug'=>'#','parent'=>'','icon'=>''];
	
	//Removal of any menu
	$array['Remove']=['Dashboard','Domains','Services'];
	
	return $array;
});