Admin Area

The following hooks are provided for Admin Area related events.

AdminAreaClientSummaryActionLinks

Allows returning of links for display on the client summary page in the Action Links section.

Parameters

Response

An array of links to be displayed.

Example Code

<?php

add_hook('AdminAreaClientSummaryActionLinks', 1, function($vars) {
    $return = [];

    if ($vars['userid'] == 1) {
        $return[] = '<a href="https://www.whmcs.com/">WHMCS</a>';
        $return[] = '<a href="https://www.enom.com/">eNom</a>';
    }

    return $return;
});

AdminAreaClientSummaryPage

Allows returning of output for display on the client summary page.

Parameters

Response

Return the HTML to be output on the page.

Example Code

<?php

add_hook('AdminAreaClientSummaryPage', 1, function($vars) {
    return 'This message will be output on the Client Summary page. I can add HTML here';
});

AdminAreaPage

Runs on every admin area page load. All template variables defined at the time the hook is invoked are made availble to this hook point. This can vary by page. The list below is not an exhaustive list.

Parameters

Response

Accepts a return of key/value pairs to be made available to the template layer as additional template variables.

Example Code

<?php
add_hook('AdminAreaPage', 1, function($vars) {
    $extraVariables = [];
    if ($vars['filename'] == 'index.php') {
        $extraVariables['newVariable1'] = 'thisValue';
        $extraVariables['newVariable2'] = 'thatValue';
    }
    return $extraVariables;
});

AdminAreaViewQuotePage

Executes as the quote is being viewed.

Parameters

Response

Return the HTML to display on the View Quote page.

Example Code

<?php

add_hook('AdminAreaViewQuotePage', 1, function($vars) {
    return 'This will be displayed on the Admin Area View Quote Page. I can add HTML here';
});

AdminClientDomainsTabFields

Executes when a domain is being viewed in the Admin area.

Parameters

Response

An array of key -> value parameters to output additional fields as required.

Example Code

<?php

add_hook('AdminClientDomainsTabFields', 1, function($vars) {
    return [
        'Additional Field 1' => '<input type="text" name="additionalFieldOne" class="form-control input-150" />',
        'Additional Field 2' => '<input type="text" name="additionalFieldTwo" class="form-control input-150" />',
    ];
});

AdminClientDomainsTabFieldsSave

Executes when the Domains tab in the Admin area is being saved. Receives all the $_REQUEST parameters as variables.

Parameters

Response

No response supported

Example Code

<?php

//Obtain the values defined in the AdminClientProfileTabFields hook point and save them as required
add_hook('AdminClientDomainsTabFieldsSave', 1, function($vars) {
    $domainId = $vars['id'];
    $additionalFieldOne = $_REQUEST['additionalFieldOne'];
    $additionalFieldTwo = $_REQUEST['additionalFieldTwo'];

    //Save the data here
});

AdminClientFileUpload

Executes as a client file is being uploaded from the Client Summary.

Parameters

Response

No response supported

Example Code

<?php
add_hook('AdminClientFileUpload', 1, function($vars) {
    // Perform hook code here...
});

AdminClientProfileTabFields

Executes when a client profile is being viewed in the Admin area.

Parameters

Response

An array of key -> value parameters to output additional fields as required.

Example Code

<?php

add_hook('AdminClientProfileTabFields', 1, function($vars) {
    return [
        'Additional Field 1' => '<input type="text" name="additionalFieldOne" class="form-control input-150" />',
        'Additional Field 2' => '<input type="text" name="additionalFieldTwo" class="form-control input-150" />',
    ];
});

AdminClientProfileTabFieldsSave

Executes when the Profile in the Admin area is being saved. Receives all the $_REQUEST parameters as variables.

Parameters

Response

No response supported

Example Code

<?php

//Obtain the values defined in the AdminClientProfileTabFields hook point and save them as required
add_hook('AdminClientProfileTabFieldsSave', 1, function($vars) {
    $userId = $vars['userid'];
    $additionalFieldOne = $_REQUEST['additionalFieldOne'];
    $additionalFieldTwo = $_REQUEST['additionalFieldTwo'];

    //Save the data here
});

AdminClientServicesTabFields

Executes when a service is being viewed in the Admin area.

Parameters

Response

An array of key -> value parameters to output additional fields as required.

Example Code

<?php
add_hook('AdminClientServicesTabFields', 1, function($vars) {
    // Perform hook code here...
});

AdminClientServicesTabFieldsSave

Executes when the Services tab in the Admin area is being saved. Receives all the $_REQUEST parameters as variables.

Parameters

Response

No response supported

Example Code

<?php
add_hook('AdminClientServicesTabFieldsSave', 1, function($vars) {
    // Perform hook code here...
});

AdminHomepage

Allows returning of output for display on the admin homepage

Parameters

Response

Return the HTML to be output on the page.

