Module
The following hooks are provided for Module related events.
AfterModuleChangePackage
Executes upon successful completion of the module function.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleChangePackage', 1, function($vars)
{
});
AfterModuleChangePackageFailed
Executes upon failure of the module function to complete successfully. The failure reason is provided in the input parameters.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleChangePackageFailed', 1, function($vars)
{
});
AfterModuleChangePassword
Executes upon successful completion of a remote module API password change.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleChangePassword', 1, function($vars)
{
});
AfterModuleChangePasswordFailed
Executes upon failure of the module function to complete successfully. The failure reason is provided in the input parameters.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleChangePasswordFailed', 1, function($vars)
{
});
AfterModuleCreate
Executes upon successful completion of the module function.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleCreate', 1, function($vars)
{
});
AfterModuleCreateFailed
Executes upon failure of the module function to complete successfully. The failure reason is provided in the input parameters.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleCreateFailed', 1, function($vars)
{
});
AfterModuleCustom
Executes upon successful completion of the module custom function.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleCustom', 1, function($vars)
{
});
AfterModuleSuspend
Executes upon successful completion of the module function.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleSuspend', 1, function($vars)
{
});
AfterModuleSuspendFailed
Executes upon failure of the module function to complete successfully. The failure reason is provided in the input parameters.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleSuspendFailed', 1, function($vars)
{
});
AfterModuleTerminate
Executes upon successful completion of the module function.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleTerminate', 1, function($vars)
{
});
AfterModuleTerminateFailed
Executes upon failure of the module function to complete successfully. The failure reason is provided in the input parameters.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleTerminateFailed', 1, function($vars)
{
});
AfterModuleUnsuspend
Executes upon successful completion of the module function.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleUnsuspend', 1, function($vars)
{
});
AfterModuleUnsuspendFailed
Executes upon failure of the module function to complete successfully. The failure reason is provided in the input parameters.
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
No Response Supported.
Example Code
<?php
add_hook('AfterModuleUnsuspendFailed', 1, function($vars)
{
});
PreModuleChangePackage
Executes prior to the module change package function being run for a service. 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 account upgrade or downgrade. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreModuleChangePackage', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreModuleChangePassword
Executes prior to the module change password function being run for a service. 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 account password reset. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreModuleChangePassword', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreModuleCreate
Executes prior to the module create function being run for a service. 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 account creation. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreModuleCreate', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreModuleCustom
Executes prior to the module custom function being run for a service. 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 account creation. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreModuleCustom', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreModuleRenew
Executes prior to the module create function being run for a service. 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 account creation. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreModuleRenew', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreModuleSuspend
Executes prior to the module suspend function being run for a service. 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 account creation. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreModuleSuspend', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreModuleTerminate
Executes prior to the module terminate function being run for a service. 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 account creation. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreModuleTerminate', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});
PreModuleUnsuspend
Executes prior to the module unsuspend function being run for a service. 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 account creation. Use the same names as the input parameters. Return abort=true to abort the action.
Example Code
<?php
add_hook('PreModuleUnsuspend', 1, function($vars)
{
return ['abort'=>true,'message'=>'About action reason'];
});