### LinkTracker Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

A basic example of the LinkTracker hook, which executes when a link.php link is being used. No specific actions are performed in this example.

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


```

--------------------------------

### PayMethodMigration Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

A basic example of the PayMethodMigration hook, which executes when legacy payment details are being migrated. It is expected to return a gateway module name.

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


```

--------------------------------

### LogActivity Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

A basic example of the LogActivity hook, which executes after an activity log entry has been created. No specific actions are performed in this example.

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


```

--------------------------------

### PreUpgradeCheckout Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

This hook is executed during the pre-upgrade checkout process. It allows for custom logic to be performed before the checkout is finalized.

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

```

--------------------------------

### PreUpgradeCheckout Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

This hook executes on checkout of an upgrade order after price calculation. The upgrade order may have already completed when this hook runs.

--------------------------------

### ClientAreaPageUpgrade Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Executes on the client area upgrade/downgrade page. Accepts a return of key/value pairs to be made available as additional Smarty template parameters.

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


```

--------------------------------

### AddonConfig Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes as an addon is being displayed. Use this hook to return an array of key-value pairs to be displayed on the addon configuration page, allowing for custom fields.

```PHP
<?php

add_hook('AddonConfig', 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" />',
    ];
});


```

--------------------------------

### ClientDelete Hook Example (Deprecated)

Source: https://developers.whmcs.com/hooks-reference/client

This hook is deprecated and scheduled for removal. Use the PreDeleteClient hook as a replacement for actions before a client is deleted.

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

```

--------------------------------

### Custom Admin Authentication Logic

Source: https://developers.whmcs.com/hooks-reference/admin-area

Implement custom logic for admin password authentication. This example demonstrates verifying a password against a stored hash.

```php
<?php

// EXAMPLE SERVICE CLASS ONLY; NOT VALID FOR PRODUCTION
class MyAuthService
{
    public static function getAdminHash($adminUniqueId)
    {
        $hashes = [
            'admin@localhost.local' => '$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);
    }
);


```

--------------------------------

### ClientAreaPageHome Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

This hook executes on the client area homepage. It can be used to add or modify Smarty template parameters available on the homepage.

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

```

--------------------------------

### ClientAreaPageSecurity Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Executes on the client area security page. Accepts a return of key/value pairs to be made available as additional Smarty template parameters.

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


```

--------------------------------

### AddonFraud Hook Example

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

This hook is triggered when an addon is marked as fraud. It provides details about the addon, service, and client involved.

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

```

--------------------------------

### ClientAreaPageServerStatus Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Executes on the client area server status page. Accepts a return of key/value pairs to be made available as additional Smarty template parameters.

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


```

--------------------------------

### Register PreDomainTransfer Hook

Source: https://developers.whmcs.com/hooks-reference/domain

Executes before a domain transfer command is processed. This hook is suitable for pre-transfer validation or setup.

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

```

--------------------------------

### ClientAreaPageAddonModule Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Execute custom logic on client pages generated by an addon module using this hook. It accepts key/value pairs for Smarty template parameters.

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


```

--------------------------------

### ClientAdd Hook Example

Source: https://developers.whmcs.com/hooks-reference/client

This hook is triggered when a new client is added to WHMCS. It provides a comprehensive list of client details that can be accessed and manipulated within the hook function.

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

```

--------------------------------

### AddonConfigSave Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes as an addon's configuration is being saved. This hook is used to obtain values defined in the AddonConfig hook point and save them.

```PHP
<?php

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

    //Save the data here
});


```

--------------------------------

### AcceptOrder Hook Example

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

Use this hook to execute custom code when an order is accepted, before any default acceptance actions are performed. It provides the order ID as a parameter.

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

```

--------------------------------

### AddonActivation Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes when a product addon becomes active as part of invoice payment or order acceptance. This hook is useful for triggering actions after provisioning or welcome emails are sent.

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

```

--------------------------------

### ClientAreaPageInvoices Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Implement this hook to run custom logic when the client area invoices page is loaded. It provides access to template variables for customization.

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

```