Example Code

<?php
add_hook('AdminHomepage', 1, function($vars) {
    return 'This message will appear on the Admin Homepage';
});

AdminLogin

Executes post successful authentication of an admin user

Parameters

Response

No response supported

Example Code

<?php
add_hook('AdminLogin', 1, function($vars) {
    // Perform hook code here...
});

AdminLogout

Executes on Admin log out

Parameters

Response

No response supported

Example Code

<?php
add_hook('AdminLogout', 1, function($vars) {
    // Perform hook code here...
});

AdminPredefinedAddons

Executes as the Create New Addon page is loaded.

Parameters

Response

array of values used for the creation of predefined addon panels. See example for array structure.

Example Code

<?php

/**
 * Setting the 'icontype' value to 'fa' allows for the use of Font Awesome icons.
 */
add_hook('AdminPredefinedAddons', 1, function () {
    return [
        [
            'module' => 'yourmodule',
            'icontype' => 'fa',
            'iconvalue' => 'fad fa-cube',
            'labeltype' => 'success',
            'labelvalue' => 'Sample Label',
            'paneltitle' => 'Sample Title',
            'paneldescription' => 'Description to be displayed in the Predefined Addon panel.',
            'addonname' => 'On addon creation, this value will be used as the addon name.',
            'addondescription' => 'On addon creation, this value will be used as the addon description.',
            'welcomeemail' => 'Hosting Account Welcome Email',
            'featureaddon' => 'Name of feature addon as stored in the database.',
        ],
    ];
});

/**
 * Alternatively the 'icontype' value can be set to 'url' to allow for the use of URLs and file paths.
 */
add_hook('AdminPredefinedAddons', 1, function () {
    return [
        [
            'module' => 'yourmodule',
            'icontype' => 'url',
            'iconvalue' => 'https://www.whmcs.com/images/logo.png',
            'paneltitle' => 'Sample Title',
            'paneldescription' => 'Description to be displayed in the Predefined Addon panel.',
            'addonname' => 'On addon creation, this value will be used as the addon name.',
            'addondescription' => 'On addon creation, this value will be used as the addon description.',
            'featureaddon' => 'Name of feature addon as stored in the database.',
        ],
    ];
});

AdminProductConfigFields

Executes as a product is being edited.

Parameters

Response

An array of key -> value pairs to display on the Other tab.

Example Code

<?php
add_hook('AdminProductConfigFields', 1, function($vars) {
    // Perform hook code here...
});

AdminProductConfigFieldsSave

Executes as a product is being saved. Access The Request variables to save custom config fields.

Parameters

Response

No response supported

Example Code

<?php
add_hook('AdminProductConfigFieldsSave', 1, function($vars) {
    // Perform hook code here...
});

AdminServiceEdit

Executes when the Service has been edited by an Admin. After the changes have been made.

Parameters

Response

No response supported

Example Code

<?php
add_hook('AdminServiceEdit', 1, function($vars) {
    // Perform hook code here...
});

AuthAdmin

Executes during Admin form-based password authentication

Parameters

Response

TRUE on success FALSE on failure

Example Code

<?php

// EXAMPLE SERVICE CLASS ONLY; NOT VALID FOR PRODUCTION
class MyAuthService
{
    public static function getAdminHash($adminUniqueId)
    {
        $hashes = [
            '[email protected]' => '$2y$10$VKrc/52lKfl1FZWFTsmUpeORk18adQAulXlv634q6wkMseBDGbilO'
        ];

        if (array_key_exists($adminUniqueId, $hashes)) {
            return $hashes[$adminUniqueId];
        }

        return null;
    }
}

add_hook(
    'AuthAdmin',
    0,
    function ($userInput, WHMCS\User\Admin $admin) {
        $adminUniqueId = $admin->email;
        $adminHash = MyAuthService::getAdminHash($adminUniqueId);
        if (!$adminHash) {
            return false;
        }

        return password_verify($userInput, $adminHash);
    }
);

AuthAdminApi

Parameters

Response

No response supported

Example Code

<?php
add_hook('AuthAdminApi', 1, function($vars) {
    // Perform hook code here...
});

InvoiceCreationAdminArea

Executes as an invoice is being created in the admin area

Parameters

Response

No response supported

Example Code

<?php
add_hook('InvoiceCreationAdminArea', 1, function($vars) {
    // Perform hook code here...
});

PreAdminServiceEdit

Executes as the service is being saved, before any changes have been made.

Parameters

Response

No response supported

Example Code

<?php
add_hook('PreAdminServiceEdit', 1, function($vars) {
    // Perform hook code here...
});

ViewOrderDetailsPage

Executes as the order details page is being displayed

Parameters

Response

No response supported

Example Code

<?php
add_hook('ViewOrderDetailsPage', 1, function($vars) {
    // Perform hook code here...
});