Fluent Support Developers

fluent_support_exportable_tickets_data

This filter hook allows you to retrieve Exportable data and modify it.

Parameters

'$data' (array) Exportable data
'$tickets' (object) Ticket data

Usage

php

add_filter('fluent_support/exportable_tickets_data', function ($data, $tickets) {
    // ...do something
    return $data;
}, 10, 2);

Reference

apply_filters('fluent_support/exportable_tickets_data', $data, $tickets)

This filter is located in
fluent-support/app/Hooks/Handlers/PrivacyHandler.php

fluent_support_exportable_conversations_data

This filter hook allows you to retrieve Exportable conversation data and modify it.

Parameters

'$data' (array) Exportable data
'$conversations' (object) Conversation data

Usage

php

add_filter('fluent_support/exportable_conversations_data', function ($data, $conversations) {
    // ...do something
    return $data;
}, 10, 2);

Reference

apply_filters('fluent_support/exportable_conversations_data', $data, $conversations)

This filter is located in
fluent-support/app/Hooks/Handlers/PrivacyHandler.php

fluent_support_exportable_customer_data

This filter hook allows you to retrieve exportable customer data and modify it.

Parameters

'$data' (array) Exportable data
'$customer' (object) Customer data

Usage

php

add_filter('fluent_support/exportable_customer_data', function ($data, $customer) {
    // ...do something
    return $data;
}, 10, 2);

Reference

apply_filters('fluent_support/exportable_customer_data', $data, $customer)

This filter is located in
fluent-support/app/Hooks/Handlers/PrivacyHandler.php

fluent_support_recaptcha_v3_ref_score

This filter hook allows you to retrieve reCAPTCHA v3 threshold value data and modify it.

Parameters

'$refScore' (integer) reCAPTCHA v3 threshold value (The score is compared with the reCAPTCHA value provided by Google, which is determined based on interactions with your site )

Usage

php

add_filter('fluent_support/recaptcha_v3_ref_score', function ($refScore) {
    // ...do something
    return $refScore;
}, 10, 1);

Reference

apply_filters('fluent_support/recaptcha_v3_ref_score', 0.5)

This filter is located in
fluent-support/app/Hooks/Handlers/ReCaptchaHandler.php

fluent_support_storage_drivers_info

This filter hook allows you to retrieve storage driver information and modify it.

Parameters

'$drivers' (array) Storage driver information

Usage

php

add_filter('fluent_support/storage_drivers_info', function ($drivers) {
    // ...do something
    return $drivers;
}, 10, 1);

Reference

apply_filters('fluent_support/storage_drivers_info', $drivers)

This filter is located in
fluent-support/app/Services/Storage/StorageManager.php

fluent_support_allowed_customer_profile_picture_file_type

This filter hook allows you to retrieve customer profile picture file types and modify it.

Parameters

'$fileTypes' (array) Customer profile picture file types

Usage

php

add_filter('fluent_support/allowed_customer_profile_picture_file_type', function ($fileTypes) {
    // ...do something
    return $fileTypes;
}, 10, 1);

Reference

apply_filters('fluent_support/allowed_customer_profile_picture_file_type', array('jpeg', 'jpe', 'jpg', 'png'))

This filter is located in
fluent-support/app/Services/AvatarUploder.php

fluent_support_uploaded_file_name_prefix

This filter hook allows you to retrieve file name prefix and modify it.

Parameters

'$prefix' (string) File name prefix Usage

php

add_filter('fluent_support/uploaded_file_name_prefix', function ($prefix) {
    // ...do something
    return $prefix;
}, 10, 1);

Reference

apply_filters('fluent_support/uploaded_file_name_prefix', $prefix)

This filter is located in
fluent-support/app/Services/Includes/FileSystem.php

fluentsupport_smartcode_fallback

This filter hook allows you to retrieve Smartcode data and modify it.

Parameters

'$matches' (string) Smartcode data
'$data' (object) Customer data Usage