--------------------------------

### ClientAreaPageKnowledgebase Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Use this hook to execute code when the client area knowledgebase page is accessed. It allows for the modification of template variables available on this page.

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

```

--------------------------------

### ClientAlert Hook Example

Source: https://developers.whmcs.com/hooks-reference/client

Use this hook to define custom client alerts. It receives the client model and should return an Alert object for rendering, allowing for dynamic notifications based on client information.

```php
<?php

use WHMCS\User\Alert;

add_hook('ClientAlert', 1, function($client) {
    $firstName = $client->firstName;
    $lastName = $client->lastName;
    return new Alert(
        "This is a test notification for {$firstName} {$lastName}",
        'info' //see http://getbootstrap.com/components/#alerts
    );
});

```

--------------------------------

### AddonAdd Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes when an addon is added to a product/service. Use this hook to perform custom logic when a new addon is associated with a service.

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

```

--------------------------------

### ClientChangePassword Hook Example

Source: https://developers.whmcs.com/hooks-reference/client

This hook executes whenever a client changes their password. It provides the client's user ID and the new password, allowing for post-change actions or logging.

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

```

--------------------------------

### AfterShoppingCartCheckout Hook Example

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

Use this hook to perform actions after a successful shopping cart checkout, once the order is created, invoice generated, and notifications sent. It provides details of the order, services, addons, domains, and payment.

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

```

--------------------------------

### ClientDetailsValidation Hook Example

Source: https://developers.whmcs.com/hooks-reference/client

Executes before a client is added or updated in the Admin or Client area. It receives all client detail fields and can return a string or array of error messages to prevent the action.

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

```

--------------------------------

### AddonEdit Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes when an addon is modified or updated, excluding status changes. This hook is suitable for logging changes or performing actions when addon details are updated.

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

```

--------------------------------

### ClientAreaPageAddFunds Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

This hook is executed on the client area add funds page. It enables the return of key/value pairs to be made available as additional Smarty template parameters.

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


```

--------------------------------

### Sample ClientAdd Hook in PHP

Source: https://developers.whmcs.com/hooks/sample-hook

This hook function executes when a new client is added. It retrieves client details and includes a placeholder for creating a remote forum account. Register this hook with 'ClientAdd' event and a priority of 1.

```php
<?php

/**
 * Register hook function call.
 *
 * @param string $hookPoint The hook point to call.
 * @param integer $priority The priority for the hook function.
 * @param string|function The function name to call or the anonymous function.
 *
 * @return This depends on the hook function point.
 */

 if (!defined('WHMCS'))
     die('You cannot access this file directly.');

 function create_forum_account($vars) {

     $firstname = $vars['firstname'];
     $lastname = $vars['lastname'];
     $email = $vars['email'];

     // Add the code to create a remote forum account here.

 }

 add_hook('ClientAdd', 1, 'create_forum_account');

?>
```

--------------------------------

### WHMCS PreCronJob Hook

Source: https://developers.whmcs.com/hooks-reference/cron

This hook runs before the daily automation cron job begins its execution. Use it for any setup or checks required before the cron tasks start.

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

```

--------------------------------

### Execute Code After Registrar Get Nameservers

Source: https://developers.whmcs.com/hooks-reference/registrar-module

This hook enables the execution of custom code after the registrar module attempts to retrieve nameserver information. It will execute regardless of the success state of the operation.

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

```

--------------------------------

### Intelligent Search Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

This hook demonstrates how to return custom search results for the Intelligent Search feature, compatible with the blend WHMCS Admin Template. It searches for exact matches in the client notes field.

```php
<?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;
});


```

--------------------------------

### PreModuleUnsuspend Hook Example

Source: https://developers.whmcs.com/hooks-reference/module

Executes prior to the module unsuspend function being run for a service. Allows the action to be aborted. Accepts a return of key/value pairs to override the parameters to be used in account unsuspension. Return `abortcmd=true` to abort the action.

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


```

