Fluent Support Filter Hooks
Overview
Hooks are a way of interacting/modifying specific, pre-defined code.
Filter hooks are used to manipulate data before it is displayed to the user. Fluent Support has a lot of filter hooks that you can use to customize the plugin. You can customize the plugin and can extend the plugin’s functionality by using these hooks.
Available Filter Hooks
There are a lot of filter hooks in Fluent Support core and Fluent Support Pro. Here You can find the proper guidelines, handy code snippets, full code examples and code reference of using all filter hooks.
Fluent Support Core Filters
Ticket Filters
fluent_support_ticket_create_validation_rules
Parameters
- '$rules' (array) Validation rules for ticket
Usage
add_filter('fluent_support/ticket_create_validation_rules', function ($rules) {
// ...do something
return $rules;
}, 10, 1);
Reference
apply_filters('fluent_support/ticket_create_validation_rules', $rules)
This filter is located in fluent-support/app/Http/Requests/TicketRequest.php
fluent_support_ticket_create_validation_messages
Parameters
- '$messages' (array) Validation messages for a ticket
Usage
add_filter('fluent_support/ticket_create_validation_messages', function ($messages) {
// ...do something
return $messages;
}, 10, 1);
Reference
apply_filters('fluent_support/ticket_create_validation_messages', $messages)
This filter is located in fluent-support/app/Http/Requests/TicketRequest.php
fluent_support_customer_ticket_priorities
Parameters
- '$priorities' (array) Customer ticket priority list
Usage
add_filter('fluent_support/customer_ticket_priorities', function ($priorities) {
// ...do something
return $priorities;
}, 10, 1);
Reference
apply_filters('fluent_support/customer_ticket_priorities', [ 'normal' => __('Normal', 'fluent-support'), 'medium' => __('Medium', 'fluent-support'), 'critical' => __('Critical', 'fluent-support') ])
This filter is located in fluent-support/app/Services/Helper.php
fluent_support_admin_ticket_priorities
Parameters
- '$priorities' (array) Admin ticket priority list
Usage
add_filter('fluent_support/admin_ticket_priorities', function ($priorities) {
// ...do something
return $priorities;
}, 10, 1);
Reference
apply_filters('fluent_support/admin_ticket_priorities', [ 'normal' => __('Normal', 'fluent-support'), 'medium' => __('Medium', 'fluent-support'), 'critical' => __('Critical', 'fluent-support') ])
This filter is located in fluent-support/app/Services/Helper.php
fluent_support_ticket_status_groups
Parameters
- '$statusGroups' (array) Ticket status groups
Usage
add_filter('fluent_support/ticket_status_groups', function ($statusGroups) {
// ...do something
return $statusGroups;
}, 10, 1);
Reference
apply_filters('fluent_support/ticket_status_groups', [ 'open' => ['new', 'active'], 'active' => ['active'], 'closed' => ['closed'], 'new' => ['new'], 'all' => [] ])
This filter is located in fluent-support/app/Services/Helper.php
fluent_support_changeable_ticket_statuses
Parameters
- '$ticketStatus' (array) Changeable ticket status groups
Usage
add_filter('fluent_support/changeable_ticket_statuses', function ($ticketStatus) {
// ...do something
return $ticketStatus;
}, 10, 1);
Reference
apply_filters('fluent_support/changeable_ticket_statuses', $ticketStatus)
This filter is located in fluent-support/app/Services/Helper.php
fluent_support_ticket_statuses
Parameters
- '$ticketStatuses' (array) Ticket statuses
Usage
add_filter('fluent_support/ticket_statuses', function ($ticketStatuses) {
// ...do something
return $ticketStatuses;
}, 10, 1);
Reference
apply_filters('fluent_support/ticket_statuses', [ 'new' => __('New', 'fluent-support'), 'active' => __('Active', 'fluent-support'), 'closed' => __('Closed', 'fluent-support'), ])
This filter is located in fluent-support/app/Services/Helper.php
fluent_support_accepted_ticket_mimes
Parameters
- '$mimes' (array) Accepted mimes
Usage
add_filter('fluent_support/accepted_ticket_mimes', function ($mimes) {
// ...do something
return $mimes;
}, 10, 1);
Reference
apply_filters('fluent_support/accepted_ticket_mimes', $mimes)
This filter is located in fluent-support/app/Services/Helper.php
fluent_support_mime_groups
Parameters
- '$mimeGroups' (array) Mime groups
Usage
add_filter('fluent_support/mime_groups', function ($mimeGroups) {
// ...do something
return $mimeGroups;
}, 10, 1);
Reference
apply_filters('fluent_support/mime_groups', $mimeGroups)
This filter is located in fluent-support/app/Services/Helper.php
fluent_support_portal_base_url
Parameters
- '$baseUrl' (string) Portal base url
Usage
add_filter('fluent_support/portal_base_url', function ($baseUrl) {
// ...do something
return $baseUrl;
}, 10, 1);
Reference
apply_filters('fluent_support/portal_base_url', $baseUrl)
This filter is located in fluent-support/app/Services/Helper.php
fluent_support_can_user_add_tags_to_customer
Parameters
- '$canAddTags' (boolean) User can add tags or not permission
Usage
add_filter('fluent_support/can_user_add_tags_to_customer', function ($canAddTags) {
// ...do something
return $canAddTags;
}, 10, 1);
Reference
apply_filters('fluent_support/can_user_add_tags_to_customer', $canAddTags)
This filter is located in fluent-support/app/Models/Ticket.php
fluent_support_custom_field_render
Parameters
- '$value' (string) Custom fields value
- '$scope' (string) Specifies whether it is for admin or public use
Note: $fieldType
represents the type of custom field, whether it is a text field, number field, etc.
Usage
add_filter('fluent_support/custom_field_render_' . $fieldType , function ($value, $scope) {
// ...do something
return $value;
}, 10, 2);
Reference
apply_filters('fluent_support/custom_field_render_' . $fieldType, $value, $scope)
This filter is located in fluent-support/app/Models/Ticket.php
fluent_support_ticket_custom_fields
Parameters
- '$customFields' (array) Custom fields
Usage
add_filter('fluent_support/ticket_custom_fields', function ($customFields) {
// ...do something
return $customFields;
}, 10, 1);
Reference
apply_filters('fluent_support/ticket_custom_fields', [])
This filter is located in fluent-support/app/Models/Ticket.php
fluent_support_disabled_ticket_fields
Parameters
- '$fields' (array) Disable ticket fields
Usage
add_filter('fluent_support/disabled_ticket_fields', function ($fields) {
// ...do something
return $fields;
}, 10, 1);
Reference
apply_filters('fluent_support/disabled_ticket_fields', [])
This filter is located in fluent-support/app/Models/Ticket.php
,fluent-support/app/Http/Controllers/UploaderController.php
,fluent-support/app/Services/CustomerPortalService.php
,fluent-support-pro/app/Hooks/filters.php
fluent_support_create_ticket_data
Parameters
- '$ticketData' (array) Ticket data
- 'customer' (object) Customer data
Usage
add_filter('fluent_support/create_ticket_data', function ($ticketData, $customer) {
// ...do something
return $ticketData;
}, 10, 2);
Reference
apply_filters('fluent_support/create_ticket_data', $ticketData, $customer)
This filter is located in fluent-support/app/Models/Ticket.php
,fluent-support/app/Services/Integrations/CreateTicketAction.php
,fluent-support/app/Services/CustomerPortalService.php
,fluent-support/app/Services/Integrations/FluentForm/FeedIntegration.php
,fluent-support-pro/app/Services/Integrations/FluentEmailPiping/ByMailHandler.php
fluent_support_previous_ticket_widgets_limit
Parameters
- '$limit' (integer) Previous ticket widgets limit
Usage
add_filter('fluent_support/previous_ticket_widgets_limit', function ($limit) {
// ...do something
return $limit;
}, 10, 1);
Reference
apply_filters('fluent_support/previous_ticket_widgets_limit', 10)
This filter is located in fluent-support/app/Models/Ticket.php
fluent_support_fst_menu_url_base
Parameters
- '$urlBase' (string) Fluent support admin url base
Usage
add_filter('fluent_support/fst_menu_url_base', function ($urlBase) {
// ...do something
return $urlBase;
}, 10, 1);
Reference
$urlBase = apply_filters( 'fst_menu_url_base', admin_url('admin.php?page=fluent-support#/') )
This filter is located in fluent-support/app/Services/Tickets/TicketStats.php
fluent_support_fst_quick_links
Parameters
- '$quickLinks' (array) List of quick links
Usage
add_filter('fluent_support/fst_quick_links', function ($quickLinks) {
// ...do something
return $quickLinks;
}, 10, 1);
Reference
apply_filters('fst_quick_links', $quickLinks))
$quickLinks
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating the quick links data such as active tickets, total tickets, etc.
This filter is located in fluent-support/app/Services/Tickets/TicketStats.php
Ticket Response Filters
fluent_support_parse_smartcode_data
Parameters
- '$response' (array) Response of a ticket
- '$customer' (array) Ticket and its associate data
Usage
add_filter('fluent_support/parse_smartcode_data', function ($response, $data) {
// ...do something
return $data;
}, 10, 2);
Reference
apply_filters('fluent_support/parse_smartcode_data', $data['content'], [ 'customer' => $ticket->customer, 'agent' => $person ])
This filter is located in fluent-support/app/Services/Tickets/ResponseService.php
,fluent-support/app/Hooks/Handlers/EmailNotificationHandler.php
fluent_support_reset_waiting_since
Parameters
- '$state' (boolean) The reset waiting since state for a ticket
- '$content' (string) Conversation data
Usage
add_filter('fluent_support/reset_waiting_since', function ($state, $content) {
// ...do something
return state;
}, 10, 2);
Reference
apply_filters('fluent_support/reset_waiting_since', true, $content)
This filter is located in fluent-support/app/Services/Tickets/ResponseService.php
,fluent-support/app/Model/Tickets/Conversation.php
fluent_support_response_content_before_use_anywhere
Parameters
- '$content' (string) Conversation data
Usage
add_filter('fluent_support/response_content_before_use_anywhere', function ($content) {
// ...do something
return $content;
}, 10, 1);
Reference
apply_filters('fluent_support/response_content_before_use_anywhere', $content)
This filter is located in fluent-support/app/Services/Tickets/ResponseService.php
fluent_support_before_creating_any_response
Parameters
- '$response' (array) Response data
- '$ticket' (object) Ticket data
- '$person' (object) Person data
Usage
add_filter('fluent_support/new_' . $person_type . '_' . $convoType, function ($response, $ticket, $person) {
// ...do something
return $response;
}, 10, 3);
Note: $person->person_type
contains the type of a person, whether it be an agent, user, etc., with $convoType
being a dynamically assigned conversation type.
Reference
apply_filters('fluent_support/new_' . $person->person_type . '_' . $convoType, $response, $ticket, $person)
This filter is located in fluent-support/app/Services/Tickets/ResponseService.php
fluent_support_ticket_close_internal_note
Parameters
- '$internalNote' (string) Internal note message
- '$ticket' (object) Ticket data
Usage
add_filter('fluent_support/ticket_close_internal_note', function ($internalNote, $ticket) {
// ...do something
return $internalNote;
}, 10, 2);
Reference
apply_filters('fluent_support/ticket_close_internal_note', $internalNote, $ticket)
This filter is located in fluent-support/app/Services/Tickets/ResponseService.php
Admin Dashboard Filters
fluent_support_admin_menu_position
Parameters
- '$menuPosition' (integer) Value of menu position
Usage
add_filter('fluent_support/admin_menu_position', function ($menuPosition) {
// ...do something
return $menuPosition;
}, 10, 1);
Reference
apply_filters('fluent_support/admin_menu_position', $menuPosition)
This filter is located in fluent-support/app/Hooks/Handlers/Menu.php
fluent_support_base_url
Parameters
- '$baseUrl' (string) base url of fluent support
Usage
add_filter('fluent_support/base_url', function ($baseUrl) {
// ...do something
return $baseUrl;
}, 10, 1);
Reference
apply_filters('fluent_support/base_url', admin_url('admin.php?page=fluent-support#/')
This filter is located in fluent-support/app/Hooks/Handlers/Menu.php
fluent_support_primary_menu_items
Parameters
- '$menuItems' (array) Primary menu items
Usage
add_filter('fluent_support/primary_menu_items', function ($menuItems) {
// ...do something
return $menuItems;
}, 10, 1);
Reference
apply_filters('fluent_support/primary_menu_items', $menuItems)
This filter is located in fluent-support/app/Hooks/Handlers/Menu.php
fluent_support_secondary_menu_items
Parameters
- '$menuItems' (array) Secondary menu items
Usage
add_filter('fluent_support/secondary_menu_items', function ($secondaryItems) {
// ...do something
return $secondaryItems;
}, 10, 1);
Reference
apply_filters('fluent_support/secondary_menu_items', $secondaryItems)
This filter is located in fluent-support/app/Hooks/Handlers/Menu.php
fluent_support_integration_drivers
Parameters
- '$integrationDrivers' (array) Integration driver data
Usage
add_filter('fluent_support/integration_drivers', function ($integrationDrivers) {
// ...do something
return $integrationDrivers;
}, 10, 1);
Reference
apply_filters('fluent_support/integration_drivers', $integrationDrivers)
This filter is located in fluent-support/app/Hooks/Handlers/Menu.php
fluent_support_app_vars
Parameters
- '$appVars' (array) Admin portal localize data
Usage
add_filter('fluent_support_app_vars', function ($appVars) {
// ...do something
return $appVars;
}, 10, 1);
Reference
apply_filters('fluent_support_app_vars', $appVars)
$appVars
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating the localized data in the admin portal.
This filter is located in fluent-support/app/Hooks/Handlers/Menu.php
fluent_support_ticket_custom_fields
Parameters
- '$fields' (array) ticket custom fields
Usage
add_filter('fluent_support/ticket_custom_fields', function ($fields) {
// ...do something
return $fields;
}, 10, 1);
Reference
apply_filters('fluent_support/ticket_custom_fields', [])
This filter is located in fluent-support/app/Hooks/Handlers/Menu.php
,fluent-support/app/Models/Ticket.php
,fluent-support/app/Services/Integrations/FluentForm/FeedIntegration.php
,
fluent_support_dashboard_notice
Parameters
- '$dashboardNotice' (array) ticket custom fields
- '$agent' (object) Agent data
Usage
add_filter('fluent_support/dashboard_notice', function ($dashboardNotice, $agent) {
// ...do something
return $dashboardNotice;
}, 10, 2);
Reference
apply_filters('fluent_support/dashboard_notice', '', $agent)
This filter is located in fluent-support/app/Http/Controllers/AgentController.php
,fluent-support-pro/app/Hooks/filters.php
fluent_support_agent_has_access
Parameters
- '$status' (boolean) Information about whether an agent has access or not
- '$request' (object) Fluent support framework request
Usage
add_filter('fluent_support/agent_has_access', function ($status, $request) {
// ...do something
return $status;
}, 10, 2);
Reference
apply_filters('fluent_support/agent_has_access', $status, $request)
This filter is located in fluent-support/app/Http/Policies/AgentTicketPolicy.php
,
Frontend Filters
fluent_support_customer_portal_invalid_permission_message
Parameters
- '$message' (string) Invalid permission message
Usage
add_filter('fluent_support/customer_portal_invalid_permission_message', function ($message) {
// ...do something
return $message;
}, 10, 1);
Reference
apply_filters( 'fluent_support/customer_portal_invalid_permission_message', esc_html__('You don\'t have permission to access customer support portal', 'fluent-support') )
This filter is located in fluent-support/app/Hooks/Handlers/CustomerPortalHandler.php
fluent_support_agent_permission_error_message
Parameters
- '$message' (string) Agent permission error message
Usage
add_filter('fluent_support/customer_portal_agent_permission_error_message', function ($message) {
// ...do something
return $message;
}, 10, 1);
Reference
apply_filters('fluent_support/customer_portal_agent_permission_error_message',$msg)
This filter is located in fluent-support/app/Hooks/Handlers/CustomerPortalHandler.php
fluent_support_user_portal_access_config
Parameters
- '$config' (array) Customer portal access settings data
Usage
add_filter('fluent_support/user_portal_access_config', function ($config) {
// ...do something
return $config;
}, 10, 1);
Reference
apply_filters('fluent_support/user_portal_access_config', [ 'status' => true, 'message' => $invalidPermissionMessage ])
This filter is located in fluent-support/app/Hooks/Handlers/CustomerPortalHandler.php
,fluent-support/app/Http/Policies/PortalPolicy.php
fluent_support_customer_portal_vars
Parameters
- '$vars' (array) Customer portal localize data
Usage
add_filter('fluent_support/customer_portal_vars', function ($vars) {
// ...do something
return $vars;
}, 10, 1);
Reference
apply_filters('fluent_support/customer_portal_vars', $vars)
This filter is located in fluent-support/app/Hooks/Handlers/CustomerPortalHandler.php
,fluent-support/app/Services/ProfileInfoService.php
fluent_support_can_customer_create_ticket
Parameters
- '$canCreate' (boolean) Customer can create ticket or not
- '$customer' (object) Customer data
- '$data' (array) Ticket data
Usage
add_filter('fluent_support/can_customer_create_ticket', function ($canCreate, $customer, $data) {
// ...do something
return $vars;
}, 10, 3);
Reference
apply_filters('fluent_support/can_customer_create_ticket', true, $customer, $data)
This filter is located in fluent-support/app/Http/Controllers/CustomerPortalController.php
,fluent-support-pro/app/Services/Integrations/FluentEmailPiping/ByMailHandler.php
fluent_support_can_customer_create_response
Parameters
- '$canCreate' (boolean) Customer can create ticket or not
- '$customer' (object) Customer data
- '$ticket' (object) Ticket data
- '$data' (array) Ticket response data
Usage
add_filter('fluent_support/can_customer_create_response', function ($canCreate, $customer, $ticket, $data) {
// ...do something
return $canCreate;
}, 10, 4);
Reference
apply_filters('fluent_support/can_customer_create_response', true, $ticket->customer, $ticket, $data)
This filter is located in fluent-support/app/Http/Controllers/CustomerPortalController.php
,fluent-support-pro/app/Services/Integrations/FluentEmailPiping/ByMailHandler.php
fluent_support_person_user_edit_url
Parameters
- '$userEditUrl' (string) User profile edit link
- '$instance' (object) Instance of Person class
Usage
add_filter('fluent_support/person_user_edit_url', function ($userEditUrl, $instance) {
// ...do something
return $userEditUrl;
}, 10, 2);
Reference
apply_filters('fluent_support/person_user_edit_url', $userEditUrl, $this)
This filter is located in fluent-support/app/Models/Person.php
fluent_support_customer_extra_widgets
Parameters
- '$widgets' (array) Widgets data
- '$customer' (object) Customer data
Usage
add_filter('fluent_support/customer_extra_widgets', function ($widgets, $customer) {
// ...do something
return $widgets;
}, 10, 2);
Reference
apply_filters('fluent_support/customer_extra_widgets', $widgets, $customer)
This filter is located in fluent-support/app/Models/Person.php
User Authentication Filters
fluent_support_login_form_args
Parameters
- '$loginArgs' (array) Login arguments data
Usage
add_filter('fluent_support/login_form_args', function ($loginArgs) {
// ...do something
return $loginArgs;
}, 10, 1);
Referenceapply_filters('fluent_support/login_form_args', [ 'echo' => false, 'redirect' => $redirect, 'remember' => true, 'value_remember' => true, ])
This filter is located in fluent-support/app/Hooks/Handlers/AuthHandler.php
fluent_support_custom_registration_form_fields_key
Parameters
- '$registrationFieldKeys' (array) List of custom registration form field keys
Usage
add_filter('fluent_support/custom_registration_form_fields_key', function ($registrationFieldKeys) {
// ...do something
return $registrationFieldKeys;
}, 10, 1);
Referenceapply_filters('fluent_support/custom_registration_form_fields_key', Helper::getBusinessSettings('custom_registration_form_field'))
This filter is located in fluent-support/app/Hooks/Handlers/AuthHandler.php
,fluent-support/app/Models/Traits/CustomerTrait.php
,fluent-support/app/Models/Ticket.php
,fluent-support/app/Http/Controllers/AuthController.php
fluent_support_before_registration_form_close
Parameters
- '$content' (string) Form content
- '$registrationFields' (array) Form fields data
- '$attributes' (array) Data associate with the registration form
Usage
add_filter('fluent_support/before_registration_form_close', function ($content, $registrationFields, $attributes) {
// ...do something
return $content;
}, 10, 3);
Referenceapply_filters('fluent_support/before_registration_form_close', '', $registrationFields, $attributes)
This filter is located in fluent-support/app/Hooks/Handlers/AuthHandler.php
,fluent-support/app/Models/Traits/CustomerTrait.php
,fluent-support/app/Models/Ticket.php
,fluent-support/app/Http/Controllers/AuthController.php
fluent_support_registration_form_fields
Parameters
- '$fields' (array) Default registration Form fields
Usage
add_filter('fluent_support/registration_form_fields', function ($fields) {
// ...do something
return $fields;
}, 10, 1);
Referenceapply_filters('fluent_support/registration_form_fields', $fields)
$fields
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating the registration form fields data.
This filter is located in fluent-support/app/Hooks/Handlers/AuthHandler.php
fluent_support_custom_registration_form_fields
Parameters
- '$customFields' (array) Custom registration Form fields
Usage
add_filter('fluent_support/custom_registration_form_fields', function ($customFields) {
// ...do something
return $customFields;
}, 10, 1);
Referenceapply_filters('fluent_support/custom_registration_form_fields', $customFields)
$customFields
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating the custom registration form fields data.
This filter is located in fluent-support/app/Hooks/Handlers/AuthHandler.php
,fluent-support/app/Models/Traits/CustomerTrait.php
fluent_support_reset_password_form
Parameters
- '$field' (array) Reset password form filed
Usage
add_filter('fluent_support/reset_password_form', function ($field) {
// ...do something
return $field;
}, 10, 1);
Referenceapply_filters('fluent_support/reset_password_form', [ 'user_login' => [ 'required' => true, 'type' => 'text', 'label' => __('Email Address', 'fluent-support'), 'id' => 'fst_email', 'placeholder' => __('Your Email Address', 'fluent-support') ] ])
This filter is located in fluent-support/app/Hooks/Handlers/AuthHandler.php
,
fluent_support_signup_loading_icon
Parameters
- '$loadingIcon' (string) Icon data
Usage
add_filter('fluent_support/signup_loading_icon', function ($loadingIcon) {
// ...do something
return $loadingIcon;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_loading_icon', $loadingIcon)
This filter is located in fluent-support/app/Hooks/Handlers/AuthHandler.php
fluent_support_auth_shortcode_defaults
Parameters
- '$shortCodeDefaults' (array) shortcode behavior for agent
Usage
add_filter('fluent_support/auth_shortcode_defaults', function ($shortCodeDefaults) {
// ...do something
return $shortCodeDefaults;
}, 10, 1);
Referenceapply_filters('fluent_support/auth_shortcode_defaults', [ 'auto-redirect' => false, 'redirect-to' => Helper::getPortalBaseUrl(), 'hide' => false, 'show-signup' => false, 'show-reset-password' => false, ])
This filter is located in fluent-support/app/Hooks/Handlers/AuthHandler.php
fluent_support_signup_form_data
Parameters
- '$formData' (array) Signup form data
Usage
add_filter('fluent_support/signup_form_data', function ($formData) {
// ...do something
return $formData;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_form_data', $request->all())
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_signup_create_user_error
Parameters
- '$errorMessage' (array) Create user error message
Usage
add_filter('fluent_support/signup_create_user_error', function ($errorMessage) {
// ...do something
return $errorMessage;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_create_user_error',['error' => $userId->get_error_message()])
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_signup_complete_response
Parameters
- '$data' (array) Success message and redirect url data
Usage
add_filter('fluent_support/signup_complete_response', function ($data) {
// ...do something
return $data;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_complete_response', [ 'message' => __('Successfully registered to the site.', 'fluent-support'), 'redirect' => Arr::get($formData, '__redirect_to', Helper::getPortalBaseUrl()) ])
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_signup_complete_response
Parameters
- '$data' (array) Success message and redirect url data
Usage
add_filter('fluent_support/signup_complete_response', function ($data) {
// ...do something
return $data;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_complete_response', [ 'message' => __('Successfully registered to the site.', 'fluent-support'), 'redirect' => Arr::get($formData, '__redirect_to', Helper::getPortalBaseUrl()) ])
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_use_native_login
Parameters
- '$useNativeLogin' (boolean) Use native login or not
Usage
add_filter('fluent_support_use_native_login', function ($useNativeLogin) {
// ...do something
return $useNativeLogin;
}, 10, 1);
Referenceapply_filters('fluent_support_use_native_login', true)
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_signup_validation_rules
Parameters
- '$rules' (array) signup validation rules data
Usage
add_filter('fluent_support/signup_validation_rules', function ($rules) {
// ...do something
return $rules;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_validation_rules', $rules)
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_reset_password_mail_subject
Parameters
- '$subject' (string) reset password mail subject data
Usage
add_filter('fluent_support/reset_password_mail_subject', function ($subject) {
// ...do something
return $subject;
}, 10, 1);
Referenceapply_filters("fluent_support/reset_password_mail_subject", sprintf(__('Reset your password for %s support portal', 'fluent-support'), get_bloginfo('name')))
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_reset_password_message
Parameters
- '$message' (string) Reset password email body text
- '$user_data' (object) User data
- '$resetLink' (string) Reset link data Usage
add_filter('fluent_support/reset_password_message', function ($message, $user_data, $resetLink) {
// ...do something
return $message;
}, 10, 3);
Referenceapply_filters('fluent_support/reset_password_message', $message, $user_data, $resetLink)
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_signup_validation_messages
Parameters
- '$arg' (array) An array containing the arguments data for signup validation
- '$rules' (array) An array representing the rules for signup validation
Usage
add_filter('fluent_support/signup_validation_messages', function ($arg, $rules) {
// ...do something
return $rules;
}, 10, 2);
Referenceapply_filters('fluent_support/signup_validation_messages', [], $rules)
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_signup_email
Parameters
- '$email' (string) Email address used for signup
Usage
add_filter('fluent_support/signup_email', function ($email) {
// ...do something
return $email;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_email', Arr::get($formData, 'email'))
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_signup_username
Parameters
- '$userName' (string) user name used for signup
Usage
add_filter('fluent_support/signup_username', function ($userName) {
// ...do something
return $userName;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_username', Arr::get($formData, 'username'))
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_signup_password
Parameters
- '$password' (string) Password used for signup
Usage
add_filter('fluent_support/signup_password', function ($password) {
// ...do something
return $password;
}, 10, 1);
Referenceapply_filters('fluent_support/signup_password', $password)
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_update_user_data
Parameters
- '$data' (array) User data
Usage
add_filter('fluent_support/update_user_data', function ($data) {
// ...do something
return $data;
}, 10, 1);
Referenceapply_filters('fluent_support/update_user_data', $data)
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
fluent_support_user_role
Parameters
- '$setRole' (string) User role
Usage
add_filter('fluent_support/user_role', function ($setRole) {
// ...do something
return $setRole;
}, 10, 1);
Referenceapply_filters('fluent_support/user_role', 'subscriber')
This filter is located in fluent-support/app/Http/Controllers/AuthController.php
Email Notification Filters
fluent_support_mail_to_customer_header
Parameters
- '$headers' (array) Mailbox header data
- '$data' (array) CC email list and hook type data
Usage
add_filter('fluent_support/mail_to_customer_header', function ($headers, $data) {
// ...do something
return $headers;
}, 10, 2);
Reference
apply_filters('fluent_support/mail_to_customer_header', $headers, [ 'cc_email' => $ticket->getSettingsValue('cc_email', []), 'hook_type' => 'ticket_created_email_to_customer' ])
This filter is located in fluent-support/app/Hooks/Handlers/EmailNotificationHandler.php
fluent_support_email_footer_credit
Parameters
- '$message' (string) email footer data
Usage
add_filter('fluent_support/email_footer_credit', function ($message) {
// ...do something
return $message;
}, 10, 1);
Reference
apply_filters('fluent_support/email_footer_credit', $message)
$message
is used here as an illustrative variable to represent the raw string value found in the main filter, demonstrating the email footer data.
This filter is located in fluent-support/app/Hooks/Handlers/EmailNotificationHandler.php
fluent_support_email_setting_keys
Parameters
- '$emailSettingsKey' (array) email settings key data
Usage
add_filter('fluent_support/email_setting_keys', function ($emailSettingsKey) {
// ...do something
return $emailSettingsKey;
}, 10, 1);
Reference
apply_filters('fluent_support/email_setting_keys', $emailSettingsKey )
$emailSettingsKey
is used here as an illustrative variable to represent the raw string value found in the main filter, demonstrating the mail settings key data.
This filter is located in fluent-support/app/Services/EmailNotification/Settings.php
Fluent Support Pro Filters
fluent_support_file_storage_integration_settings
Parameters
- '$settings' (array) File storage integration settings data
Usage
add_filter('fluent_support/file_storage_integration_settings_' . $settingsKey, function ($settings) {
// ...do something
return $settings;
}, 10, 1);
Note: $settingsKey
It contains the file upload driver name, such as Dropbox, Google Drive, etc.
Reference
apply_filters('fluent_support_pro/file_storage_integration_settings_' . $settingsKey, [ 'fieldsConfig' => null, 'settings' => null ])
This filter is located in fluent-support-pro/app/Http/Controllers/UploadIntegrationController.php
fluent_support_file_storage_integration_settings_save
Parameters
- '$message' (array) Message related to saving file upload settings
- 'settings' (array) Data for saving file upload settings
Usage
add_filter('fluent_support/file_storage_integration_settings_save_' . $settingsKey,
function($message, $settings) {
// ...do something
return $message;
}, 10, 2);
Note: $settingsKey
It contains the file upload driver name, such as Dropbox, Google Drive, etc.
Reference
apply_filters('fluent_support_pro/file_storage_integration_settings_save_' . $settingsKey, [ 'message' => __('Sorry, upload driver not found') ], $settings)
This filter is located in fluent-support-pro/app/Http/Controllers/UploadIntegrationController.php
fluent_support_search_doc_query
Parameters
- '$search' (string) Search query used for document
Usage
add_filter('fluent_support/search_doc_query', function($search) {
// ...do something
return $search;
}, 10, 1);
Reference
apply_filters('fluent_support/search_doc_query', $search)
This filter is located in fluent-support-pro/app/Http/Controllers/DocSuggestionController.php
fluent_support_search_doc_post_types
Parameters
- '$docsPostType' (array) Document types
Usage
add_filter('fluent_support/search_doc_post_types', function($docsPostType) {
// ...do something
return $docsPostType;
}, 10, 1);
Reference
apply_filters('fluent_support/search_doc_post_types', $ticketConfig['docs_post_types'])
This filter is located in fluent-support-pro/app/Http/Controllers/DocSuggestionController.php
fluent_support_doc_search_args
Parameters
- '$searchArgs' (array) Document search arguments
Usage
add_filter('fluent_support/doc_search_args', function($searchArgs) {
// ...do something
return $searchArgs;
}, 10, 1);
Reference
apply_filters('fluent_support/doc_search_args', [ 'post_type' => $postTypes, 's' => $search, 'numberposts' => $ticketConfig['post_limits'] ])
This filter is located in fluent-support-pro/app/Http/Controllers/DocSuggestionController.php
fluent_support_search_doc_result
Parameters
- '$result' (array) Document search result
Usage
add_filter('fluent_support/search_doc_result', function($result) {
// ...do something
return $result;
}, 10, 1);
Reference
apply_filters('fluent_support/search_doc_result', $result)
This filter is located in fluent-support-pro/app/Http/Controllers/DocSuggestionController.php
fluent_support_email_piping_raw_data
Parameters
- '$data' (array) Payload data
- '$box' (object) Mailbox data
Usage
add_filter('fluent_support/email_piping_raw_data', function($data, $box) {
// ...do something
return $data;
}, 10, 2);
Reference
apply_filters('fluent_support_pro/email_piping_raw_data', $data, $box)
This filter is located in fluent-support-pro/app/Http/Controllers/EmailBoxController.php
fluent_support_email_piping_data
Parameters
- '$formattedData' (array) formatted payload data
- '$data' (array) Payload data
- '$box' (object) Mailbox data
Usage
add_filter('fluent_support/email_piping_data', function($formattedData, $data, $box) {
// ...do something
return $formattedData;
}, 10, 3);
Reference
apply_filters('fluent_support_pro/email_piping_data', $formattedData, $data, $box)
This filter is located in fluent-support-pro/app/Http/Controllers/EmailBoxController.php
fluent_support_all_doc_post_types
Parameters
- '$postTypes' (array) Document post types
Usage
add_filter('fluent_support/all_doc_post_types', function($postTypes) {
// ...do something
return $postTypes;
}, 10, 1);
Reference
apply_filters('fluent_support/all_doc_post_types', get_post_types([ 'public' => true, 'publicly_queryable' => true ]))
This filter is located in fluent-support-pro/app/Http/Controllers/TicketFormController.php
fluent_support_custom_field_types
Parameters
- '$fieldTypes' (array) List of custom field types
Usage
add_filter('fluent_support/custom_field_types', function($fieldTypes) {
// ...do something
return $fieldTypes;
}, 10, 1);
Reference
apply_filters('fluent_support/custom_field_types', $fieldTypes)
$fieldTypes
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating the custom form field types.
This filter is located in fluent-support-pro/app/Services/CustomFieldsService.php
fluent_support_render_custom_field_options
Parameters
- '$publicField' (array) Public field
- '$customer' (object) Customer data
Usage
add_filter('fluent_support/render_custom_field_options_' . $fieldType['type'], function( $publicField, $customer) {
// ...do something
return $publicField;
}, 10, 2);
Note: $fieldType['type']
the type of field, whether it be text,email, user, etc.
Reference
apply_filters('fluent_support/render_custom_field_options_' . $fieldType['type'], $publicField, $customer)
This filter is located in fluent-support-pro/app/Services/CustomFieldsService.php
fluent_support_custom_field_renders_type
Parameters
- '$fieldTypes' (array) Field types
Usage
add_filter('fluent_support/custom_field_renders_type', function( $fieldTypes) {
// ...do something
return $fieldTypes;
}, 10, 1);
Reference
apply_filters('fluent_support/custom_field_renders_type', $fieldTypes)
This filter is located in fluent-support-pro/app/Services/CustomFieldsService.php
fluent_support_ticket_partial_match
Parameters
- '$partialMatch' (boolean) Ticket partially match or not
Usage
add_filter('fluent_support/ticket_partial_match', function( $partialMatch) {
// ...do something
return $partialMatch;
}, 10, 1);
Reference
apply_filters('fluent_support/ticket_partial_match', true)
This filter is located in fluent-support-pro/app/Services/Integrations/FluentEmailPiping/ByMailHandler.php
fluent_support_enable_custom_piping
Parameters
- '$enableCustomPiping' (boolean) Enable custom piping or not
Usage
add_filter('fluent_support/enable_custom_piping', function( $enableCustomPiping) {
// ...do something
return $enableCustomPiping;
}, 10, 1);
Reference
apply_filters('fluent_support/enable_custom_piping', false)
This filter is located in fluent-support-pro/app/Services/Integrations/FluentEmailPiping/ByMailHandler.php
fluent_support_slack_api_data
Parameters
- '$data' (array) Slack Integration Settings data
- '$message' (array) Data for slack message Usage
add_filter('fluent_support/slack_api_data', function($data, $message) {
// ...do something
return $data;
}, 10, 2);
Reference
apply_filters('fluent_support/slack_api_data', $data, $message)
This filter is located in fluent-support-pro/app/Services/Integrations/Slack/SlackApi.php
fluent_support_disable_woo_menu
Parameters
- '$data' (boolean) Disable wooCommerce menu or not
Usage
add_filter('fluent_support/disable_woo_menu', function($data) {
// ...do something
return $data;
}, 10, 1);
Reference
apply_filters('fluent_support/disable_woo_menu', false)
This filter is located in fluent-support-pro/app/Services/Integrations/WooCommerce.php
fluent_support_woo_menu_link_position
Parameters
- '$supportTicketPosition' (boolean) Support page link position in WooCommerce customer menu
Usage
add_filter('fluent_support/woo_menu_link_position', function($supportTicketPosition) {
// ...do something
return $supportTicketPosition;
}, 10, 1);
Reference
apply_filters('fluent_support/woo_menu_link_position', 3)
This filter is located in fluent-support-pro/app/Services/Integrations/WooCommerce.php
fluent_support_woo_menu_label
Parameters
- '$supportLabel' (string) Support page link label in WooCommerce customer menu
Usage
add_filter('fluent_support/woo_menu_label', function($supportLabel) {
// ...do something
return $supportLabel;
}, 10, 1);
Reference
apply_filters('fluent_support/woo_menu_label', $supportLabel)
This filter is located in fluent-support-pro/app/Services/Integrations/WooCommerce.php
fluent_support_advanced_filter_options
Parameters
- '$groups' (array) Advanced filter options data
Usage
add_filter('fluent_support/advanced_filter_options', function($groups) {
// ...do something
return $groups;
}, 10, 1);
Reference
apply_filters('fluent_support/advanced_filter_options', $groups)
This filter is located in fluent-support-pro/app/Services/ProHelper.php
fluent_support_outgoing_webhook_data
Parameters
- '$data' (array) Formatted Ticket data
- '$action' (object) Workflow action data
- '$ticket' (object) Ticket data
Usage
add_filter('fluent_support/outgoing_webhook_data', function($data, $action, $ticket) {
// ...do something
return $groups;
}, 10, 3);
Reference
apply_filters('fluent_support/outgoing_webhook_data', $data, $action, $this->ticket)
This filter is located in fluent-support-pro/app/Services/Workflow/ActionRunner.php
fluent_support_workflow_ticket_created_supported_conditions
Parameters
- '$supportedConditions' (array) Ticket created supported conditions data
Usage
add_filter('fluent_support/workflow_ticket_created_supported_conditions', function($supportedConditions) {
// ...do something
return $supportedConditions;
}, 10, 1);
Reference
apply_filters('fluent_support/workflow_ticket_created_supported_conditions', $supportedConditions)
$supportedConditions
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating the ticket created supported conditions data.
This filter is located in fluent-support-pro/app/Services/Workflow/WorkflowHelper.php
fluent_support_workflow_response_added_by_customer_
Parameters
- '$supportedConditions' (array) Response added by customer supported conditions data
Usage
add_filter('fluent_support/workflow_response_added_by_customer_supported_conditions', function($supportedConditions) {
// ...do something
return $supportedConditions;
}, 10, 1);
Reference
apply_filters('fluent_support/workflow_response_added_by_customer_supported_conditions', $supportedConditions)
$supportedConditions
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating the response added by customer supported conditions data.
This filter is located in fluent-support-pro/app/Services/Workflow/WorkflowHelper.php
fluent_support_workflow_ticket_closed_supported_conditions
Parameters
- '$supportedConditions' (array) Ticket closed supported conditions data
Usage
add_filter('fluent_support/workflow_ticket_closed_supported_conditions', function($supportedConditions) {
// ...do something
return $supportedConditions;
}, 10, 1);
Reference
apply_filters('fluent_support/workflow_ticket_closed_supported_conditions', $supportedConditions)
$supportedConditions
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating the ticket closed supported conditions data.
This filter is located in fluent-support-pro/app/Services/Workflow/WorkflowHelper.php
fluent_support_workflow_conditions
Parameters
- '$conditions' (array) Workflow conditions data
Usage
add_filter('fluent_support/workflow_conditions', function($conditions) {
// ...do something
return $conditions;
}, 10, 1);
Reference
apply_filters('fluent_support/workflow_conditions', $conditions)
This filter is located in fluent-support-pro/app/Services/Workflow/WorkflowHelper.php
fluent_support_workflow_actions
Parameters
- '$actions' (array) Workflow actions data
- '$workFlow' (array) Workflow data
Usage
add_filter('fluent_support/workflow_actions', function($actions, $workFlow) {
// ...do something
return $actions;
}, 10, 2);
Reference
apply_filters('fluent_support/workflow_actions', $actions, $workFlow)
This filter is located in fluent-support-pro/app/Services/Workflow/WorkflowHelper.php
Other Useful Filters
fluent_support_exportable_tickets_data
Parameters
- '$data' (array) Exportable data
- '$tickets' (object) Ticket data
Usage
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
Parameters
- '$data' (array) Exportable data
- '$conversations' (object) Conversation data
Usage
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
Parameters
- '$data' (array) Exportable data
- '$customer' (object) Customer data
Usage
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
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
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
Parameters
- '$drivers' (array) Storage driver information
Usage
add_filter('fluent_support/storage_drivers_info', function ($drivers) {
// ...do something
return $drivers;
}, 10, 1);
Reference
apply_filters('fluent_support/storage_drivers_info', $drivers)
$drivers
is used here as an illustrative variable to represent the raw array value found in the main filter, demonstrating information about Storage drivers, including the local driver, Dropbox driver, etc.
This filter is located in fluent-support/app/Http/Controllers/SettingsController.php
fluent_support_allowed_customer_profile_picture_file_type
Parameters
- '$fileTypes' (array) Customer profile picture file types
Usage
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
Parameters
- '$prefix' (string) File name prefix Usage
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
fluent_support_smartcode_fallback
Parameters
- '$matches' (string) Smartcode data
- '$data' (object) Customer data Usage
add_filter('fluent_support/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
fluent_support_smartcode_fallback_callback
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
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
Parameters
- '$subjects' (array) Email based subjects
Usage
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
Parameters
- '$classMapper' (array) Ticket migration class mapper
Usage
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/Services/Tickets/Importer/MigratorService.php
fluent_support_allow_share_essential
Parameters
- '$allowShareEssential' (boolean) Permission to share essential data or not
Usage
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/Tickets/Importer/MigratorService.php