php

add_filter('fluentsupport/smartcode_fallback', function ($matches, $data) {
    // ...do something
    return $matches;
}, 10, 2);

Reference

apply_filters('fluentsupport/smartcode_fallback', $matches[0], $data)

This filter is located in
fluent-support/app/Services/Parser/ShortcodeParser.php

fluentsupport_smartcode_fallback_callback

This filter hook allows you to retrieve fallback behavior for smartcodes and modify it.

Parameters

'$matches' (string) Smartcode data
'$valueKey' (string) Key associated with the original value
'$defaultValue' (string) The default value to fall back on if the smartcode cannot be resolved
'$data' (object) Customer data

Usage

php

add_filter('fluentsupport/smartcode_fallback_callback_' . $dataKey, function ($matches, $valueKey, $defaultValue, $data) {
    // ...do something
    return $matches;
}, 10, 4);

Note: $dataKey Unique key or identifier associated with the specific data being processed.

Reference

apply_filters('fluentsupport/smartcode_fallback_callback_' . $dataKey, $matches[0], $valueKey, $defaultValue, $data)

This filter is located in
fluent-support/app/Services/Parser/ShortcodeParser.php

fluent_support_strict_subjects

This filter hook allows you to retrieve the strict subjects and modify it.

Parameters

'$subjects' (array) Email based subjects

Usage

php

add_filter('fluent_support/strict_subjects', function ($subjects) {
    // ...do something
    return $subjects;
}, 10, 1);

Reference

apply_filters('fluent_support/strict_subjects', [ 'ticket_replied_by_agent_email_to_customer', 'ticket_closed_by_agent_email_to_customer', 'ticket_created_email_to_customer' ])

This filter is located in
fluent-support/app/Services/EmailNotification/Settings.php

fluent_support_migrator_class_mapper

This filter hook allows you to retrieve the Ticket migration class mapper data and modify it.

Parameters

'$classMapper' (array) Ticket migration class mapper

Usage

php

add_filter('fluent_support/migrator_class_mapper', function ($classMapper) {
    // ...do something
    return $classMapper;
}, 10, 1);

Reference

apply_filters('fluent_support/migrator_class_mapper', [ 'awesome-support' => 'AwesomeSupportTickets', 'support-candy' => 'SupportCandyTickets', 'js-helpdesk' => 'JSHelpdeskTickets', ])

This filter is located in
fluent-support/app/Modules/TicketImport/Importers/BaseImporter.php

fluent_support_allow_share_essential

This filter hook allows you to retrieve the permission for share essential data and modify it.

Parameters

'$allowShareEssential' (boolean) Permission to share essential data or not

Usage

php

add_filter('fluentsupport_allow_share_essential', function ($allowShareEssential) {
    // ...do something
    return $allowShareEssential;
}, 10, 1);

Reference

apply_filters('fluentsupport_allow_share_essential', Helper::getOption('_share_essential', 'no') == 'yes')

This filter is located in
fluent-support/app/Services/Integrations/Maintenance.php

fluent_support_can_customer_access_portal

This filter hook allows you to control whether a customer is permitted to access the Customer Portal. Return `false` to block access for a specific customer.

Parameters

$canAccess (boolean) Whether access is allowed — default true
$customer (object) The customer object requesting access

Usage

php

add_filter('fluent_support/can_customer_access_portal', function ($canAccess, $customer) {
    // block suspended customers
    if ($customer->status === 'blocked') {
        return false;
    }
    return $canAccess;
}, 10, 2);

Reference

apply_filters('fluent_support/can_customer_access_portal', true, $customer)

This filter is located in
fluent-support/app/Modules/CustomerPortal/PortalController.php

fluent_support_can_customer_access_ticket

This filter hook allows you to control whether a customer can perform a specific action on a ticket in the Customer Portal. Use it to implement custom access rules beyond the default ownership check.

Parameters