--------------------------------

### Hook for ClientAreaProductDetails

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

This hook executes when the product details page is loaded in the client area. It provides access to the service object, allowing for checks based on service status before performing custom actions.

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


```

--------------------------------

### CancelOrder Hook Example

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

This hook is executed when a cancellation is requested for an order, before the order status is actually changed. It provides the order ID.

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

```

--------------------------------

### AfterCalculateCartTotals Hook Example

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

Execute custom logic after the shopping cart totals have been calculated. This hook provides the total due today.

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

```

--------------------------------

### ServerAdd Hook

Source: https://developers.whmcs.com/hooks-reference/products-and-services

This hook executes as a server is created. It provides the server ID as a parameter.

```APIDOC
## ServerAdd

### Description
Executes as a server is created

### Parameters
#### Path Parameters
- **serverid** (type: int) - Description: 

### Response
#### Success Response (200)
No response supported

### Example Code
```php
<?php
add_hook('ServerAdd', 1, function($vars) {
    // Perform hook code here...
});

```
```

--------------------------------

### ClientAdd

Source: https://developers.whmcs.com/hooks-reference/client

Executes as a client is being added to WHMCS. It receives various client details.

```APIDOC
## ClientAdd

### Description
Executes as a client is being added to WHMCS.

### Parameters
#### Path Parameters
- **client_id** (int) - Required - The id of the client that has been added
- **user_id** (int) - Required - The user id the client belongs to
- **firstname** (string) - Required - 
- **lastname** (string) - Required - 
- **companyname** (string) - Optional - 
- **email** (string) - Required - 
- **address1** (string) - Required - 
- **address2** (string) - Optional - 
- **city** (string) - Required - 
- **state** (string) - Required - 
- **postcode** (string) - Required - 
- **country** (string) - Required - 
- **phonenumber** (string) - Required - 
- **tax_id** (string) - Optional - 
- **password** (string) - Required - 
- **customFields** (array) - Optional - 
- **taxexempt** (bool) - Optional - 
- **latefeeoveride** (bool) - Optional - 
- **overideduenotices** (bool) - Optional - 
- **separateinvoices** (bool) - Optional - 
- **disableautocc** (bool) - Optional - 
- **emailoptout** (bool) - Optional - 
- **marketing_emails_opt_in** (bool) - Optional - 
- **overrideautoclose** (bool) - Optional - 
- **notes** (string) - Optional - 
- **groupid** (int) - Optional - 

### Response
#### Success Response (200)
No response supported

### Example Code
```php
<?php
add_hook('ClientAdd', 1, function($vars) {
    // Perform hook code here...
});
```
```

--------------------------------

### ClientClose Hook Example

Source: https://developers.whmcs.com/hooks-reference/client

Triggered after a client account has been closed. This hook can be used to perform cleanup tasks or record the closure event.

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

```

--------------------------------

### Hook for ClientAreaProductDetailsPreModuleTemplate

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Execute this hook before the module template is invoked on the product details page. It allows you to define additional template parameters by returning an array.

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


```

--------------------------------

### AddonDeleted Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes when an addon has been deleted. Use this hook to clean up any related data or perform actions after an addon is removed.

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

```

--------------------------------

### ClientAreaProductDetailsOutput

Source: https://developers.whmcs.com/hooks-reference/output

Allows returning of output for display in the client area product details page.

```APIDOC
## ClientAreaProductDetailsOutput

### Description
Allows returning of output for display in the client area product details page.

### Parameters
#### Path Parameters
- **service** (\WHMCS\Service\Service) - A service object representing the service being rendered.

### Response
Return the HTML to be output on the page.

### Request Example
```php
<?php

add_hook('ClientAreaProductDetailsOutput', 1, function($service) {
    if (!is_null($service)) {
        $orderID = $service['service']->orderId;
        return 'OrderID: ' . $orderID;
    }
    return '';
});

```
```

--------------------------------

