Matt: Replaced content with "This page has moved to http://developers.whmcs.com/domain-registrars/module-parameters/"

2016-12-13T14:49:25Z

Replaced content with "This page has moved to http://developers.whmcs.com/domain-registrars/module-parameters/"

Show changes

Matt: Removed protection from "Creating Modules:Registrar Module"

2015-12-09T08:34:56Z

Removed protection from "Creating Modules:Registrar Module"

Andrew: Protected "Creating Modules:Registrar Module" ([edit=sysop] (indefinite) [move=sysop] (indefinite))

2011-03-25T18:00:09Z

Protected "Creating Modules:Registrar Module" ([edit=sysop] (indefinite) [move=sysop] (indefinite))

Andrew: Version 1 with general parameters listed

2011-03-25T17:59:48Z

Version 1 with general parameters listed

New page

== Registrar Module ==

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

=== Common Variables $params ===

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

← Older revision	Revision as of 08:34, 9 December 2015
(No difference)

← Older revision	Revision as of 18:00, 25 March 2011
(No difference)

Creating Modules:Registrar Module - Revision history

Matt: Replaced content with "This page has moved to http://developers.whmcs.com/domain-registrars/module-parameters/"

Matt: Removed protection from "Creating Modules:Registrar Module"

Andrew: Protected "Creating Modules:Registrar Module" ([edit=sysop] (indefinite) [move=sysop] (indefinite))

Andrew: Version 1 with general parameters listed