The following hooks are provided for Registrar Module related events.
Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarGetContactDetails', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarGetDNS', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarGetEPPCode', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarGetNameservers', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarRegister', 1, function($vars) {
// Perform hook code here...
});Executes after a successful domain register command
| Variable | Type | Notes |
|---|---|---|
| params | array | Common domain registrar parameters. See http://developers.whmcs.com/domain-registrars/module-parameters/ |
No response supported
<?php
add_hook('AfterRegistrarRegistration', 1, function($vars) {
// Perform hook code here...
});Executes after a failed domain register command
| Variable | Type | Notes |
|---|---|---|
| params | array | Common domain registrar parameters. See http://developers.whmcs.com/domain-registrars/module-parameters/ |
| error | string |
No response supported
<?php
add_hook('AfterRegistrarRegistrationFailed', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarRenew', 1, function($vars) {
// Perform hook code here...
});Executes after a successful domain renewal command
| Variable | Type | Notes |
|---|---|---|
| params | array | Common domain registrar parameters. See http://developers.whmcs.com/domain-registrars/module-parameters/ |
No response supported
<?php
add_hook('AfterRegistrarRenewal', 1, function($vars) {
// Perform hook code here...
});Executes after a failed domain renewal command
| Variable | Type | Notes |
|---|---|---|
| params | array | Common domain registrar parameters. See http://developers.whmcs.com/domain-registrars/module-parameters/ |
| error | string |
No response supported
<?php
add_hook('AfterRegistrarRenewalFailed', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarRequestDelete', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarSaveContactDetails', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarSaveDNS', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarSaveNameservers', 1, function($vars) {
// Perform hook code here...
});Executes upon completion of the registrar module function. Will execute regardless of success state.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
| results | array | An array of results returned from the registrar function call |
| functionExists | bool | Returns true if the registrar module supports the given action |
| functionSuccessful | bool | Returns true if the registrar function completed without error |
No response supported
<?php
add_hook('AfterRegistrarTransfer', 1, function($vars) {
// Perform hook code here...
});Executes after a failed domain transfer command
| Variable | Type | Notes |
|---|---|---|
| params | array | Common domain registrar parameters. See http://developers.whmcs.com/domain-registrars/module-parameters/ |
| error | string |
No response supported
<?php
add_hook('AfterRegistrarTransferFailed', 1, function($vars) {
// Perform hook code here...
});Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
Accepts an optional array return. Return abortWithSuccess=true to abort the action and treat it as successful. Return abortWithError=Error messages goes here to abort the action and treat it as failed.
<?php
add_hook('PreRegistrarGetContactDetails', 1, function($vars) {
// Perform hook code here...
});Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
Accepts an optional array return. Return abortWithSuccess=true to abort the action and treat it as successful. Return abortWithError=Error messages goes here to abort the action and treat it as failed.
<?php
add_hook('PreRegistrarGetDNS', 1, function($vars) {
// Perform hook code here...
});Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
Accepts an optional array return. Return abortWithSuccess=true to abort the action and treat it as successful. Return abortWithError=Error messages goes here to abort the action and treat it as failed.
<?php
add_hook('PreRegistrarGetEPPCode', 1, function($vars) {
// Perform hook code here...
});Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
Accepts an optional array return. Return abortWithSuccess=true to abort the action and treat it as successful. Return abortWithError=Error messages goes here to abort the action and treat it as failed.
<?php
add_hook('PreRegistrarGetNameservers', 1, function($vars) {
// Perform hook code here...
});Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
Accepts an optional array return. Return abortWithSuccess=true to abort the action and treat it as successful. Return abortWithError=Error messages goes here to abort the action and treat it as failed.
<?php
add_hook('PreRegistrarRequestDelete', 1, function($vars) {
// Perform hook code here...
});Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
Accepts an optional array return. Return abortWithSuccess=true to abort the action and treat it as successful. Return abortWithError=Error messages goes here to abort the action and treat it as failed.
<?php
add_hook('PreRegistrarSaveContactDetails', 1, function($vars) {
// Perform hook code here...
});Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
Accepts an optional array return. Return abortWithSuccess=true to abort the action and treat it as successful. Return abortWithError=Error messages goes here to abort the action and treat it as failed.
<?php
add_hook('PreRegistrarSaveDNS', 1, function($vars) {
// Perform hook code here...
});Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See https://developers.whmcs.com/domain-registrars/module-parameters/ |
Accepts an optional array return. Return abortWithSuccess=true to abort the action and treat it as successful. Return abortWithError=Error messages goes here to abort the action and treat it as failed.
<?php
add_hook('PreRegistrarSaveNameservers', 1, function($vars) {
// Perform hook code here...
});