### AddonCancelled Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes when an addon is cancelled. This hook allows you to run custom code when an addon is no longer active for a service.

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

```

--------------------------------

### Register PreRegistrarGetContactDetails Hook

Source: https://developers.whmcs.com/hooks-reference/registrar-module

This hook executes before the registrar function for getting contact details. It allows aborting the action with success or failure.

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

```

--------------------------------

### LicensingAddonReissue

Source: https://developers.whmcs.com/hooks-reference/addon

Executes as a license is being reissued for an addon. Provides license, service, and addon details.

```APIDOC
## LicensingAddonReissue

### Description
Executes as a license is being reissued.

### Parameters
#### Path Parameters
- **licenseid** (int) - The license ID
- **serviceid** (int) - The service ID
- **addon_id** (int) - The addon ID

### Response
No response supported

### Example Code
```php
<?php
add_hook('LicensingAddonReissue', 1, function($vars) {
    // Perform hook code here...
});
```
```

--------------------------------

### AdminClientFileUpload

Source: https://developers.whmcs.com/hooks-reference/admin-area

Executes as a client file is being uploaded from the Client Summary. It provides parameters related to the file and the client.

```APIDOC
## AdminClientFileUpload

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

### Parameters
#### Path Parameters
- **userid** (int) - Description: 
- **title** (string) - Description: 
- **filename** (string) - Description: The filename as stored on the server
- **origfilename** (string) - Description: The original filename
- **adminonly** (bool) - Description: 

### Response
#### Success Response (200)
No response supported

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

```
```

--------------------------------

### PreDomainTransfer

Source: https://developers.whmcs.com/hooks-reference/domain

Executes before a domain transfer command.

```APIDOC
## PreDomainTransfer

### Description
Executes before a domain transfer command.

### Parameters
#### Path Parameters
- **params** (array) - Required - Common domain registrar parameters. See http://developers.whmcs.com/domain-registrars/module-parameters/

### Response
No response supported

### Example Code
```php
<?php
add_hook('PreDomainTransfer', 1, function($vars) {
    // Perform hook code here...
});
```
```

--------------------------------

### FileDownload Hook

Source: https://developers.whmcs.com/hooks-reference/support-tools

Executes when a file is being downloaded. This hook does not receive any input parameters.

```APIDOC
## FileDownload Hook

### Description
Executes when a file is being downloaded. This hook does not receive any input parameters.

### Parameters
#### Path Parameters
No input parameters for this hook point.

### Response
#### Success Response (200)
No response supported

### Request Example
```php
<?php
add_hook('FileDownload', 1, function($vars) {
    // Perform hook code here...
});

```
```

--------------------------------

### AddonActivated Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes when an addon status is changed to Active. Use this hook to perform actions immediately after an addon becomes active.

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

```

--------------------------------

### UserAdd

Source: https://developers.whmcs.com/hooks-reference/user

Executes as a user is being added to WHMCS.

```APIDOC
## UserAdd

### Description
Executes as a user is being added to WHMCS.

### Parameters
#### Path Parameters
- **user_id** (int) - Required - The id of the user that has been added
- **firstname** (string) - Required - 
- **lastname** (string) - Required - 
- **email** (string) - Required - 
- **password** (string) - Required - 
- **language** (string) - Required - 

### Response
#### Success Response (200)
No response supported

### Request Example
```php
<?php
add_hook('UserAdd', 1, function($vars) {
    // Perform hook code here...
});
```
```

--------------------------------

### ClientAreaPageUnsubscribe Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Executes on the email unsubscribe page. Accepts a return of key/value pairs to be made available as additional Smarty template parameters.

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


```

--------------------------------

### After Module Create Hook

Source: https://developers.whmcs.com/hooks-reference/module

This hook runs after a module successfully creates a new service or product for a client. It provides common module parameters.

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


```

--------------------------------

### Abort Add-On Feature Provisioning

Source: https://developers.whmcs.com/hooks-reference/module

