Everything Else

The following hooks are provided for Everything Else related events.

AffiliateActivation

Executes as an affiliate is being activated.

Parameters

Response

No response supported

Example Code

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

AffiliateClickthru

Executes when a user has clicked an affiliate referral link.

Parameters

Response

No response supported

Example Code

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

AffiliateCommission

Executes as affiliate commission is being applied to an affiliate to clear later.

Parameters

Response

Return boolean values to override ‘skipCommission’ or ‘payout’.

Example Code

<?php

//Skip applying the commission for affiliate 2
add_hook('AffiliateCommission', 1, function($vars) {
    $return = [];

    if ($vars['affiliateId'] == 2) {
        $return['skipCommission'] = true;
    }
    return $return;
});


//Ensure commission is applied for affiliate 3
add_hook('AffiliateCommission', 1, function($vars) {
    $return = [];

    if ($vars['affiliateId'] == 3) {
        $return['payout'] = true;
    }
    return $return;
});

AffiliateWithdrawalRequest

Executes when an affiliate withdrawal request is submitted.

Parameters

Response

Use the return to skip creating a ticket. Return a boolean value of skipTicket.

Example Code

<?php

//Do not open a ticket for affiliate 2
add_hook('AffiliateWithdrawalRequest', 1, function($vars) {
    $return = [];
    if ($vars['affiliateId'] == 2) {
        $return['skipTicket'] = true;
    }

    return $return;
});

AfterConfigOptionsUpgrade

Executes after a product configurable options upgrade has been processed

Parameters

Response

No response supported

Example Code

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

CCUpdate

Executes after CC details have been stored for a client or the remote storage functions completed.

Parameters

Response

No response supported

Example Code

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

CalcAffiliateCommission

Executes as the amount of commission is being calculated

Parameters

Response

No response supported

Example Code

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

CustomFieldLoad

Executes when custom fields are being loaded

Parameters

Response

Override the value of the custom field returning the “value” key.

Example Code

<?php

add_hook('CustomFieldLoad', 1, function($vars) {
    return array('value' => 'overridden value',);
});

CustomFieldSave

Executes when custom fields are being saved

Parameters

Response

Override the value of the custom field returning the “value” key.

Example Code

<?php

add_hook('CustomFieldSave', 1, function($vars) {
    return array('value' => 'overridden value',);
});

EmailPreLog

Runs prior to email being logged.

Parameters

Response

Accepts a return of key/value pairs to override the parameters to be logged. Use the same names as the input parameters. Return abortLogging to abort logging of the email.

Example Code

<?php

//Do not log emails for userid 2
add_hook('EmailPreLog', 1, function($vars) {
    $return = [];

    if ($vars['userid'] == 2) {
        $return['abortLogging'] = true;
    }

    return $return;
});

//Override the saved subject of the email for userid 3
add_hook('EmailPreLog', 1, function($vars) {
    $return = [];

    if ($vars['userid'] == 3) {
        $return['subject'] = 'This subject is overridden';
    }

    return $return;
});

EmailPreSend

Runs prior to any templated email being sent.

Parameters

Response

An array of key/value pairs to be made available as additional email template merged fields. To abort the sending, return the key/value pair abortsend=true

Example Code

<?php

add_hook('EmailPreSend', 1, function($vars) {
    $merge_fields = [];
    if (!array_key_exists('my_custom_var', $vars['mergefields'])) {
        $merge_fields['my_custom_var'] = "My Custom Var";
        $merge_fields['my_custom_var2'] = "My Custom Var2";
    }
    if ($vars['messagename'] == 'My Message Name' && $vars['relid'] == 2) {
        //Stop the email from sending a specific message and related id.
        $merge_fields['abortsend'] = true;
    }
    return $merge_fields;
});

EmailTplMergeFields

Executes when editing an email template.

Parameters

Response

an Array of key -> value pairs of merge fields

Example Code

<?php

//Output additional merge fields in the list when editing an email template
add_hook('EmailTplMergeFields', 1, function($vars) {
    $merge_fields = [];
    $merge_fields['my_custom_var'] = "My Custom Var";
    $merge_fields['my_custom_var2'] = "My Custom Var2";
    return $merge_fields;
});

FetchCurrencyExchangeRates

Executes when updating currency exchange rates. All supported automatic update currencies are retured

Parameters

Response

An array of key -> value pairs to define or override additional exchange rates. The rate should be appropriate to the EUR currency.

Example Code

<?php

