Template:Hook:ClientAreaPageActions

From WHMCS Documentation

Revision as of 11:02, 7 July 2015 by Andrew (talk | contribs) (Created page with "=={{{hookName|}}}== ===Description=== {{Hook_Categories_Vertical| type = Clients}}{{{description|}}} ===Hook Type=== Standard (Glossary#Standard_Hook|What does this mean?...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

This page has moved to https://developers.whmcs.com/hooks/


Hook Type

Standard (What does this mean?)

Input Parameters

All the currently defined smarty variables are passed to this hook. Each page has different variables assigned. The below are some of the fields. This list is not exhaustive.
Variable Type Notes
SCRIPT_NAME String The name of the script being loaded
template String The template name
language String The language being used.
companyname String The Company of the installation.
logo String The logo defined in General Settings
charset String The system Charset
pagetitle String The title of the page.
pageicon String The icon image defined for the page
filename String The current filename
breadcrumb Array An array of breadcrumb information
breadcrumbnav String The breadcrumb navigation as output
todaysdate String Todays date as a string
date_day Integer 2 digit day of the month with leading 0 where appropriate
date_month Integer 2 digit month of the year with leading 0 where appropriate
date_year Integer 4 digit year
systemurl String The System URL
langchange Boolean Is language changing enabled?
setlanguage String Only if langchange == true. The HTML output of the language dropdown
currencies Array An array of defined currencies ordered by "code".
start of currencies array
id Integer The currency ID. tblcurrencies.id
code String The three character currency code.
default Integer 1 for yes, 0 for no
end of currencies array
twitterusername String If enabled, the twitter username entered.

Return Type

None required. An array of field => value combinations can be returned if required.

Example

add_hook('ClientAreaPageAddContact', 1,
	function($vars)
	{
             $return = array("field1" => "value1", "field2" => "value2");
             return $return;
	}
);

Changelog