Ticket

The following hooks are provided for Ticket related events.

Executes when an admin views a support ticket within the admin area.

Returned HTML will be output to the page.

<?php

use WHMCS\Session;
use WHMCS\Ticket\Watchers;

add_hook('AdminAreaViewTicketPage', 1, function($vars) {
    $return = '';
    $adminId = Session::get('adminid');

    $adminWatchingTickets = Watchers::byAdmin($adminId)->pluck('ticket_id')->toArray();

    if (in_array($vars['ticketid'], $adminWatchingTickets)) {
        $return = '<div class="alert alert-info" role="alert">You are watching this ticket</div>';
    }
    return $return;
});

Executes when an admin views a support ticket within the admin area.

Returned HTML will be output to the sidebar.

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

Executes prior to aggregation and output of the support tickets listing page within the admin area.

Returned HTML will be output to the page.

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

Executes on the client area ticket submission page 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.

A key/value pair array of additional template variables to define.

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

Executes on the client area support tickets overview page 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.

A key/value pair array of additional template variables to define.

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

Executes on the client area view ticket page 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.

A key/value pair array of additional template variables to define.

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

Executes prior to looking up knowledgebase article suggestions related to the message body of a ticket. Can be used to override the default knowledgebase lookup. If fewer than 5 results are returned, WHMCS will search the knowldebase and add its own results to the output.

An array of knowledgebase article IDs.

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

Executes when a ticket note is added.

No response supported

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

Executes when a reply is added to a ticket by an admin user.

No response supported

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

Executes when a ticket is closed.

No response supported

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

Executes when a ticket is deleted.

No response supported

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

Executes when a ticket reply is deleted.

No response supported

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

Executes as a ticket department is changed

No response supported

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

Executes as a ticket is flagged

No response supported

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

Executes when tickets are merged into each other.

No response supported

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

Executes when a ticket is opened by an end user.

No response supported

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

Executes when a ticket is opened by an admin user.

No response supported

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

Executes when an end user provides data for a new ticket submission.

A string to be used as a singular Validation Error.

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

Executes when a ticket is being imported via email.

Return skipProcessing=true to abort importing of the given email.

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

Executes when a ticket priority is changed

No response supported

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

Executes when ticket replies are being split into a new ticket.

No response supported

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

Executes as a ticket status is changed manually by an admin.

No response supported

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

Executes when a ticket subject is changed. The 'subject' variable now contains the new subject.

No response supported

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

Executes when a reply is added to a ticket by an end user.

No response supported

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

Invoked when a ticket is imported from email.

Override the global variables $subject and $message to manipulate.

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