Registrar Module
The following hooks are provided for Registrar Module related events.
AfterRegistrarGetContactDetails
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarGetContactDetails', 1, function($vars)
{
});
AfterRegistrarGetDNS
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarGetDNS', 1, function($vars)
{
});
AfterRegistrarGetEPPCode
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarGetEPPCode', 1, function($vars)
{
});
AfterRegistrarGetNameservers
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarGetNameservers', 1, function($vars)
{
});
AfterRegistrarRegister
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarRegister', 1, function($vars)
{
});
AfterRegistrarRegistration
Executes upon completion of the registrar module function via Cron Command. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarRegistration', 1, function($vars)
{
});
AfterRegistrarRegistrationFailed
Executes after a failed registrar module function via Cron Command. Will execute regardless of failed state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarRegistrationFailed', 1, function($vars)
{
});
AfterRegistrarRenew
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarRenew', 1, function($vars)
{
});
AfterRegistrarRenewal
Executes upon completion of the registrar module function via Cron Command. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarRenewal', 1, function($vars)
{
});
AfterRegistrarRenewalFailed
Executes after failed of the registrar module function via Cron Command.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarRenewalFailed', 1, function($vars)
{
});
AfterRegistrarRequestDelete
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarRequestDelete', 1, function($vars)
{
});
AfterRegistrarSaveContactDetails
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarSaveContactDetails', 1, function($vars)
{
});
AfterRegistrarSaveNameservers
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarSaveNameservers', 1, function($vars)
{
});
AfterRegistrarTransfer
Executes upon completion of the registrar module function. Will execute regardless of success state.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarTransfer', 1, function($vars)
{
});
AfterRegistrarTransferFailed
Executes after a failed domain transfer via Cron command.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Modules Parameters |
| response | array | An array of results returned from the registrar function call |
Response
No Response Supported.
Example Code
<?php
add_hook('AfterRegistrarTransferFailed', 1, function($vars)
{
});
PreRegistrarGetContactDetails
Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Module Parameters |
| response | array | Module action response have status and message |
Response
Accepts a return of key/value pairs to override the parameters to be used in action aborting. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreRegistrarGetContactDetails', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreRegistrarGetEPPCode
Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Module Parameters |
| response | array | Module action response have status and message |
Response
Accepts a return of key/value pairs to override the parameters to be used in action aborting. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreRegistrarGetEPPCode', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreRegistrarGetNameservers
Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Module Parameters |
| response | array | Module action response have status and message |
Response
Accepts a return of key/value pairs to override the parameters to be used in action aborting. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreRegistrarGetNameservers', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreRegistrarRequestDelete
Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Module Parameters |
| response | array | Module action response have status and message |
Response
Accepts a return of key/value pairs to override the parameters to be used in action aborting. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreRegistrarRequestDelete', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreRegistrarSaveContactDetails
Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Module Parameters |
| response | array | Module action response have status and message |
Response
Accepts a return of key/value pairs to override the parameters to be used in action aborting. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreRegistrarSaveContactDetails', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreRegistrarSaveDNS
Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Module Parameters |
| response | array | Module action response have status and message |
Response
Accepts a return of key/value pairs to override the parameters to be used in action aborting. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreRegistrarSaveDNS', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreRegistrarSaveNameservers
Executes prior to the registrar function being executed for a domain. Allows the action to be aborted.
Parameters
| Variable | Type | Notes |
|---|---|---|
| params | array | Array of common module parameters. See View Module Parameters |
| response | array | Module action response have status and message |
Response
Accepts a return of key/value pairs to override the parameters to be used in action aborting. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreRegistrarSaveNameservers', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});