$canAccess (boolean) Whether access is allowed — default true
$customer (object) The customer requesting access
$ticket (object) The ticket being accessed
$action (string) The action being attempted, e.g. 'view', 'reply'

Usage

php

add_filter('fluent_support/can_customer_access_ticket', function ($canAccess, $customer, $ticket, $action) {
    // only allow viewing, not replying to closed tickets
    if ($action === 'reply' && $ticket->status === 'closed') {
        return false;
    }
    return $canAccess;
}, 10, 4);

Reference

apply_filters('fluent_support/can_customer_access_ticket', true, $customer, $ticket, $action)

This filter is located in
fluent-support/app/Modules/CustomerPortal/PortalService.php

fluent_support_menu_items

This filter hook allows you to add, remove, or reorder the primary navigation items in the Fluent Support admin menu.

Parameters

$menuItems (array) Array of menu item definitions

Usage

php

add_filter('fluent_support/menu_items', function ($menuItems) {
    $baseUrl = admin_url('admin.php?page=fluent-support#/');
    $menuItems['my_custom_page'] = [
        'key'       => 'my_custom_page',
        'label'     => 'Custom Page',
        'permalink' => $baseUrl . 'custom-page',
    ];
    return $menuItems;
}, 10, 1);

Reference

apply_filters('fluent_support/menu_items', $menuItems)

This filter is located in
fluent-support/app/Hooks/Handlers/Menu.php

fluent_support_settings_menu_items

This filter hook allows you to add, remove, or reorder the items in the Global Settings sidebar menu.

Parameters

$menu (array) Array of settings menu item definitions

Usage

php

add_filter('fluent_support/settings_menu_items', function ($menu) {
    $menu[] = [
        'title'      => 'My Settings',
        'route_name' => 'my_settings',
        'icon'       => 'myIcon',
    ];
    return $menu;
}, 10, 1);

Reference

apply_filters('fluent_support/settings_menu_items', $menu)

This filter is located in
fluent-support/app/Services/Helper.php

fluent_support_portal_admin_base_url

This filter hook allows you to override the base URL used for admin-side ticket links that point into the Customer Portal.

Parameters

$url (string) The default portal base URL

Usage

php

add_filter('fluent_support/portal_admin_base_url', function ($url) {
    return 'https://support.mysite.com/tickets/';
}, 10, 1);

Reference

apply_filters('fluent_support/portal_admin_base_url', $url)

This filter is located in
fluent-support/app/Services/Helper.php

fluent_support_ticket_import_chunk_limit

This filter hook allows you to control how many tickets are processed per chunk during a migration import. Lower values reduce memory usage on constrained servers; higher values speed up large imports.

Parameters

$limit (integer) Number of tickets per import chunk — default 20

Usage

php

add_filter('fluent_support/ticket_import_chunk_limit', function ($limit) {
    return 10; // process fewer tickets at a time on low-memory servers
}, 10, 1);

Reference

apply_filters('fluent_support/ticket_import_chunk_limit', 20)

This filter is located in
fluent-support/app/Modules/TicketImport/Importers/BaseImporter.php

fluent_support_fs_tickets_updated_since

This filter hook allows you to set the earliest date from which tickets are fetched during a migration. Tickets updated before this date are skipped.

Parameters

$date (string) ISO 8601 date string — default '2010-01-19T02:00:00Z'

Usage

php

add_filter('fluent_support/fs_tickets_updated_since', function ($date) {
    return '2023-01-01T00:00:00Z'; // only import tickets updated after Jan 2023
}, 10, 1);

Reference

apply_filters('fluent_support/fs_tickets_updated_since', '2010-01-19T02:00:00Z')

This filter is located in
fluent-support/app/Modules/TicketImport/Importers/BaseImporter.php

fluent_support_truncate_uploaded_file_names

This filter hook allows you to enable automatic truncation of long uploaded file names before they are saved to disk. When enabled, file names exceeding a safe length are shortened to prevent filesystem issues.

