Registrar Module Developer Docs - Revision history

SarahK at 19:46, 2 March 2022

2022-03-02T19:46:48Z

SarahK at 19:45, 2 March 2022

2022-03-02T19:45:39Z

SarahK: Redirected page to Https://developers.whmcs.com/domain-registrars/

2022-03-02T19:45:12Z

Redirected page to Https://developers.whmcs.com/domain-registrars/

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

2017-01-28T17:56:00Z

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

Show changes

Matt: /* Module Parameters */

2016-10-28T15:29:29Z

‎Module Parameters

John: /* App Store */

2016-03-22T11:16:06Z

‎App Store

Cole at 20:33, 15 January 2016

2016-01-15T20:33:53Z

Andrew at 13:08, 23 December 2015

2015-12-23T13:08:26Z

Andrew: DOCS-6345

2015-12-23T13:08:00Z

DOCS-6345

Show changes

John at 20:54, 27 March 2015

2015-03-27T20:54:30Z

← Older revision		Revision as of 19:46, 2 March 2022
Line 1:		Line 1:
−	~~#REDIRECT [~~https://developers.whmcs.com/domain-registrars/]	+	This page has moved to https://developers.whmcs.com/domain-registrars/

← Older revision		Revision as of 19:45, 2 March 2022
Line 1:		Line 1:
−	#REDIRECT [[https://developers.whmcs.com/domain-registrars/]]	+	#REDIRECT [https://developers.whmcs.com/domain-registrars/]

← Older revision		Revision as of 19:45, 2 March 2022
Line 1:		Line 1:
−	~~This page has moved to~~ https://developers.whmcs.com/domain-registrars/	+	#REDIRECT [[https://developers.whmcs.com/domain-registrars/]]

@@ Line 204: / Line 204: @@
 ==Module Parameters==
-The module parameters are the data/values passed into each function when called. Every module function receives the same parameters. These parameters provide information about the specific domain the module command runs for. The parameters also contain the settings from the registrar itself. Extra variables may be available depending upon the function running.
+The module parameters are the data/values passed into each function when called. Every registrar module function receives the same parameters. These parameters provide information about the specific domain the module command runs for. The parameters also contain the settings from the registrar itself. Extra variables may be available depending upon the function running.
 <table width="100%" cellspacing="1" bgcolor="#cccccc">

@@ Line 309: / Line 309: @@
 http://docs.whmcs.com/Provisioning_Module_Developer_Docs#Module_Logging