//Return an exchange rate for the XBT currency
add_hook('FetchCurrencyExchangeRates', 1, function($vars) {
    //Code here to fetch the the current exchange rate relative to EUR

    //Return exchange rate relative to 1 EUR
    return ['XBT' => 927.121,];
});

IntelligentSearch

Executes as the Intelligent Search is being completed

Parameters

Response

An array of additional search results. See example for array structure. A string response was supported in versions prior to WHMCS 7.7.

Example Code

<?php

add_hook('IntelligentSearch', 1, function ($vars) {
    /**
     * This is an example of array return for an Intelligent Search.
     * This format is supported in the blend WHMCS Admin Template.
     * Any template based on blend and updated to WHMCS 7.7+ is also supported.
     */
    $searchResults = array();

    // look for exact matches in client notes field
    $result = \WHMCS\Database\Capsule::table('tblclients')
        ->where('notes', $vars['searchTerm'])
        ->get();

    foreach ($result as $client) {
        $searchResults[] = [
            'title' => $client->firstname . ' ' . $client->lastname, // The title of the search result. This is required.
            'href' => 'clientssummary.php?userid=' . $client->id, // The destination url of the search result. This is required.
            'subTitle' => $client->email, // An optional subtitle for the search result.
            'icon' => 'fal fa-user', // A font-awesome icon for the search result. Defaults to 'fal fa-star' if not defined.
        ];
    }
    return $searchResults;
});

LinkTracker

Executes when a link.php link is being used.

Parameters

Response

No response supported

Example Code

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

LogActivity

Executes after an activity log entry has been created.

Parameters

Response

No response supported

Example Code

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

NotificationPreSend

Executes prior to a notification being sent to allow for additional conditional criteria to be applied and manipulation of the notification message.

Parameters

Response

No response supported

Example Code

<?php

add_hook('NotificationPreSend', 1, function($vars) {

    $eventType = $vars['eventType'];
    $eventName = $vars['eventName'];
    $rule = $vars['rule'];
    $hookParameters = $vars['hookParameters'];
    $notification = $vars['notification'];

    // Perform additional conditional logic and throw the AbortNotification
    // exception to prevent the notification from sending.
    if ($eventType == 'Invoice'
        && $eventName == 'created'
        && (isset($hookParameters['invoiceid'])
            && $hookParameters['invoiceid'] > 1000)
    ) {
        throw new \WHMCS\Notification\Exception\AbortNotification();
    }

    // If allowing the notification to continue, you can manipulate the $notification
    // object using the interface, WHMCS\Notification\Contracts\NotificationInterface.
    $notification->setTitle('Override notification title');
    $notification->setMessage('Override notification message body');

});

PayMethodMigration

Executes when legacy payment details are being migrated.

Parameters

Response

A gateway module name.

Example Code

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

PreEmailSendReduceRecipients

Runs prior to a client email being sent and allows selective removal of CC and BCC recipients.

Parameters

Response

An array with a ‘cc’ and ‘bcc’ list of recipients. Each recipient in those lists should be indexed with the original index hash as provided by $recipients argument. If an empty ‘cc’ or ‘bcc’ list provided, it will remove all ‘cc’ or ‘bcc’ recipients respectively. If the ‘cc’ or ‘bcc’ is omitted in the return, the original list will remain unaltered

Example Code

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

PreUpgradeCheckout

Executes on checkout of an upgrade order, after the price calculation. The upgrade order may have completed already when this hook runs.

Parameters

Response

Return ‘amount’ and/or ‘discount’ key with override price for the upgrade order.

Example Code

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

PremiumPriceOverride

Executes when searching for a premium domain. The return can alter the registration & renewal costs, stop the domain being available for purchase or force the client to contact support.

Parameters

Response

Accepts returns to override register, transfer or renew pricing. Also boolean values of noSale or contactUs to stop the sale of the domain with different messages

Example Code

<?php

//Stop the Domain Purchase for this Premium Domain
add_hook('PremiumPriceOverride', 1, function($vars) {
    return ['noSale' => true,];
});

//Force the Client to Contact Support to Purchase Domain
add_hook('PremiumPriceOverride', 1, function($vars) {
    return ['contactUs' => true,];
});

//Override the Register and Renew Pricing & Skip Markup Application
add_hook('PremiumPriceOverride', 1, function($vars) {
    return [
        'register' => 150.00,
        'renew' => 200.00,
        'skipMarkup' => true,
    ];
});

PremiumPriceRecalculationOverride

Executes when a premium domain price is being automatically recalculated.

Parameters

Response

This return is accepted to override the renewal price or skip applying markup. E.g. return array(‘renew’ => 50.00, ‘skipMarkup’ => true);

Example Code

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