This hook executes before provisioning an Add-On Feature. It allows the action to be aborted by returning 'abortcmd' => true.

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


```

--------------------------------

### Add Predefined Addon with URL Icon

Source: https://developers.whmcs.com/hooks-reference/admin-area

This snippet defines a predefined addon using a URL for the icon. Replace 'yourmodule' with your module name.

```php
<?php
/**
 * 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.',
        ],
    ];
});

```

--------------------------------

### ShoppingCartValidateDomainsConfig

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

Executes when Domain Update is occurring.

```APIDOC
## ShoppingCartValidateDomainsConfig

### Description
Executes when Domain Update is occurring.

### Parameters
#### Path Parameters
- **N/A** (array) - Required - The REQUEST variables

### Response
Return accepts both a `string` or an `array`. Use a string for `single` error message or an `array` of strings for multiple error messages.

### Request Example
```php
add_hook('ShoppingCartValidateDomainsConfig', 1, function($vars) {
    return [
        'Error message feedback error 1',
        'Error message feedback error 2',
    ];
});
```
```

--------------------------------

### ClientAreaPageHome

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Executes on the client area homepage. Accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables.

```APIDOC
## ClientAreaPageHome

### Description
Executes on the client area homepage and accepts a return of key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables. The following is a list of template variables common to all pages. Additional variables will vary depending upon the page being rendered.

### Parameters
#### Path Parameters
- **companyname** (string) - Description: 
- **logo** (string) - Description: 
- **systemurl** (string) - Description: 
- **charset** (string) - Description: 
- **pagetitle** (string) - Description: 
- **filename** (string) - Description: 
- **template** (string) - Description: 
- **language** (string) - Description: 
- **LANG** (array) - Description: Active language translation strings
- **todaysdate** (string) - Description: Human friendly formatted version of todays date
- **date_day** (string) - Description: Current day of the month
- **date_month** (string) - Description: Current month
- **date_year** (string) - Description: Current year
- **WEB_ROOT** (string) - Description: The web path to the WHMCS doc root
- **BASE_PATH_CSS** (string) - Description: 
- **BASE_PATH_JS** (string) - Description: 
- **BASE_PATH_FONTS** (string) - Description: 
- **BASE_PATH_IMG** (string) - Description: 
- **token** (string) - Description: CSRF token value
- **servedOverSsl** (bool) - Description: True if page was loaded via `https://`

### Response
#### Success Response (200)
A key/value pair array of additional template variables to define.

### Request Example
```php
<?php
add_hook('ClientAreaPageHome', 1, function($vars) {
    // Perform hook code here...
});

```
```

--------------------------------

### AfterFraudCheck Hook Example

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

This hook runs after a fraud check is completed for an order. It provides comprehensive details about the order, invoice, client, and fraud check results.

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

```

--------------------------------

### PreUserAdd

Source: https://developers.whmcs.com/hooks-reference/user

Executes just prior to a user being added to WHMCS. Changes to hook variables will not be honored.

```APIDOC
## PreUserAdd

### Description
Executes just prior to a user being added to WHMCS. Changes to hook variables will not be honored.

### Parameters
#### Path Parameters
- **user_id** (int) - Required - The id of the user that has been added
- **firstname** (string) - Required - 
- **lastname** (string) - Required - 
- **email** (string) - Required - 
- **password** (string) - Required - 
- **language** (string) - Required - 

### Response
#### Success Response (200)
No response supported

### Request Example
```php
<?php
add_hook('PreUserAdd', 1, function($vars) {
    // Perform hook code here...
});
```
```

--------------------------------

### PremiumPriceRecalculationOverride Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

This hook executes when a premium domain's price is being automatically recalculated. It allows overriding the renewal price or skipping markup application.

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

```

--------------------------------

### PHP WHMCS Hook: OrderProductPricingOverride

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

Override product pricing in the cart, excluding configurable option costs. Accepts a return array with 'setup' and 'recurring' keys.

```php
<?php

add_hook('OrderProductPricingOverride', 1, function($vars) {
    // Perform operations to determine price.
    return ['setup' => '1.00', 'recurring' => '12.00'];
});


```

--------------------------------

### PreEmailSendReduceRecipients Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

This hook runs before an email is sent, allowing for the selective removal of CC and BCC recipients. It processes recipient lists and can return modified lists.

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


```

--------------------------------

### Execute Code Before Admin Ticket Listing Output

Source: https://developers.whmcs.com/hooks-reference/ticket

This hook runs before the support tickets listing page is aggregated and output in the admin area. It does not accept any input parameters.

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


```

--------------------------------

### Add Hook for ClientAreaPageProductDetails

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Execute custom logic on the client area product overview page using this hook. It supports returning key/value pairs for Smarty template variables.

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

```

--------------------------------

### File Download Hook

Source: https://developers.whmcs.com/hooks-reference/support-tools

Execute custom actions when a file download is initiated. This hook does not receive any input parameters.

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


```

--------------------------------

### AfterClientMerge Hook Example

Source: https://developers.whmcs.com/hooks-reference/client

Use this hook to execute custom code after a client merge operation is successfully completed. It provides the IDs of the client being merged into and the client being merged from.

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

```

--------------------------------

### PreModuleCreate Hook

Source: https://developers.whmcs.com/hooks-reference/module

Executes prior to the module create function being run for a service. Allows the action to be aborted.

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

```

--------------------------------

### AddonRenewal Hook Example

Source: https://developers.whmcs.com/hooks-reference/addon

Executes when a product addon is being automatically renewed as part of an invoice payment. Use this hook to adjust renewal logic or perform related tasks.

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

```

--------------------------------

### ClientAreaPageAffiliates Hook

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Executes on the client area affiliates page. Accepts key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables.

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


```

--------------------------------

### AdminAreaClientSummaryPage

Source: https://developers.whmcs.com/hooks-reference/admin-area

Allows returning of output for display on the client summary page. It accepts a user ID and returns HTML to be displayed.

```APIDOC
## AdminAreaClientSummaryPage

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

### Parameters
#### Path Parameters
- **userid** (int) - Required - The id of the user being displayed

### Response
#### Success Response
Return the HTML to be output on the page.

### Request Example
```php
<?php

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

```
```

--------------------------------

### ClientAreaPageAddContact Hook Example

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Use this hook to execute custom code on the client area add contact page. It allows you to return key/value pairs for Smarty template parameters.

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


```

--------------------------------

### AdminHomepage

Source: https://developers.whmcs.com/hooks-reference/admin-area

Allows returning of output for display on the admin homepage.

```APIDOC
## AdminHomepage

### Description
Allows returning of output for display on the admin homepage

### Parameters
#### Path Parameters
- **No input parameters for this hook point.**

### Response
#### Success Response (200)
Return the HTML to be output on the page.

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

```
```

--------------------------------

### AfterModuleCreate

Source: https://developers.whmcs.com/hooks-reference/module

Executes upon successful completion of the module function for creating a new module. It accepts an array of common module parameters.

```APIDOC
## AfterModuleCreate

### Description
Executes upon successful completion of the module function for creating a new module.

### Parameters
#### Request Body
- **params** (array) - Array of common module parameters. See https://developers.whmcs.com/provisioning-modules/module-parameters/

### Response
No response supported

### Example Code
```php
<?php
add_hook('AfterModuleCreate', 1, function($vars) {
    // Perform hook code here...
});
```
```

--------------------------------

### NotificationPreSend Hook Example

Source: https://developers.whmcs.com/hooks-reference/everything-else

This hook allows conditional logic before a notification is sent and manipulation of the notification message. It demonstrates how to abort a notification based on specific criteria or override its title and message.

```php
<?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');

});


```

--------------------------------

### Add Hook for ClientAreaPageProductsServices

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

This hook runs on the client area's product and services list page. It allows for the definition of additional template variables.

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

```

--------------------------------

### PreModuleChangePackage Hook

Source: https://developers.whmcs.com/hooks-reference/module

Executes prior to the module change package function. Allows the action to be aborted by returning `abortcmd=true`.

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

```

--------------------------------

### ClientAreaPageBulkDomainManagement Hook

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

Executes on the client area bulk domain management page. Accepts key/value pairs to be made available as additional Smarty template parameters. Input parameters include all currently defined template variables.

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


```

--------------------------------

### Adjust Cart Total with Custom Discount

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

Use the CartTotalAdjustment hook to modify the final order total. This example applies a custom discount if a specific product is purchased along with a '.co.uk' domain.

```php
<?php

add_hook('CartTotalAdjustment', 1, function($vars) {
    $cart_adjustments = array();

    $products = $tlds = [];

    foreach ($vars['products'] as $product) {
        $products[] = $product['pid'];
    }

    foreach ($vars['domains'] as $domain) {
        if ($domain['type'] == 'register') {
            $domainParts = explode('.', $domain['domain'], 2);
            $tlds[] = $domainParts[1];
        }
    }

    if (in_array(1, $products) && in_array('co.uk', $tlds)) {
        $cart_adjustments = [
            "description" => "Custom discount for buying product 1 and a co.uk domain",
            "amount" => "-18.00",
            "taxed" => false,
        ];
    }
    return $cart_adjustments;
});


```

--------------------------------

### Add Predefined Addon with Font Awesome Icon

Source: https://developers.whmcs.com/hooks-reference/admin-area

Use this snippet to define a new predefined addon with a Font Awesome icon. Ensure the 'yourmodule' is replaced with your actual module name.

```php
<?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.',
        ],
    ];
});

```

--------------------------------

### Execute Code After Registrar Get DNS

Source: https://developers.whmcs.com/hooks-reference/registrar-module

This hook allows you to run custom logic after the registrar module attempts to retrieve DNS records. It executes irrespective of the operation's success or failure.

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

```

--------------------------------

### Execute Code After Registrar Get Contact Details

Source: https://developers.whmcs.com/hooks-reference/registrar-module

Use this hook to execute custom code after the registrar module attempts to retrieve contact details. It runs regardless of whether the operation was successful.

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

```

--------------------------------

### Create Hook File

Source: https://developers.whmcs.com/hooks/getting-started

Use this command to create a new PHP file for your WHMCS hook in the specified directory. Ensure the file is placed in `/includes/hooks/` or within a module directory.

```bash
touch ~/includes/hooks/helloworld.php
```

--------------------------------

### CartItemsTax Hook Example

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

This hook allows manipulation of tax rates applied to the cart total or checkout payment intents. It provides client data and cart items, and expects modified cart items in return.

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

```

--------------------------------

### AfterModuleTerminate Hook

Source: https://developers.whmcs.com/hooks-reference/module

Executes upon successful completion of the terminate module function. It accepts module parameters.

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

```

--------------------------------

### UserLogin

Source: https://developers.whmcs.com/hooks-reference/authentication

Executes when a user logs in. This hook can be used to perform actions immediately after a user successfully logs into their account.

```APIDOC
## UserLogin

### Description
Executes when a user logs in.

### Parameters
#### Path Parameters
- **user** (\WHMCS\User\User) - 

### Response
No response supported

### Request Example
```php
<?php
add_hook('UserLogin', 1, function($vars) {
    // Perform hook code here...
});

```
```

--------------------------------

### ClientAreaPageDownloads Hook

Source: https://developers.whmcs.com/hooks-reference/client-area-interface

This hook executes on the client area downloads page. Use it to add custom template variables to the downloads page.

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

```

--------------------------------

### PHP WHMCS Hook: OrderAddonPricingOverride

Source: https://developers.whmcs.com/hooks-reference/shopping-cart

Override addon pricing during cart calculation. This hook supports both new product purchases with addons and addon-only purchases for existing services. It returns an array with 'setup' and 'recurring' keys.

```php
<?php

use WHMCS\Service\Service;

add_hook('OrderAddonPricingOverride', 1, function($vars) {
    $return = [];
    if (array_key_exists('proddata', $vars)) {
        /**
         * This is a product and addon purchase
         */
        if ($vars['addonid'] == 1 && $vars['proddata']['pid'] == 1) {
            $return = ['setup' => '1.00', 'recurring' => '5.00',];
        }
    } else {
        /**
         * This is an addon only purchase for existing service
         */
        $serviceData = Service::find($vars['serviceid']);
        if ($serviceData && $vars['addonid'] == 1 && $serviceData->packageId == 1) {
            $return = ['setup' => '1.00', 'recurring' => '5.00',];
        }
    }
    return $return;
});