-==App Store==
+==WHMCS Marketplace==
-WHMCS offers an app store which accepts submission of the completed module.  Displayed listings are found under the Addons tab within the administration area and online at http://www.whmcs.com/appstore . This is a great way to make WHMCS users aware of the module.
+WHMCS offers a Marketplace which accepts submission of the completed module. Displayed listed are found under the Addons tab within the administration area and online at http://marketplace.whmcs.com . This is a great way to make WHMCS users aware of the module.
-Submission of a listing requires a login for  whmcs.com/members, if you do not have one please [https://www.whmcs.com/members/submitticket.php?step=2&deptid=5 Contact Us]. Once logged in, visit the app store page at the above URL and click the "Submit your Addon" link. We aim to review submissions in 1-2 weeks.
+For help using the Marketplace please refer to https://marketplace.whmcs.com/help . We aim to review submissions in 1-2 weeks.
 {{Developer_Links}}

@@ Line 3: / Line 3: @@
 Registrar Modules are also referred to as '''Domain Modules'''.
-The core functionality of a registrar module will allow for
+The core functionality of a registrar module will allow for:
 * registering domains
@@ Line 16: / Line 16: @@
-There are other types of module in WHMCS. These are [[Gateway Module Developer Docs|Payment Gateways]], [[Provisioning Module Developer Docs|Provisioning Modules]] and [[Addon Module Developer Docs|Addons]].
+There are other types of modules in WHMCS. These are [[Gateway Module Developer Docs|Payment Gateways]], [[Provisioning Module Developer Docs|Provisioning Modules]] and [[Addon Module Developer Docs|Addons]].
 ==Getting Started==
@@ Line 91: / Line 91: @@
 *'''TransferDomain''' - Called when an existing domain transfer request comes from WHMCS
-*'''GetNameservers''' - Called whenever a domain is viewed within WHMCS. It can return up to 5 nameservers that are set for the domain.
+*'''GetNameservers''' - Called whenever a domain is viewed within WHMCS. It can return up to 5 nameservers that are set for the domain
-*'''SaveNameservers''' - Called when a change request to the nameservers displayed inside WHMCS.
+*'''SaveNameservers''' - Called when a change request to the nameservers displayed inside WHMCS
-*'''GetRegistrarLock''' - Called whenever a domains details are viewed within WHMCS. It should return the current lock status of a domain - either locked or unlocked.
+*'''GetRegistrarLock''' - Called whenever a domains details are viewed within WHMCS. It should return the current lock status of a domain - either locked or unlocked
-*'''SaveRegistrarLock''' - Called when the lock status setting is toggled within WHMCS.
+*'''SaveRegistrarLock''' - Called when the lock status setting is toggled within WHMCS
-*'''GetContactDetails''' - Called when the WHOIS information is displayed within WHMCS.
+*'''GetContactDetails''' - Called when the WHOIS information is displayed within WHMCS
 *'''SaveContactDetails''' - Called when revised WHOIS information is submitted
 *'''GetDNS''' - Called when the DNS Host Records are requested to be viewed within WHMCS
@@ Line 107: / Line 107: @@
 *'''RequestDelete''' - Called when a domain deletion request comes from WHMCS
-*'''ClientArea''' - Used to define module specific client area output. It accepts a return of HTML for display on the domain details page of the client area. Output via a template file within the module folder named "clientarea.tpl" is also possible. Discussion of this function in more detail later on in the docs.
+*'''ClientArea''' - Used to define module specific client area output. It accepts a return of HTML for display on the domain details page of the client area. Output via a template file within the module folder named "clientarea.tpl" is also possible. This function is discussed in more detail later on in the docs.
 *'''ClientAreaCustomButtonArray''' - Used to define custom functions that the module supports. Customers can invoke and run these from the client area. The functions can perform actions or product page output in the client area. Example usages for this are to provide domain management pages, bandwidth reporting pages, etc…
 *'''ClientAreaAllowedFunctions''' - Like the above, used to define custom functions. These are functions that customers can invoke, but are not shown as buttons by default. (i.e. custom client area output will invoke them).
@@ Line 113: / Line 113: @@
 == Domain Cron Synchronisation ==
-Implementation of domain sync into a registrar module ensures domains in WHMCS stay in sync with the registry. This can include syncing status changes, renewals, and expiry dates. This is particularly useful when it comes to transfers where completion of the transfer, and expiry dates can never be known by WHMCS automatically.
+Implementation of domain sync into a registrar module ensures domains in WHMCS stay in sync with the registry. This can include syncing status changes, renewals, and expiry dates. This is particularly useful when it comes to transfers where completion of the transfer and expiry dates can never be known by WHMCS automatically.
 Let's look at Transfer Syncing. If present in your module, this function will run for every domain in the Pending Transfer status when the domain sync cron runs. The function should then return a true response for completed. Or a failed status if the transfer has changed status since the last check. If failed, you can also return a reason. If there has been no change yet, then you should return nothing.
@@ Line 147: / Line 147: @@
 # - or if failed
-$values['failed'] = true; # when transfer fails permenantly
+$values['failed'] = true; # when transfer fails permanently
 $values['reason'] = "Reason here..."; # reason for the transfer failing (if available) - a generic failure reason is given if no reason is returned
@@ Line 160: / Line 160: @@
 </source>
-Then there is regular Domain Syncing. If present in your module, then this function runs for 50 of the domains for the module on a rolling basis each time the domain sync cron runs. Once all domains have synced it will start from the beginning again. This function can also detect any changes done at registrars directly, such as changes to dates or statuses.
+Next is regular Domain Syncing. If present in your module, then this function runs for 50 of the domains for the module on a rolling basis each time the domain sync cron runs. Once all domains have synced it will start from the beginning again. This function can also detect any changes done at registrars directly, such as changes to dates or statuses.
 <source lang = "php">
@@ Line 198: / Line 198: @@
 Settings relating to domain syncing are in the Setup > General Settings > Domains area. There are 3 key settings:
-# '''Domain Sync Enabled''' - Check to allow the domain sync cron to actually run
+# '''Domain Sync Enabled''' - Check to allow the domain sync cron to actually run.
 # '''Sync Next Due Date''' - Enable this setting to update next due date to match the expiry field as part of the sync.
 # '''Domain Sync Notify Only''' - Enable this to allow WHMCS to run the sync checks and report any inconsistencies. But, no changes to the domains will occur. With this enabled you receive an email report listing any discrepancies between the registrar and WHMCS.
@@ Line 282: / Line 282: @@
 </source>
-The key value of the array is what get’s displayed to admins/clients on the button or menu options for the commands. And the value is the custom function name excluding the modulename_ prefix.
+The key value of the array is what is displayed to admins/clients on the button or menu options for the commands. And the value is the custom function name excluding the modulename_ prefix.
 If you want to provide clients with a custom button or way to invoke a function, then this can be done as follows within a .tpl file described in the previous Client Area Output section:
@@ Line 295: / Line 295: @@
 ==Hooks==
-Registrar modules can now also define hook functions. The hooks can take effect system wide and allow registrar modules to integrate deeper into WHMCS more than ever before. For example you could have certain extra actions occurring when specific events occur in WHMCS. Or, use them to define a Widget for use on the admin homepage to provide extra registrar specific functionality to the WHMCS admins.
+Registrar modules can now also define hook functions. The hooks can take effect system wide and allow registrar modules to integrate deeper into WHMCS more than ever before. For example you could have certain extra actions occurring when specific events occur in WHMCS. Or use them to define a Widget for use on the admin homepage to provide extra registrar specific functionality to the WHMCS admins.
-Hooks that the module define are within the “hooks.php” file of the custom registrar module folder. This will then be detected and any hooks loaded on every page of WHMCS.
+Hooks that the module define are within the “hooks.php” file of the custom registrar module folder. These hooks will then be detected and loaded on every page of WHMCS.
 The hook functions within that file should be defined in exactly the same way as normal.

← Older revision		Revision as of 13:08, 23 December 2015
Line 1:		Line 1:
−	Registrar Modules allow for the registration and management of domains within WHMCS.	+	'''Registrar Modules''' allow for the registration and management of domains within WHMCS.

	Registrar Modules are also referred to as '''Domain Modules'''.		Registrar Modules are also referred to as '''Domain Modules'''.

← Older revision		Revision as of 20:54, 27 March 2015
Line 298:		Line 298:

	http://docs.whmcs.com/Provisioning_Module_Developer_Docs#Module_Logging		http://docs.whmcs.com/Provisioning_Module_Developer_Docs#Module_Logging
		+
		+	==App Store==
		+	WHMCS offers an app store to which your completed module can be submitted. The listings are displayed under the Addons tab within the administration area and online at http://www.whmcs.com/appstore . This is a great way to make WHMCS users aware of your module.
		+
		+	In order to submit a listing you'll need a login for whmcs.com/members, if you do not have one please [https://www.whmcs.com/members/submitticket.php?step=2&deptid=5 Contact Us]. Once logged in, visit the app store page at the above URL and click the "Submit your Addon" link. We aim to review submissions in 1-2 weeks.


	{{Developer_Links}}		{{Developer_Links}}