Parameters

$truncate (boolean) Whether to truncate file names — default false

Usage

php

add_filter('fluent_support/truncate_uploaded_file_names', function ($truncate) {
    return true;
}, 10, 1);

Reference

apply_filters('fluent_support/truncate_uploaded_file_names', false)

This filter is located in
fluent-support/app/Services/Includes/FileSystem.php

fluent_support_external_attachment_url

This filter hook allows you to override the public URL used to serve a ticket attachment. Use it when attachments are stored on an external service (CDN, S3, etc.) and the default URL needs to be rewritten.

Parameters

$url (string) The attachment's full URL as stored
$attachment (object) The attachment object

Usage

php

add_filter('fluent_support/external_attachment_url', function ($url, $attachment) {
    // rewrite to a signed CDN URL
    return my_cdn_sign($url);
}, 10, 2);

Reference

apply_filters('fluent_support/external_attachment_url', $attachment->full_url, $attachment)

Since 2.4.7: this filter runs only for a storage driver that is not registered through fluent_support/storage_drivers. A registered driver serves files through its own getDownloadUrl().

This filter is located in
fluent-support/app/Services/Storage/StorageManager.php

fluent_support_customer_page_ticket_widgets_limit

This filter hook allows you to control the maximum number of previous tickets shown in the customer profile sidebar widget.

Parameters

$limit (integer) Maximum number of tickets to show — default 20

Usage

php

add_filter('fluent_support/customer_page_ticket_widgets_limit', function ($limit) {
    return 10;
}, 10, 1);

Reference

apply_filters('fluent_support/customer_page_ticket_widgets_limit', 20)

This filter is located in
fluent-support/app/Modules/Customers/CustomerController.php

fluent_support_get_avatar

This filter hook allows you to override the avatar URL generated for a person (agent or customer). By default this is a Gravatar URL with a UI Avatars fallback for people who have no Gravatar.

Parameters

$avatarUrl (string) The default avatar URL
$email (string) The person's email address

Usage

php

add_filter('fluent_support/get_avatar', function ($avatarUrl, $email) {
    return my_custom_avatar_service($email);
}, 10, 2);

Reference

apply_filters('fluent_support/get_avatar', "https://www.gravatar.com/avatar/{$hash}?s=128" . $fallback, $email)

This filter is located in
fluent-support/app/Models/Person.php

fluent_support_pro_upgrade_base_url

This filter hook allows you to override the base URL used for "Upgrade to Pro" links shown throughout the admin UI.

Parameters

$baseUrl (string) The default pricing page URL — default 'https://fluentsupport.com/pricing'

Usage

php

add_filter('fluent_support/pro_upgrade_base_url', function ($baseUrl) {
    return 'https://mysite.com/go/fluent-support-pro';
}, 10, 1);

Reference

apply_filters('fluent_support/pro_upgrade_base_url', 'https://fluentsupport.com/pricing')

This filter is located in
fluent-support/app/Services/Helper.php

fluent_support_attachment_signed_url_ttl

This filter hook allows you to change how long a signed attachment URL stays valid. The expiry is rounded to a TTL boundary so the same URL is reused for a while (browser caching), and it is always at least one full TTL ahead. Values below 5 minutes are raised to 5 minutes.

Signed URLs are used for attachment links in the admin app, the customer portal and MCP tool results.

Parameters

'$ttl' (integer) Lifetime in seconds. Default HOUR_IN_SECONDS (3600)

Usage

php

add_filter('fluent_support/attachment_signed_url_ttl', function ($ttl) {
    return 6 * HOUR_IN_SECONDS;
}, 10, 1);

Reference

apply_filters('fluent_support/attachment_signed_url_ttl', HOUR_IN_SECONDS)

This filter is located in
fluent-support/app/Models/Attachment.php

fluent_support_max_per_page

This filter hook allows you to change the largest page size a paginated list returns. Fluent Support caps `per_page` so one request cannot return a whole table. The default matches the largest size the admin UI offers.

