Creating Modules:Registrar Module

Registrar Module

This document will show an example common output of the $params variable used in the Registrar module

Common Variables $params

Parameter	Sample Value	Usage	Comment
[sld]	whmcstesting	$params["sld"]
[tld]	com	$params["tld"]
[regperiod]	1	$params["regperiod"]	The number of years the client wants to register the domain 1-10
[domainid]	1	$params["domainid"]	The ID of the domain in the database
[ns1]	ns1.yourdomain.com	$params["ns1"]	First Nameserver
[ns2]	ns2.yourdomain.com	$params["ns2"]	Second Namserver
[ns3]		$params["ns3"]	Third Nameserver
[ns4]		$params["ns4"]	Fourth Nameserver
[transfersecret]		$params["transfersecret"]	Used for Domain Transfers - Otherwise known as EPP Code
[userid]	8	$params["userid"]	Client's ID in the database
[id]	8	$params["id"]	Client's ID in the database
Client Information for Domain Contact
[firstname]	WHMCS	$params["firstname"]
[lastname]	Testclient	$params["lastname"]
[companyname]		$params["companyname"]
[email]	test@email.com	$params["email"]
[address1]	10 This is a test	$params["address1"]
[address2]		$params["address2"]
[city]	Testing	$params["city"]
[state]	State	$params["state"]
[postcode]	TE5 5ST	$params["postcode"]
[country]	GB	$params["country"]
[countryname]	United Kingdom	$params["countryname"]
[phonenumber]	0123456783	$params["phonenumber"]	Phone number as entered in client profile
[fullphonenumber]	+44.0123456783	$params["fullphonenumber"]	Phone number pre-formatted for most registrars with country code
Client Custom Field Information
[customfields1]		$params["customfields1"]
[customfields2]		$params["customfields2"]
[customfields3]		$params["customfields3"]
[customfields4]		$params["customfields4"]
End Client Information for Domain Contact
[dnsmanagement]	1	$params["dnsmanagement"]	If DNS management is selected on domain order
[emailforwarding]	1	$params["emailforwarding"]	If Email Forwarding is selected on domain order
[idprotection]	1	$params["idprotection"]	If ID Protection is selected on domain order
Admin Information for Domain Admin/Billing/Tech Contact
This information can match Client Information depending on settings
[adminfirstname]	WHMCS	$params["adminfirstname"]
[adminlastname]	Testclient	$params["adminlastname"]
[admincompanyname]		$params["admincompanyname"]
[adminemail]	test@email.com	$params["adminemail"]
[adminaddress1]	10 This is a test	$params["adminaddress1"]
[adminaddress2]		$params["adminaddress2"]
[admincity]	Testing	$params["admincity"]
[adminstate]	State	$params["adminstate"]
[adminpostcode]	TE5 5ST	$params["adminpostcode"]
[admincountry]	GB	$params["admincountry"]
[adminphonenumber]	0123456783	$params["adminphonenumber"]	Phone number as entered in details
[adminfullphonenumber]	+44.0123456783	$params["adminfullphonenumber"]	Phone number pre-formatted for most registrars with country code
End Admin Information for Domain Admin/Billing/Tech Contact
[additionalfields]	Array ( [Sample Field] => Sample Answer )	$params["additionalfields"]["Sample Field"]	Additional fields defined in includes/additionaldomainfields.php