```

--------------------------------

### Execute Code After Registrar Get EPP Code

Source: https://developers.whmcs.com/hooks-reference/registrar-module

Utilize this hook to execute custom code after the registrar module attempts to retrieve the EPP code for a domain. The hook will run regardless of the operation's success state.

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

```

--------------------------------

### AfterModuleProvisionAddOnFeature Hook

Source: https://developers.whmcs.com/hooks-reference/module

Executes upon successful completion of the provision add-on feature module function. It accepts module parameters.

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

```

--------------------------------

### InvoiceCreation

Source: https://developers.whmcs.com/hooks-reference/invoices-and-quotes

Executes when an invoice is first created. Changes can be made to line items at this point, and invoice totals will be recalculated post execution.

```APIDOC
## InvoiceCreation

### Description
Executes when an invoice is first created. The invoice has not been finalised and delivered to the client at this point. Changes can be made to line items at this point. The invoice totals will be recalculated post execution of this hook point.

### Parameters
#### Path Parameters
- **source** (string) - Required - Indicates where the invoice creation action originated, can be one of `adminarea`, `api` or `autogen`
- **user** (mixed) - Required - User who initiated the invoice creation, either `system` or an admin ID value
- **invoiceid** (int) - Required - The ID of the newly created invoice
- **status** (string) - Required - The status of the newly created invoice