Available since Fluent Support 2.4.7.

Parameters

'$maxPerPage' (integer) Largest allowed page size. Default 150

Usage

php

add_filter('fluent_support/max_per_page', function ($maxPerPage) {
    return 200;
}, 10, 1);

Reference

apply_filters('fluent_support/max_per_page', 150)

This filter is located in
fluent-support/app/Models/Model.php

fluent_support_storage_drivers

This filter hook allows you to register a remote file storage driver. Return an array of objects that implement `FluentSupport\App\Services\Storage\StorageDriverInterface`, keyed by the value the driver writes to `fs_attachments.driver`. `StorageManager` calls a registered driver directly for uploads, deletes, downloads and local copies. Fluent Support Pro registers Amazon S3, Cloudflare R2, S3-compatible, Dropbox and Google Drive this way.

A driver that is not registered here still works through the older per-driver hooks (fluent_support/attachment_uploaded_as_temp_{driver}, fluent_support/finalize_file_upload_{driver}, fluent_support/delete_remote_attachment_{driver} and fluent_support/external_attachment_url).

Available since Fluent Support 2.4.7.

Parameters

'$drivers' (array) Registered drivers, keyed by driver key

Usage

php

add_filter('fluent_support/storage_drivers', function ($drivers) {
    $drivers['my_storage'] = new MyStorageDriver(); // implements StorageDriverInterface
    return $drivers;
}, 10, 1);

The interface methods are getKey(), isConfigured(), upload($attachment, $ticketId), delete($attachment), getDownloadUrl($attachment), stream($attachment), getLocalCopy($attachment, $maxBytes = 0) and getStatus().

Reference

apply_filters('fluent_support/storage_drivers', [])

This filter is located in
fluent-support/app/Services/Storage/StorageManager.php

fluent_support_mail_attachments_max_bytes

This filter hook allows you to change the largest total size of files attached to one email. Files past the limit go out as download links instead of attachments.

Available since Fluent Support 2.4.7.

Parameters

'$maxBytes' (integer) Total size in bytes. Default 10 * MB_IN_BYTES

Usage

php

add_filter('fluent_support/mail_attachments_max_bytes', function ($maxBytes) {
    return 20 * MB_IN_BYTES;
}, 10, 1);

Reference

apply_filters('fluent_support/mail_attachments_max_bytes', 10 * MB_IN_BYTES)

This filter is located in
fluent-support/app/Services/Storage/MailAttachments.php

fluent_support_mail_attachments_fetch_seconds

This filter hook sets the most seconds one request spends fetching remote (cloud storage) files to attach to emails. Files not fetched in time are sent as links instead.

Parameters

'$seconds' (int|float) Time budget in seconds. Default 15; 0 means no limit

Usage

php

add_filter('fluent_support/mail_attachments_fetch_seconds', function ($seconds) {
    // ...do something
    return $seconds;
}, 10, 1);

Reference

apply_filters('fluent_support/mail_attachments_fetch_seconds', 15)

This filter is located in
fluent-support/app/Services/Storage/MailAttachments.php

fluent_support_attachment_email_url_ttl

This filter hook allows you to change how long attachment links in emails and privacy exports stay signed. The link is bound to the ticket hash, so rotating the hash revokes it. After it expires, the link still works for anyone who can see the ticket.

Available since Fluent Support 2.4.7.

Parameters

'$ttl' (integer) Lifetime in seconds. Default 30 * DAY_IN_SECONDS, minimum one day

Usage

php

add_filter('fluent_support/attachment_email_url_ttl', function ($ttl) {
    return 7 * DAY_IN_SECONDS;
}, 10, 1);

Reference

apply_filters('fluent_support/attachment_email_url_ttl', 30 * DAY_IN_SECONDS)

This filter is located in
fluent-support/app/Models/Attachment.php

fluent_support_attachment_login_url