### Response
No response supported

### Example Code
```php
add_hook('InvoiceCreation', 1, function($vars) {
    // Perform hook code here...
});
```
```

--------------------------------

### Prevent Invoicing of New Services

Source: https://developers.whmcs.com/hooks-reference/invoices-and-quotes

Use the PreInvoicingGenerateInvoiceItems hook to modify service billing cycles before invoice generation. This example prevents new services for client ID 5 from being invoiced by setting their billing cycle to 'Free Account'.

```php
<?php

use WHMCS\Service\Service;

/**
 * Prevent invoicing of any new services added to clientID 5
 */

add_hook('PreInvoicingGenerateInvoiceItems', 1, function() {
    $services = Service::where('userid', 5)
        ->where('billingcycle', '!=', 'Free Account')
        ->get();

    foreach ($services as $service) {
        $service->billingcycle = 'Free Account';
        $service->save();
    }
});

```

--------------------------------

### After Module Create Failed Hook

Source: https://developers.whmcs.com/hooks-reference/module

Use this hook when a module fails during the creation of a new service or product. It provides module parameters and the failure reason.

```php
<?php
add_hook('AfterModuleCreateFailed', 1, function($vars)
    {
        // Fetch failure response message & module parameters
        $failureResponseMessage = $vars['failureResponseMessage'];
        $moduleParameters = $vars['params'];

        // Execute your post failure code here
    }
);


```

--------------------------------

### PreModuleUnsuspendAddOnFeature Hook Example

Source: https://developers.whmcs.com/hooks-reference/module

Executes prior to the module unsuspend function being run for an Add-On Feature. Allows the action to be aborted. Accepts a return of key/value pairs to override the parameters to be used in feature unsuspension. Return `abortcmd=true` to abort the action.

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


```