This filter hook allows you to change where a logged-out visitor goes when their attachment link has expired. After login, the visitor returns to the file and the access check lets them in.

Available since Fluent Support 2.4.7.

Parameters

'$loginUrl' (string) Login URL. Default wp_login_url($currentUrl)
'$currentUrl' (string) The attachment URL to return to

Usage

php

add_filter('fluent_support/attachment_login_url', function ($loginUrl, $currentUrl) {
    return add_query_arg('redirect_to', rawurlencode($currentUrl), home_url('/support-login/'));
}, 10, 2);

Reference

apply_filters('fluent_support/attachment_login_url', wp_login_url($currentUrl), $currentUrl)

This filter is located in
fluent-support/app/Hooks/Handlers/ExternalPages.php

fluent_support_attachment_local_copy

This filter hook allows a storage driver that is not registered through `fluent_support/storage_drivers` to supply a local copy of a remote file, so Fluent Support can attach it to an email. Return an absolute path to a temporary file, or `null` when you can't. Fluent Support deletes the file when it is done.

Available since Fluent Support 2.4.7.

Parameters

'$path' (string|null) Default null
'$attachment' (object) Attachment record
'$maxBytes' (integer) Give up when the file is larger than this. 0 means no limit

Usage

php

add_filter('fluent_support/attachment_local_copy', function ($path, $attachment, $maxBytes) {
    if ($attachment->driver !== 'my_storage') {
        return $path;
    }
    return my_storage_download_to_temp($attachment, $maxBytes);
}, 10, 3);

Reference

apply_filters('fluent_support/attachment_local_copy', null, $attachment, $maxBytes)

This filter is located in
fluent-support/app/Services/Storage/StorageManager.php

fluent_support_system_tools_tables

This filter hook allows you to add tables to the System Tools > Database Health page (since 2.4.5). Items without a `name` or `title` are dropped. Create the tables in `fluent_support/system_tools_database_repair` so **Repair** can restore them.

Parameters

'$definitions' (array) Each item: name (without the WordPress prefix), title, optional lazy (bool, created on first use)

Usage

php

add_filter('fluent_support/system_tools_tables', function ($definitions) {
    $definitions[] = ['name' => 'my_addon_logs', 'title' => 'My Add-on Logs'];
    return $definitions;
}, 10, 1);

Reference

apply_filters('fluent_support/system_tools_tables', $definitions)

This filter is located in
fluent-support/app/Modules/SystemTools/DatabaseHealth.php

fluent_support_system_tools_cleanup_types

This filter hook allows you to add log types that the System Tools > Data Cleanup page can count and delete (since 2.4.5). Items missing `key`, `title`, or a callable `count` / `delete` are ignored.

Parameters

'$types' (array) Each item: key, title, count (callable(string $cutoff): int) and delete (callable(string $cutoff, int $limit): int, rows removed, at most $limit)

Usage

php

add_filter('fluent_support/system_tools_cleanup_types', function ($types) {
    // ...do something
    return $types;
}, 10, 1);

Reference

apply_filters('fluent_support/system_tools_cleanup_types', [])

This filter is located in
fluent-support/app/Modules/SystemTools/DataCleanup.php

fluent_support_system_tools_cron_events

This filter hook allows you to add scheduled tasks to the System Tools > Cron Job Monitor page (since 2.4.5). Items without `hook`, `title` or `interval` are dropped.

Parameters

'$jobs' (array) Each item: hook, title, interval (seconds), scheduler (wp_cron by default, or action_scheduler)

Usage

php

add_filter('fluent_support/system_tools_cron_events', function ($jobs) {
    $jobs[] = ['hook' => 'my_addon_hourly', 'title' => 'My Add-on Sync', 'interval' => HOUR_IN_SECONDS];
    return $jobs;
}, 10, 1);

Reference

apply_filters('fluent_support/system_tools_cron_events', $jobs)

This filter is located in
fluent-support/app/Modules/SystemTools/CronMonitor.php