# Fluent Forms Filter Hooks
Fluent Forms Core IntermediateFluent Forms has many interesting filer hooks that let developers change default settings and even extend Fluent Forms with new functionality.
# What are Filter Hooks
A hook is a feature that allows developers to manipulate functionality without modifying core files. A hook can help developers inject some functions or edit default settings.
Filter hooks are used to return modified values for certain parameters, based on different factors.
# Available Filter Hooks
# Submission Filters
# fluentform/insert_response_data
Description
You can modify or format the submitted data using this filter. The returned data will be inserted as submission response.
Parameters
$formData(array) Form Data$formId(int) Form ID$inputConfigs(array) Form Inputs
Usage
add_filter('fluentform/insert_response_data', function ($formData, $formId, $inputConfigs) {
// Do your stuff here
return $formData;
},10, 3);
2
3
4
5
Reference
apply_filters('fluentform/insert_response_data', $formData, $formId, $inputConfigs);
This filter is located in FluentForm\App\Services\Form\SubmissionHandlerService -> prepareInsertData()
# fluentform/find_submission
Description
You can modify a submission by using this filter.
Parameters
$submission(array) Form Submission$formId(int) Form ID
Usage
add_filter('fluentform/find_submission', function ($submission, $formId) {
// Do your stuff here
return $submission;
}, 10, 2);
2
3
4
5
Reference
apply_filters('fluentform/find_submission', $submission, $this->form->id);
This filter is located in FluentForm\App\Services\Submission\SubmissionService -> find($submissionId)
# fluentform/truncate_password_values
You can toggle password truncation before rendering on Submission by using this filter.
Parameters
$isTurncate(boolean) Whether Password is truncated$formId(int) Form ID
Usage
add_filter('fluentform/truncate_password_values', function ($isTruncate, $formId) {
// Do your stuff here
return $isTruncate;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/truncate_password_values', true, $formId)
This filter is located in FluentForm\App\Helpers\Helper -> shouldHidePassword($formId)
# fluentform/entry_statuses_core
You can modify or add more submission statuses by using this filter.
Parameters
statuses(array) statuses$formId(int) Form ID
Usage
add_filter('fluentform/entry_statuses_core', function ($statuses , $form_id) {
// Do your stuff here
$statuses = [
'unread' => 'Unread',
'read' => 'Read'
];
return $statuses;
}, 10, 2);
2
3
4
5
6
7
8
9
10
Reference
apply_filters('fluentform/entry_statuses_core', $data, $form_id);
This filter is located in FluentForm\App\Helpers\Helper -> getEntryStatuses($form_id = false)
# fluentform/reportable_inputs
You can modify or add more inputs for making Submission Report by using this filter.
Parameters
$reportableInputs(array) Reportable Inputs
Usage
add_filter('fluentform/reportable_inputs', function($reportableInputs) {
// Do your stuff here
return $reportableInputs;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/reportable_inputs', $reportableInputs);
This filter is located in FluentForm\App\Helpers\Helper -> getReportableInputs()
# fluentform/subfield_reportable_inputs
You can modify or add more inputs as subfield for making Submission Report by using this filter.
Parameters
$subFieldReportableInputs(array) Reportable Inputs as Subfield
Usage
add_filter('fluentform/subfield_reportable_inputs', function ($subFieldReportableInputs) {
// Do your stuff here
return $subFieldReportableInputs;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/subfield_reportable_inputs', ['tabular_grid']);
This filter is located in FluentForm\App\Helpers\Helper -> getSubFieldReportableInputs()
# fluentform/next_submission
You can modify next or previous submission using this filter.
Parameters
$submission(array) Current Submission$entryId(string) Form Submission ID$attributes(array) Submission attributes
Usage
add_filter('fluentform/next_submission', function ($submission, $entryId, $attributes) {
// Do your stuff here
return $submission;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/next_submission', $submission, $entryId, $attributes);
This filter is located in FluentForm\App\Models\Form -> findAdjacentSubmission($attributes = []) and FluentForm\App\Models\Form -> findPreviousSubmission($attributes = []) and
# fluentform/step_string
This filter returns the input labels for the Submission on the submission page.
Parameters
$stepText(string) Active Step Text
Usage
add_filter('fluentform/step_string', function ($stepText) {
// Do your stuff here
return $stepText;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/step_string', $stepText);
This filter is located in FluentForm\App\Modules\Component\Component -> getEditorShortcodes()
# fluentform/get_raw_responses
This filter returns the raw response of Submission.
Parameters
$responses(array) Response Data$formId(int) Form ID
Usage
add_filter('fluentform/get_raw_responses', function($responses, $formId) {
// Do your stuff here
return $responses;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/get_raw_responses', $response, $formId);
This filter is located in FluentForm\App\Models\Submission -> paginateEntries($attributes = [])
# fluentform/export_data
You can use this filter to modify the exported submission.
Parameters
$data(array) Default Values$form(object) Form Object$exportData(array) Export Data$inputLabels(array) Input Labels
Usage
add_filter('fluentform/export_data', function($data, $form, $exportData, $inputLabels) {
// Do your stuff here
return $data;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/export_data', $data, $form, $exportData, $inputLabels);
This filter is located in FluentForm\App\Services\Submission -> index($args)
# fluentform/insert_response_data
If you want to alter the submitted data you can use this filter. The returned data will be inserted into the submission as response.
Parameters
$formData(array) Entry Response as key-value pair where input name as key and response as value$formId(int) Form ID$inputConfigs(array) Full form inputs fields as 2 dimensional array
Usage
add_filter('fluentform/insert_response_data', function($formData, $formId, $inputConfigs) {
// Do your stuff here
return $formData;
}, 10, 1);
2
3
4
5
6
The following would apply to a specific form with id 5:
add_filter('fluentform/insert_response_data', function($formData, $formId, $inputConfigs) {
// Do your stuff here
if ($formId != 5) {
return $formData;
}
return $formData;
}, 10, 1);
2
3
4
5
6
7
8
9
10
Reference
apply_filters('fluentform/insert_response_data', $formData, $formId, $inputConfigs);
This filter is located in FluentForm\App\Services\Form\SubmissionHandlerService -> prepareInsertData($formData = false)
# fluentform/disable_ip_logging
You can toggle the IP logging of form submission using the the filter.
Parameters
$statusCheck whether IP based logging is enabled$formId(int) Form ID
Usage
add_filter('fluentform/disable_ip_logging', function($status, $formId) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/disable_ip_logging', $disableIpLog, $formId);
This filter is located in FluentForm\App\Services\Form\SubmissionHandlerService -> prepareInsertData($formData = false)
# fluentform/filter_insert_data
This filter is available just before a submission inserted into the database. But If you want to change response data then you should use fluentform_insert_response_data filter hook.
Parameters
$response(array) Submission Data
$response = [
'form_id' => 5, // Form ID
'serial_number' => 1, // Numeric Serial Number
'response' => json_encode($response), // The submitted response as JSON
'source_url' => $source_url, // source url eg: https://domain.com/contact-form
'user_id' => 1, // current user id
'browser' => 'Chrome',
'device' => 'ipad',
'ip' => '127.0.0.1',
'created_at' => '2019-12-31 23:12:34',
'updated_at' => '2019-12-31 23:12:34'
];
2
3
4
5
6
7
8
9
10
11
12
Usage
add_filter('fluentform/filter_insert_data', function($response) {
// Do your stuff here
return $response;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/filter_insert_data', $response);
This filter is located in FluentForm\App\Services\Form\SubmissionHandlerService -> prepareInsertData($formData = false)
# fluentform/max_submission_count
You can define maximum submission count to prevent malicious attack using this filter.
Parameters
$count(int) Form Submission Count$formId(int) Form ID
Usage
The following would apply to a specific form with id 5:
add_filter('fluentform/max_submission_count', function ($count, $formId) {
if ($formId != 5) {
return;
}
// Do your stuff here
return $count;
}, 10, 2);
2
3
4
5
6
7
8
9
Reference
`Reference
apply_filters('fluentform/validation_user_registration_errors', $errors, $formData, $this->form, $fields);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> preventMaliciousAttacks()`
# fluentform/min_submission_interval
You can define minimum submission interval of a form using this Filter.
Parameters
$count(int) Form Submission Interval Count$formId(int) Form ID
Usage
The following would apply to a specific form with id 5:
add_filter('fluentform/min_submission_interval', function($count, $formId) {
if ($formId != 5) {
return;
}
// Do your stuff here
return $count;
}, 10, 2);
2
3
4
5
6
7
8
9
Reference
apply_filters('fluentform/min_submission_interval', 30, $this->form->id);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> preventMaliciousAttacks()
# fluentform/too_many_requests
You can modify validation message for malicious attack prevention, maximum submission count and minimum submission interval using this filter.
Parameters
$message(string) Validation Message$formId(int) Form ID
Usage
add_filter('fluentform/too_many_requests', function($message, $formId) {
// Do your stuff here
return $message;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/too_many_requests', 'Too Many Requests.', $this->form->id), 'fluentform');
This filter is located in FluentForm\App\Services\Form\FormValidationService -> preventMaliciousAttacks()
# fluentform/supported_conditional_fields
You can add or modify form fields as to support as conditional using this filter.
Parameters
$supportedConditionalFields(array) Form Field Names
Usage
add_filter('fluentform/supported_conditional_fields', function ($supportedConditionalFields) {
// Do your stuff here
return $supportedConditionalFields;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/supported_conditional_fields', $supportedConditionalFields);
This filter is located in FluentForm\App\Modules\Form\Inputs -> supportedConditionalFields()
# fluentform/submission_logs
You can modify submission logs of a submission using this Filter.
Parameters
$submissionLogs(array) Submission Logs$submissionId(int) Submission ID
Usage
add_filter('fluentform/submission_logs', function($submissionLogs, $submissionId) {
// Do your stuff here
return $submissionLogs;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_logs', $logs, $submissionId);
This filter is located in FluentForm\App\Services\Logger\Logger -> getSubmissionLogs($submissionId, $attributes = [])
# fluentform/submission_api_logs
You can modify submission API logs or integration logs of a submission using this Filter.
Parameters
$submissionLogs(array) Submission Logs$submissionId(int) Submission ID
Usage
add_filter('fluentform/submission_api_logs', function($submissionLogs, $submissionId) {
// Do your stuff here
return $submissionLogs;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_api_logs', $logs, $submissionId);
This filter is located in FluentForm\App\Services\Logger\Logger -> getSubmissionLogs($submissionId, $attributes = [])
# fluentform/all_logs
You can modify all logs by using this filter.
Parameters
$logs(array) Logs
Usage
add_filter('fluentform/all_logs', function($logs) {
// Do your stuff here
return $logs;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/get_logs', $logs);
This filter is located in FluentForm\App\Services\Logger\Logger -> get($attributes = [])
# fluentform/api_all_logs
You can modify all API logs / integration logs using this filter.
Parameters
$logs(array) Logs
Usage
add_filter('fluentform/api_all_logs', function($logs) {
// Do your stuff here
return $logs;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/api_all_logs', $logs);
This filter is located in FluentForm\App\Modules\Logger\DataLogger -> getApiLogs()
# fluentform/get_log_filters
You can use this filter to modify all the log filters.
Parameters
$filters(array) All Log Filters
Usage
add_filter('fluentform/get_log_filters', function ($filters) {
// Do your stuff here
return $filters;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/get_log_filters', ['statuses' => $statuses, 'components' => $components, 'forms' => $forms]);
This filter is located in FluentForm\App\Services\Logger\Logger -> getFilters($attributes = [])
# fluentform/show_payment_entries
You can toggle status of payment submission to show by using this filter.
Parameters
$status(boolean) Whether the payment entries status is enabled
Usage
add_filter('fluentform/show_payment_entries', function($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/show_payment_entries', false);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> register()
# fluentform/entry_lists_labels
This filter returns the input labels for the Submission on the Submission page.
Parameters
$labels(array) Form Input Labels$form(object) Form Object
Usage
add_filter('fluentform/entry_lists_labels', function ($labels, $form) {
// Do your stuff here
return $labels;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/entry_lists_labels', $labels, $form);
This filter is located in FluentForm\App\Services\Form\FormService -> getInputsAndLabels($formId, $with = ['admin_label', 'raw'])
# fluentform/all_entry_labels
This filter returns the input labels for the Submission on the Submission page.
Parameters
$labels(array) Form Input Labels$formId(int) Form ID
Usage
add_filter('fluentform/all_entry_labels', function ($labels, $formId) {
// Do your stuff here
return $labels;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/all_entry_labels', $labels, $formId);
This filter is located in FluentForm\App\Services\Form\FormService -> getInputsAndLabels($formId, $with = ['admin_label', 'raw'])
# fluentform/all_entry_labels_with_payment
This filter returns the input labels for the payment submission on the submission page.
Parameters
$labels(array) Form Input Labels$isActive(boolean) Whether Payment is active$form(object) Form Object
Usage
add_filter('fluentform/all_entry_labels_with_payment', function ($labels, $isActive, $form) {
// Do your stuff here
return $labels;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/all_entry_labels_with_payment', $labels, false, $form);
This filter is located in FluentForm\App\Services\Form\FormService -> getInputsAndLabels($formId, $with = ['admin_label', 'raw'])
# fluentform/get_logs
You can use this filter to get all the logs.
Parameters
$logs(array) All Logs
Usage
add_filter('fluentform/get_logs', function ($logs) {
// Do your stuff here
return $logs;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/get_logs', $logs);
This filter is located in FluentForm\App\Services\Logger\Logger -> get($attributes = [])
# fluentform/get_log_filters
You can use this filter to modify all the log filters.
Parameters
$filters(array) All Log Filters
Usage
add_filter('fluentform/get_log_filters', function ($filters) {
// Do your stuff here
return $filters;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/get_log_filters', ['statuses' => $statuses, 'components' => $components, 'forms' => $forms]);
This filter is located in FluentForm\App\Services\Logger\Logger -> getFilters($attributes = [])
# fluentform/is_handling_submission
You can use this filter to handle async submission request.
Parameters
$status(boolean) Whether handle submission is enabled
Usage
add_filter('fluentform/is_handling_submission', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/is_handling_submission', $status);
This filter is located in FluentForm\boot\globals.php -> fluentFormIsHandlingSubmission()
# fluentform/entries_vars
You can use this filter to modify entries variables which has been localized.
Parameters
$data(array) Entry Variables$form(object) Form Object
Usage
add_filter('fluentform/entries_vars', function ($data, $form) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
$data = [
'all_forms_url' => admin_url('admin.php?page=fluent_forms'),
'forms' => $forms,
'form_id' => $form->id,
'enabled_auto_delete' => Helper::isEntryAutoDeleteEnabled($form_id),
'current_form_title' => $form->title,
'entry_statuses' => Helper::getEntryStatuses($form_id),
'entries_url_base' => admin_url('admin.php?page=fluent_forms&route=entries&form_id='),
'no_found_text' => __('Sorry! No entries found. All your entries will be shown here once you start getting form submissions', 'fluentform'),
'has_pro' => defined('FLUENTFORMPRO'),
'printStyles' => [fluentformMix('css/settings_global.css')],
'email_notifications' => $formattedNotification,
'available_countries' => getFluentFormCountryList(),
'upgrade_url' => fluentform_upgrade_url(),
'form_entries_str' => TranslationString::getEntriesI18n(),
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Reference
apply_filters('fluentform/entries_vars', $data, $form);
This filter is located in FluentForm\app\Modules\Entries\Entries -> renderEntries($form_id)
# fluentform/submission_labels
You can use this filter to modify Submission labels.
Parameters
$labels(array) Label Names$submission(array) Current Form Submission$form(object) Form Object
Usage
add_filter('fluentform/submission_labels', function ($labels, $submission, $form) {
// Do your stuff here
return $labels;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_labels', $resources['labels'], $submission, $submission->form);
This filter is located in FluentForm\app\Services\Form\FormServices -> getDisabledComponents()
# fluentform/submission_vars
You can modify submission variables on double optin confirmation by using this filter.
Parameters
$submissionVars(array) Submission Variable$formId(int) Form ID
Usage
add_filter('fluentform/submission_vars', function ($submissionVars, $formId) {
// Do your stuff here
return $submissionVars;
}, 10, 2);
2
3
4
5
6
$submissionVars = [
'settings' => $settings,
'title' => 'Submission Confirmed - ' . $form->title,
'form_id' => $formId,
'entry' => $entry,
'form' => $form,
'bg_color' => $settings['custom_color'],
'landing_content' => $message,
'has_header' => false,
'isEmbeded' => !!ArrayHelper::get($_GET, 'embedded')
];
2
3
4
5
6
7
8
9
10
11
Reference
apply_filters('fluentform/submission_vars', $submissionVars, $formId);
This filter is located in FluentFormPro\src\classes\DoubleOption -> confirmSubmission($data)
# fluentform/step_form_entry_vars
You can modify step form submission variables by using this filter.
Parameters
$entryVars(array) Step Form Submission Variables$form(object) Form Object
Usage
add_filter('fluentform/step_form_entry_vars', function ($entryVars, $form) {
// Do your stuff here
return $entryVars;
}, 10, 2);
2
3
4
5
6
$entryVars = [
'form_id' => $form->id,
'current_form_title' => $form->title,
'has_pro' => defined('FLUENTFORMPRO'),
'all_forms_url' => admin_url('admin.php?page=fluent_forms'),
'printStyles' => [fluentformMix('css/settings_global.css')],
'entries_url_base' => admin_url('admin.php?page=fluent_forms&route=msformentries&form_id='),
'available_countries' => getFluentFormCountryList(),
'no_found_text' => __('Sorry! No entries found. All your entries will be shown here once you start getting form submissions', 'fluentformpro')
];
2
3
4
5
6
7
8
9
10
Reference
apply_filters('fluentform/step_form_entry_vars', $entryVars, $form);
This filter is located in FluentFormPro\src\classes\StepFormEntries -> renderEntries($form_id)
# fluentform/all_entries
You can modify all submissions using the filter.
Parameters
$submission(array) Form Submission
Usage
add_filter('fluentform/all_entries', function ($submission) {
// Do your stuff here
return $submission;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/all_entries', $entries['submissions']);
This filter is located in FluentFormPro\src\classes\StepFormEntries -> getEntries()
# fluentform/single_response_data
You can modify submission of a certain form using this filter.
Parameters
$submission(array) Form Submission$formId(int) Form ID
Usage
add_filter('fluentform/single_response_data', function ($submission, $formId) {
// Do your stuff here
return $submission;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/single_response_data', $submission, $this->formId);
This filter is located in FluentFormPro\src\classes\StepFormEntries -> getstepFormEntry()
# fluentform/single_response_input_fields
You can modify inputs of a submission under a certain form using this filter.
Parameters
$inputs(array) Form Inputs$formId(int) Form ID
Usage
add_filter('fluentform/single_response_input_fields', function ($inputs, $formId) {
// Do your stuff here
return $inputs;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/single_response_input_fields', $formMeta['inputs'], $this->formId);
This filter is located in FluentFormPro\src\classes\StepFormEntries -> getstepFormEntry()
# fluentform/single_response_input_labels
You can modify input labels of a submission under a certain form using this filter.
Parameters
$labels(array) Form Input Labels$formId(int) Form ID
Usage
add_filter('fluentform/single_response_input_labels', function ($labels, $formId) {
// Do your stuff here
return $labels;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/single_response_input_labels', $formMeta['labels'], $this->formId);
This filter is located in FluentFormPro\src\classes\StepFormEntries -> getstepFormEntry()
# fluentform/submission_cards
You can use this filter to modify submission page cards.
Parameters
$cards(array) Submission Cards$resources(array) Submission Resources$submission(array) Submission
Usage
add_filter('fluentform/submission_cards', function ($cards, $resources, $submission) {
// Do your stuff here
return $cards;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_cards', $cards, $resources, $submission);
This filter is located in Fluentform\app\services\Submission\SubmissionService -> resources($attributes)
# fluentform/submission_order_data
You can use this filter to toggle submission payment order.
Parameters
$order_data(boolean) Whether submission payment order is available$submission(array) Submission$form(object) Form Object
Usage
add_filter('fluentform/submission_order_data', function ($order_data, $submission, $form) {
// Do your stuff here
return $order_data;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_order_data', $order_data, $submission, $form);
This filter is located in Fluentform\app\services\Submission\SubmissionService -> _getEntry()
# fluentform/auto_read_submission
You can use this filter to toggle submission status to read automatically.
Parameters
$autoRead(boolean) Whether change submission status to read$form(object) Form Object
Usage
add_filter('fluentform/auto_read_submission', function ($autoRead, $form) {
// Do your stuff here
return $autoRead;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/auto_read', $autoRead, $form);
This filter is located in Fluentform\app\Modules\Entries\Entries -> _getEntry()
# fluentform/auto_read_submission
You can use this filter to toggle submission status to read automatically.
Parameters
$autoRead(boolean) Whether change submission status to read$form(object) Form Object
Usage
add_filter('fluentform/auto_read_submission', function ($autoRead, $form) {
// Do your stuff here
return $autoRead;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/auto_read_submission', $autoRead, $form);
This filter is located in Fluentform\app\Services\Submission\SubmissionService -> find($submissionId)
# fluentform/submissions_widgets
You can use this filter to modify submission widgets.
Parameters
$widgets(array) Submission Widgets$resources(array) Submission Resources$submission(array) Submission
Usage
add_filter('fluentform/submissions_widgets', function ($widgets, $resources, $submission) {
// Do your stuff here
return $widgets;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/submissions_widgets', $widgets, $resources, $submission);
This filter is located in Fluentform\app\Services\Submission\SubmissionService -> resources($attributes)
# fluentform/submission_resources
You can use this filter to modify all submission resources.
Parameters
$resources(array) Submission Resources
Usage
add_filter('fluentform/submission_resources', function ($resources) {
// Do your stuff here
return $resources;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_resources', $resources);
This filter is located in Fluentform\app\Services\Submission\SubmissionService -> resources($attributes)
# Form Filters
# fluentform/is_form_renderable
You can check if the form is renderable using this filter.
Parameters
$isAllowed(array) Form Status$form(object) Form Object
Usage
add_filter('fluentform/is_form_renderable', function ($isAllowed, $form){
// Do your stuff here
return $isAllowed;
}, 10, 2);
2
3
4
5
Reference
apply_filters('fluentform/is_form_renderable', $isAllowed, $this->form);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateRestrictions(&$fields)
# fluentform/conversational_url_slug
You can change any conversational form URL Slug, by default it is fluent-form.
Parameters
$slug(string) URL Slug
Usage
add_filter('fluentform/conversational_url_slug', function ($slug){
// Do your stuff here
return $slug;
}, 10, 1);
2
3
4
5
Reference
apply_filters('fluentform/conversational_url_slug', 'fluent-form');
This filter is located in FluentForm\App\Services\FluentConversational\Classes\Form -> renderDesignSettings($formId)
By default, Fluent Form’s conversional form’s URL looks like this: yourdomain.com/?fluent-form=FORM_ID&form=OPTIONAL_SECURITY_CODE
But if you want to customize it and make it pretty something like yourdomain.com/my-forms/FORM_ID/OPTIONAL_SECURITY_CODE then please follow this tutorial
First copy and paste this code to your theme’s functions.php file or in your custom code snippet plugin
/*
* Internal Function for Fluent Forms Custom Slug
* Do not EDIT this function
*/
function customFfLandingPageSlug($slug)
{
add_action('init', function () use ($slug) {
add_rewrite_endpoint($slug, EP_ALL);
});
add_action('wp', function () use ($slug) {
global $wp_query;
if (isset($wp_query->query_vars[$slug])) {
$formString = $wp_query->query_vars[$slug];
if (!$formString) {
return;
}
$array = explode('/', $formString);
$formId = $array[0];
if (!$formId || !is_numeric($formId)) {
return;
}
$secretKey = '';
if (count($array) > 1) {
$secretKey = $array[1];
}
$paramKey = apply_filters('fluentform/conversational_url_slug', 'fluent-form');
$_GET[$paramKey] = $formId;
$_REQUEST[$paramKey] = $formId;
$request = wpFluentForm('request');
$request->set($paramKey, $formId);
$request->set('form', $secretKey);
}
});
}
/*
* Creating custom slug for conversational form landing page
*
* my-forms is your custom slug for the form
* if your form id is 123 then the landing page url will be then
* https://your-domain.com/my-forms/123
* if you use Security Code on conversational form then the url will be
* https://your-domain.com/my-forms-x/123/SECURITY-CODE
*
* After paste the code to your theme's functions.php file please re-save the permalink settings
*/
customFfLandingPageSlug('my-forms'); // you may change the "my-forms" for your own page slug
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
Once you add the code, please feel free to change the ‘my-forms’ to your own slug that you want
If your form id is 123 then the landing page url will be then your-domain.com/my-forms/123
If you use Security Code on conversational form then the url will be your-domain.com/my-forms/123/SECURITY-CODE
Please note that once you add the code make sure you re-save your permalink from Settings -> Permalinks (on wp-admin)
# fluentform/numeric_styles
You can modify or add more numeric formatters to number inputs using this filter.
Parameters
$numericFormatters(array) all numeric formats
Usage
add_filter('fluentform/numeric_styles', function($numericFormatters) {
// Do your stuff here
return $staus;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/numeric_styles', $numericFormatters);
This filter is located in FluentForm\App\Helpers\Helper -> getNumericFormatters()
# fluentform/form_store_attributes
You can modify Form attributes just Before storing the Form to the Database.
Parameters
$storeAttributes(array) Form default attributes
Usage
add_filter('fluentform/form_store_attributes', function ($storeAttributes) {
// Do your stuff here
return $storeAttributes;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/form_store_attributes', array_filter($storeAttributes));
This filter is located in FluentForm\App\Models\Form -> prepare($attributes = [])
# fluentform/forms_default_settings
You can modify Form Default Settings using this filter.
Parameters
$defaultSettings(array) Form default Settings
Usage
add_filter('fluentform/forms_default_settings', function ($defaultSettings) {
// Do your stuff here
return $defaultSettings;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/forms_default_settings', array_filter($data));
This filter is located in FluentForm\App\Models\Form -> getFormsDefaultSettings($formId = false)
# fluentform/create_default_settings
You can modify Form Default Settings while creating a new form using this filter.
Parameters
$defaultSettings(array) Form default Settings
Usage
add_filter('fluentform/create_default_settings', function($defaultSettings) {
// Do your stuff here
return $defaultSettings;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/create_default_settings', array_filter($defaultSettings));
This filter is located in FluentForm\App\Models\Form -> getFormsDefaultSettings($formId = false)
# fluentform/editor_components
You can modify or add more Form Component using this filter.
Parameters
$editorComponents(array) Editor Components$formId(int) Form ID
Usage
add_filter('fluentform/editor_components', function($editorComponents, $formId) {
// Do your stuff here
$component = $this->getComponent();
if ($component) {
$components['advanced'][] = $component;
}
return $components;
}, 10, 2);
2
3
4
5
6
7
8
9
10
11
12
Reference
apply_filters('fluentform/editor_components', $editorComponents, $formId);
This filter is located in FluentForm\App\Modules\Component\Component -> index()
# fluentform/load_default_public
You can toggle to load public styles using this filter.
Parameters
$status(boolean) True / False$form(Object) Form Object
Usage
add_filter('fluentform/load_default_public', function ($status, $form) {
// Do your stuff here
return $isSkip;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/load_default_public', true, $form);
This filter is located in FluentForm\App\Modules\Component\Component -> renderForm($atts)
# fluentform/load_styles
This filter is available before loading fluentform styles.
Parameters
$status(boolean) True / False$form(object) Form Object
Usage
add_filter('fluentform/load_styles', function ($status, $form) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/load_styles', false, $post);
This filter is located in FluentForm\App\Modules\Component\Component -> maybeLoadFluentFormStyles()
# fluentform/global_form_vars
This filter returns the variables for localizing with fluentform script.
Parameters
$globalVars(array) Localized Global Variable Array
Usage
add_filter('fluentform/global_form_vars', function ($globalVars) {
// Do your stuff here
return $globalVars;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/global_form_vars', $data);
This filter is located in FluentForm\App\Modules\Component\Component -> renderForm($atts)
# fluentform/form_vars_for_JS
You can modify Form Default Variables Javascript using this filter.
Parameters
$form_vars(array) Form Variables$form(object) Form Object
Usage
add_filter('fluentform/form_vars_for_JS', function($form_vars, $form) {
// Do your stuff here
return $form_vars;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/form_vars_for_JS', $form_vars, $form);
This filter is located in FluentForm\App\Modules\Component\Component -> renderForm($atts))
# fluentform/disabled_analytics
Using this filter you can toggle the form analytics.
Parameters
$status(boolean) whether form analytics is enabled
Usage
add_filter('fluentform/disabled_analytics', function($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/disabled_analytics', $disableAnalytics);
This filter is located in FluentForm\App\Modules\Component\Component -> renderForm($atts)
# fluentform/date_i18n
This filter returns date fields internationalized strings.
Parameters
$i18n(array) Internationalized Strings
Usage
add_filter('fluentform/date_i18n', function ($i18n) {
// Do your stuff here
return $i18n;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/date_i18n', $i18n);
This filter is located in FluentForm\App\Modules\Component\Component -> getDatei18n()
# 'fluentform/settings_module_' . $module
This filter returns form extra settings component.
Parameters
$component(array) Components$formId(int) Form ID
Usage
add_filter('fluentform/settings_module_' . $module, function ($component, $formId) {
// Do your stuff here
return $result;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/settings_module_' . $module, $component, $formId);
This filter is located in FluentForm\App\Modules\Form\Settings\ExtraSettings -> getExtraSettingsComponent()
# fluentform/form_settings_ajax
You can modify a form setting Ajax using this filter.
Parameters
$settings(array) Form Settings$formId(int) Form ID
Usage
add_filter('fluentform/form_settings_ajax', function ($settings, $formId) {
// Do your stuff here
return $settings;
}, 10, 2);
2
3
4
5
6
Reference
applyFilters('fluentform/form_settings_ajax', $settings, $formId);
This filter is located in FluentForm\App\Settings\FormSettings -> getGeneralSettingsAjax()
# fluentform/form_fields_update
This filter returns the updated field when updating a form field.
Parameters
$formFields(array) Form Fields$formId(int) Form ID
Usage
add_filter('fluentform/form_fields_update', function ($formFields, $formId) {
// Do your stuff here
return $defaultSettings;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/form_fields_update', $formFields, $formId);
This filter is located in FluentForm\App\Services\Form\Updater -> update($attributes = [])
# 'fluentform/response_render_' . $field['element']
This filter returns response data for the form inputs.
Parameters
$value(array) Field Element$field(array) Field Data$formId(int) Form ID$isHtml(boolean) Whether the value rendered as HTML
Usage
add_filter('fluentform/response_render_textarea', function ($value, $field, $formId, $isHtml) {
if (!$isHtml || !$value) {
return $value;
}
return '<span style="white-space: pre-line">' . $value . '</span>';
}, 10, 4);
add_filter('fluentform/response_render_input_password', function ($value, $field, $formId, $isHtml = false) {
if (Helper::shouldHidePassword($formId)) {
$value = str_repeat('*', 6) . ' ' . __('(truncated)', 'fluentform');
}
return $value;
}, 10, 4);
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Reference
apply_filters('fluentform/response_render_' . $field['element'], $response, $field, $formId, $isHtml);;
This filter is located in FluentForm\App\Modules\Form\FormDataParser -> parseData($response, $fields, $formId, $isHtml = false)
# fluentform/form_submission_confirmation
You can use this filter hook to alter form confirmation message after a successful form submission.
Parameters
$confirmation(array) Confirmation Details
$confirmation = [
'redirectTo' => 'samePage' // or customUrl or customPage
'messageToShow' => 'Thank you for your message. We will get in touch with you shortly'
'customPage' => ''
'samePageFormBehavior' => 'hide_form' // or reset_form
'customUrl' => 'https://yourcustomurl.com'
];
2
3
4
5
6
7
$formData(array) Form Data$form(object) Form Object
Usage
add_filter('fluentform/form_submission_confirmation', function($confirmation, $formData, $form) {
// Do your stuff here
return $confirmation;
}, 10, 3);
2
3
4
5
6
The following would apply to a specific form with id 5:
add_filter('fluentform/form_submission_confirmation', function($confirmation, $formData, $form)
{
if ($form->id != 5) {
return $confirmation;
}
// Do your stuffs here
return $confirmation;
}, 10, 3);
2
3
4
5
6
7
8
9
10
Reference
apply_filters('fluentform/submission_confirmation', $returnData, $form, $confirmation);
This filter is located in FluentForm\App\Services\Form\SubmissionHandlerService -> getReturnData($insertId, $form, $formData)
# fluentform/submission_message_parse
This filter parses the shortcode of the confirmation / email body message.
Parameters
$confirmation(array) Confirmation Details$insertId(string) Submission ID$formData(array) Form Data$form(object) Form Object
Usage
add_filter('fluentform/submission_message_parse', function($confirmation, $insertId, $formData, $form) {
// Do your stuff here
return $confirmation;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_message_parse', $confirmation['messageToShow'], $insertId, $formData, $form);
This filter is located in FluentForm\App\Services\Form\SubmissionHandlerServices -> getReturnData($insertId, $form, $formData)
# fluentform/validations
This filter returns all validations before form submission.
Parameters
$originalValidations(array) Default Validations$form(object) Form Object$formData(array) Form Data
Usage
add_filter('fluentform/validations', function ($originalValidations, $form, $formData) {
// Do your stuff here
return $originalValidations;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/validations', $originalValidations, $this->form, $formData);
This filter is located in FluentForm\App\Services\Form -> validateSubmission(&$fields, &$formData)
# 'fluentform/validate_input_item_' . $field['element']
This filter returns validations for specific field before form submission.
Parameters
$validation(string) Form's Validation Message$field(array) Field Settings$formData(array) Form Data$fields(array) All Fields of the Form$form(object) Form Object
Usage
add_filter('fluentform/validate_input_item_' . $field['element'], function($validation, $field, $formData, $fields, $form) {
// Do your stuff here
return $validation;
}, 10, 5);
2
3
4
5
6
Similar Filter for Other Input
/*
* Common Filter hook names
* Text/Mask: fluentform/validate_input_item_input_text
* Email: fluentform/validate_input_item_input_email
* Textarea: fluentform/validate_input_item_textarea
* Numeric: fluentform/validate_input_item_input_number
* Range Slider: fluentform/validate_input_item_rangeslider
* Address: fluentform/validate_input_item_address
* Country Select: fluentform/validate_input_item_select_country
* Select: fluentform/validate_input_item_select
* Radio: fluentform/validate_input_item_input_radio
* Checkbox: fluentform/validate_input_item_input_checkbox
* Website URL: fluentform/validate_input_item_input_input_url
* Date: fluentform/validate_input_item_input_input_date
* Image Upload: fluentform/validate_input_item_input_image
* File Upload: fluentform/validate_input_item_input_file
* Phone Field: fluentform/validate_input_item_phone
* Color Picker: fluentform/validate_input_item_color_picker
* Net Promoter Score: fluentform/validate_input_item_net_promoter_score
* Password: fluentform/validate_input_item_input_password
* Ratings: fluentform/validate_input_item_ratings
*/
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Reference
apply_filters('fluentform/validate_input_item_' . $field['element'], '', $field, $formData, $fields, $this->form, $errors);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateSubmission(&$fields, &$formData)
# fluentform/validation_errors
This filter return all the validation errors.
Parameters
$errors(array) Errors$formData(array) Form Data$form(Object) Form Object$fields(array) Form Fields
Usage
add_filter('fluentform/validation_errors', function ($errors, $formData, $form, $fields) {
// Do your stuff here
return $errors;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/validation_errors', $errors, $formData, $this->form, $fields);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateSubmission(&$fields, &$formData)
# fluentform/prevent_malicious_attacks
You can toggle malicious attack prevention using this filter.
Parameters
$status(boolean) Whether Malicious Attack Prevention Enabled$formId(int) Form ID
Usage
add_filter('fluentform/prevent_malicious_attacks', function($status, $formId) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/prevent_malicious_attacks', true, $this->form->id);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> preventMaliciousAttacks()
# fluentform/honeypot_status
You can toggle Honeypot status using this filter.
Parameters
$status(boolean) Whether Honeypot status is Enabled$formId(int) Form ID
Usage
add_filter('fluentform/honeypot_status', function($status, $formId) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/honeypot_status', $status, $formId);
This filter is located in FluentForm\App\Modules\Form\Honeypot -> isEnabled($formId = false)
# fluentform/honeypot_name
You can change Honeypot name using this filter just before rendering the form.
Parameters
$name(string) Honeypot Field Name$formId(int) Form ID
Usage
add_filter('fluentform/honeypot_name', function($name, $formId) {
// Do your stuff here
$customStr = 'custom_name';
$name = 'item__' . $formId . '__fluent_checkme_' . $customStr;
return $name;
}, 10, 2);
2
3
4
5
6
7
8
Reference
apply_filters('fluentform/honeypot_name', 'item__' . $formId . '__fluent_checkme_', $formId);
This filter is located in FluentForm\App\Modules\Form\HoneyPot -> getFieldName($formId)
# fluentform/predefined_forms
You can add or modify Predefined Forms in Form Templates using this filter.
Parameters
$forms(array) Template Forms
Usage
add_filter('fluentform/predefined_forms', function ($forms) {
// Do your stuff here
return $forms;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/predefined_forms', $forms);
This filter is located in FluentForm\App\Models\Traits\PredefinedForms -> findPredefinedForm($attributes = [])
# fluentform/predefined_dropdown_forms
You can add or modify Predefined Post Forms in Form Templates using this filter.
Parameters
$forms(array) Template Post Forms
Usage
add_filter('fluentform/predefined_dropdown_forms', function($forms) {
// Do your stuff here
return $forms;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/predefined_dropdown_forms', $dropDownForms),
This filter is located in FluentForm\App\Services\Form\FormService -> templates()
# 'fluentform/editor_init_element_' . $formField['element']
Rendered form fields can be modified using this filter.
Parameters
$formField(array) Form Field$form(object) Form Object
Usage
add_filter('fluentform/editor_init_element_input_text', function ($element) {
if (!isset($element['attributes']['maxlength'])) {
$element['attributes']['maxlength'] = '';
}
return $element;
});
2
3
4
5
6
7
add_filter('fluentform/editor_init_element_input_number', function ($item) {
if (!isset($item['settings']['number_step'])) {
$item['settings']['number_step'] = '';
}
if (!isset($item['settings']['numeric_formatter'])) {
$item['settings']['numeric_formatter'] = '';
}
if (!isset($item['settings']['prefix_label'])) {
$item['settings']['prefix_label'] = '';
}
if (!isset($item['settings']['suffix_label'])) {
$item['settings']['suffix_label'] = '';
}
return $item;
});
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
Reference
apply_filters('fluentform/editor_init_element_' . $formField['element'], $formField, $form);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> enqueueEditorAssets()
# fluentform/inner_route_has_permission
You can check admin menu route has proper permission using this filter.
Parameters
$hasPermission(boolean) Whether the current route has permission$route(string) Route Name$formId(int) Form ID
Usage
add_filter('fluentform/inner_route_has_permission', function($hasPermission, $route, $formId) {
// Do your stuff here
return $hasPermission;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/form_inner_route_permission_set', Acl::hasPermission($toVerifyPermission), $route, $formId);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderFormAdminRoute()
# fluentform/form_admin_menu
You can modify admin menu items using this filter.
Parameters
$permission(array) Admin Permission Set$form_id(int) Form ID$form(object) Form Object
Usage
add_filter('fluentform/form_admin_menu', function($formAdminMenus, $form_id, $form) {
// Do your stuff here
return $formAdminMenus;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/form_admin_menu', $formAdminMenus, $form_id, $form);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderFormInnerPages()
# fluentform/form_settings_menu
You can modify form settings menu items using this filter.
Parameters
$permission(array) Admin Permission Set
Usage
add_filter('fluentform/form_settings_menu', function ($settingsMenus, $form_id) {
// Do your stuff here
return $settingsMenus;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/form_settings_menu', $settingsMenus, $form_id);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderSettings($form_id)
# fluentform/editor_element_search_tags
You can modify editor element search tags using this filter.
Parameters
$searchTags(array) Editor Fields$form(object) Form Object
Usage
add_filter('fluentform/editor_element_search_tags', function ($searchTags, $form) {
// Do your stuff here
return $searchTags;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/editor_element_search_tags', $searchTags, $form);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> enqueueEditorAssets()
# fluentform/editor_element_settings_placement
Using this filter you can insert more editor settings for input in the editor.
Parameters
$placements(array) Editor Fields$form(object) Form Object
Usage
add_filter('fluentform/editor_element_settings_placement', function ($placements, $form) {
// Do your stuff here
return $placements;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/editor_element_settings_placement', $elementPlacements, $form);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> enqueueEditorAssets()
# fluentform/conversational_editor_elements
You can modify conversational editor elements using this filter.
Parameters
$elements(array) Conversational Editor Elements$formId(int) Form ID
Usage
add_filter('fluentform/conversational_editor_elements', function ($elements, $formId) {
// Do your stuff here
return $elements;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/conversational_editor_elements', $elements, $formId);
This filter is located in FluentForm\App\Modules\Widgets\EditorButtonModule -> pageSupportedMediaButtons()
# 'fluentform/input_data_' . $element
This filter returns the input labels for the Submission on the Submission page.
Parameters
$fieldData(array) Form Data of the Field$field(array) Field Data$formData(array) Form Data$form(object) Form Object
Usage
add_filter('fluentform/input_data_input_number', function ($fieldData, $field, $formData, $form) {
// Do your stuff here
$formatter = ArrayHelper::get($field, 'raw.settings.numeric_formatter');
if (!$formatter) {
return $value;
}
return Helper::getNumericValue($value, $formatter);
}, 10, 4);
2
3
4
5
6
7
8
9
10
Reference
apply_filters('fluentform/input_data_' . $element, $formData[$fieldName], $field, $formData, $this->form);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateSubmission(&$fields, &$formData)
# fluentform/before_render_item
You can use this filter to modify the form inputs before form render.
Parameters
$item(array) Input Item$form(object) Form Object
Usage
add_filter('fluentform/before_render_item', function ($item, $form) {
// Do your stuff here
return $item;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/before_render_item', $item, $form);
This filter is located in FluentForm\App\Services\FormBuilder -> buildFormBody($form)
# fluentform/frontend_date_format
You can modify date formats to show in form frontend using the filter.
Parameters
$dateFormats(array) Date formats Settings$settings(array) Field Settings$form(object) Form Object
Usage
add_filter('fluentform/frontend_date_format', function ($dateFormats, $settings, $form) {
// Do your stuff here
return $dateFormats;
}, 10, 3);
2
3
4
5
6
Date formats to filter:
[
'dateFormat' => $dateFormat,
'enableTime' => $hasTime,
'noCalendar' => ! $this->hasDate($dateFormat),
'disableMobile' => true,
'time_24hr' => $time24,
];
2
3
4
5
6
7
Reference
apply_filters('fluentform/frontend_date_format', $dateFormats, $settings, $form);
This filter is located in FluentForm\App\Services\FormBuilder\Components\DateTime -> getDateFormatConfigJSON($settings, $form)
# 'fluentform/is_hide_submit_btn_' . $form->id
You can hide / show submit button using the filter.
Parameters
$status(boolean) Whether show / hide Submit Button
Usage
add_filter('fluentform/is_hide_submit_btn_' . $form->id, function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/is_hide_submit_btn_' . $form->id, false);
This filter is located in FluentForm\App\Services\FormBuilder\Components\SubmitButton -> compile($data, $form)
# fluentform/submit_button_force_no_style
You can modify admin menu items using this filter.
Parameters
$permission(array) Admin Permission Set$form_id(int) Form ID$form(object) Form Object
Usage
add_filter('fluentform/form_admin_menu', function($formAdminMenus, $form_id, $form) {
// Do your stuff here
return $formAdminMenus;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/form_admin_menu', $formAdminMenus, $form_id, $form);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderFormInnerPages()
# fluentform/submit_button_force_no_style
You can adjust submit button style to have no style using this filter.
Parameters
$status(boolean) Whether the submit button style is active
Usage
add_filter('fluentform/submit_button_force_no_style', function($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/submit_button_force_no_style', $status);
This filter is located in FluentForm\App\Services\FormBuilder\Components\SubmitButton -> compile($data, $form)
# fluentform/disable_inputmode
You can disable text input field using the filter.
Parameters
$status(boolean) Whether text input is disabled
Usage
add_filter('fluentform/disable_inputmode', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/disable_inputmode', $status);
This filter is located in FluentForm\App\Services\FormBuilder\Components\Text -> compile($data, $form)
# fluentform/form_class
You can use this filter to modify a form CSS classes.
Parameters
$item(array) Input Item$form(object) Form Object
Usage
add_filter('fluentform/form_class', function ($css_class, $targetForm) use ($form) {
if ($targetForm->id == $form->id) {
$css_class .= ' ff_calc_form';
}
return $css_class;
}, 10, 2);
2
3
4
5
6
7
Reference
apply_filters('fluentform/form_class', $formClass, $form);
This filter is located in FluentForm\App\Services\FormBuilder\FormBuilder -> build($form, $extraCssClass = '', $instanceCssClass = '', $atts = [])
# fluentform/disable_accessibility_fieldset
You can use this filter to toggle form accessibility status and fieldset.
Parameters
$status(boolean) Whether the accessibility status is enabled$form(object) Form Object
Usage
add_filter('fluentform/disable_accessibility_fieldset', function ($status, $form) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/disable_accessibility_fieldset', true, $form);
This filter is located in FluentForm\App\Services\FormBuilder\FormBuilder -> build($form, $extraCssClass = '', $instanceCssClass = '', $atts = [])
# fluentform/form_input_types
You can use this filter to add more form input types.
Parameters
$types(array) Form Input Types
Usage
add_filter('fluentform/form_input_types', function ($types) {
// Do your stuff here
return $types;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/form_input_types', $types);
This filter is located in FluentForm\App\Services\Parser\Form -> setInputTypes($types = [])
# fluentform/form_payment_fields
You can use this filter to add more form payment input fields.
Parameters
$types(array) Form Payment Input Types
Usage
add_filter('fluentform/form_payment_fields', function ($types) {
// Do your stuff here
return $types;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/form_payment_fields', $types);
This filter is located in FluentForm\App\Services\Parser\Form -> hasPaymentFields()
# fluentform/form_payment_inputs
You can use this filter to modify form payment input fields types
Parameters
$data(array) Form Payment Input Types
Usage
add_filter('fluentform/form_payment_inputs', function ($data) {
// Do your stuff here
return $data;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/form_payment_inputs', $data);
This filter is located in FluentForm\App\Services\Parser\Form -> getPaymentInputFields($with = ['element'])
# fluentform/show_preview_promo
You can use this filter to toggle preview promo.
Parameters
$status(boolean) Whether to show preview promo
Usage
add_filter('fluentform/show_preview_promo', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/show_preview_promo', true);
This filter is located in FluentForm\app\views\frameless\template\show_preview.php
# fluentform/rendering_form
This filter hook is fired before form render. You can use this to change rendered form.
Parameters
$form(object) Form Object
Usage
add_filter('fluentform/rendering_form', function ($form) {
// Do your stuff here
return $form;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/rendering_form', $form);
This filter is located in FluentForm\app\Modules\Component\Component -> renderForm($atts)
# fluentform/submission_confirmation
This filter hook is fired before form render. You can use this to change rendered form.
Parameters
$returnData(array) Submitted Data$form(object) Form Object$confirmation(array) Submission Confirmation Message
Usage
add_filter('fluentform/submission_confirmation', function ($returnData, $form, $confirmation) {
// Do your stuff here
return $returnData;
}, 10, 3);
2
3
4
5
6
$returnData = [
'redirectUrl' => wp_sanitize_redirect(urldecode($redirectUrl)),
'message' => $message,
];
2
3
4
Reference
apply_filters('fluentform/submission_confirmation', $returnData, $form, $confirmation);
This filter is located in FluentForm\app\Services\Form\SubmissionHandlerService -> getReturnData($insertId, $form, $formData)
# Settings Filters
# fluentform/is_admin_page
You can toggle the rendering page as an admin page by using this filter.
Parameters
$status(boolean) Whether the rendering page is an Admin Page
Usage
add_filter('fluentform/is_admin_page', function($status) {
// Do your stuff here
return $staus;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/is_admin_page', $status);
This filter is located in FluentForm\App\Helpers\Helper -> isFluentAdminPage()
# fluentform/advanced_validation_settings
You can modify Advanced Validation Settings using this filter.
Parameters
$settings(array) Form Advanced Validation Settings
Usage
add_filter('fluentform/advanced_validation_settings', function($settings) {
// Do your stuff here
return $settings;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/advanced_validation_settings', $settings);
This filter is located in FluentForm\App\Models\Form -> getAdvancedValidationSettings($formId)
# fluentform/get_meta_key_settings_response
This filter returns settings responses meta key.
Parameters
$result(array) Responses$formId(int) Form ID$metaKey(string) Form ID
Usage
add_filter('fluentform/get_meta_key_settings_response', function ($result, $formId, $metaKey) {
// Do your stuff here
return $result;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/get_meta_key_settings_response', $result, $formId, $metaKey);
This filter is located in FluentForm\App\Services\Settings\SettingsService -> get($attributes = [])
# fluentform/dashboard_capability
You can modify Fluent Forms Dashboard Capability using this filter.
Parameters
$roleName(string) Role Name. By Default, 'fluentform_dashboard_access'
Usage
add_filter('fluentform/dashboard_capability', function($roleName) {
// Do your stuff here
return $roleName;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/dashboard_capability', 'fluentform_dashboard_access');
This filter is located in FluentForm\App\Modules\Registerer\Menu -> register()
# fluentform/settings_capability
You can modify Fluent Forms Settings Capability using this filter.
Parameters
$roleName(string) Role Name. By Default, 'fluentform_settings_manager'
Usage
add_filter('fluentform/settings_capability', function($roleName) {
// Do your stuff here
return $roleName;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/settings_capability', 'fluentform_dashboard_access');
This filter is located in FluentForm\App\Modules\Registerer\Menu -> register()
# fluentform/admin_menu_bar_items
You can add or modify Admin Menu Bar items using this filter.
Parameters
$items(array) Admin Menu Bar items
Usage
add_filter('fluentform/admin_menu_bar_items', function($items) {
// Do your stuff here
return $items;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/admin_menu_bar_items', $items);
This filter is located in FluentForm\App\Modules\Registerer\AdminBar -> getMenuItems()
# fluentform/form_inner_route_permission_set
You can modify Admin Menu Route with permission using this filter.
Parameters
$permission(array) Admin Permission Set
Usage
add_filter('fluentform/form_inner_route_permission_set', function($permissions) {
// Do your stuff here
return $permissions;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/form_inner_route_permission_set', [ 'editor' => 'fluentform_forms_manager', 'settings' => 'fluentform_forms_manager', 'entries' => 'fluentform_entries_viewer' ]);
This filter is located in FluentForm\App\Modules\Registerer\AdminBar -> getMenuItems()
# fluentform/inner_route_has_permission
You can check admin menu route has proper permission using this filter.
Parameters
$hasPermission(boolean) Whether the current route has permission$route(string) Route Name$formId(int) Form ID
Usage
add_filter('fluentform/inner_route_has_permission', function($hasPermission, $route, $formId) {
// Do your stuff here
return $hasPermission;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/form_inner_route_permission_set', Acl::hasPermission($toVerifyPermission), $route, $formId);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderFormAdminRoute()
# fluentform/form_admin_menu
You can modify admin menu items using this filter.
Parameters
$permission(array) Admin Permission Set$form_id(int) Form ID$form(object) Form Object
Usage
add_filter('fluentform/form_admin_menu', function($formAdminMenus, $form_id, $form) {
// Do your stuff here
return $formAdminMenus;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/form_admin_menu', $formAdminMenus, $form_id, $form);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderFormInnerPages()
# fluentform/form_settings_menu
You can modify form settings menu items using this filter.
Parameters
$permission(array) Admin Permission Set
Usage
add_filter('fluentform/form_settings_menu', function ($settingsMenus, $form_id) {
// Do your stuff here
return $settingsMenus;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/form_settings_menu', $settingsMenus, $form_id);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderSettings($form_id)
# fluentform/all_forms_vars
You can modify form variables using this filter.
Parameters
$data(array) Localized Form Vars under 'FluentFormApp'
Usage
add_filter('fluentform/all_forms_vars', function($data) {
// Do your stuff here
return $vars;
}, 10, 1);
2
3
4
5
6
$data consists of the following parameters:
$data = [
'plugin' => $this->app->config->get('app.slug'),
'formsCount' => $formsCount,
'hasPro' => defined('FLUENTFORMPRO'),
'upgrade_url' => fluentform_upgrade_url(),
'adminUrl' => admin_url('admin.php?page=fluent_forms'),
'adminUrlWithoutPageHash' => admin_url('admin.php'),
'isDisableAnalytics' => $this->app->applyFilters('fluentform/disabled_analytics', false),
'plugin_public_url' => fluentformMix(),
];
2
3
4
5
6
7
8
9
10
Reference
apply_filters('fluentform/all_forms_vars', $data);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderForms()
# fluentform/editor_vars
You can modify editor variables using this filter.
Parameters
$data(array) Editor variables
Usage
add_filter('fluentform/editor_vars', function ($data) {
// Do your stuff here
return $data;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/editor_vars', $data);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> enqueueEditorAssets()
# fluentform/global_settings_current_component
You can modify selected global setting component using this filter.
Parameters
$currentComponent(array) Selected Global Setting Component
Usage
add_filter('fluentform/global_settings_current_component', function ($currentComponent) {
// Do your stuff here
return $currentComponent;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/global_settings_current_component', $currentComponent);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderGlobalSettings()
# fluentform/global_settings_components
You can modify all global setting components using this filter.
Parameters
$components(array) All Global Setting Component
Usage
add_filter('fluentform/global_settings_components', function ($components) {
// Do your stuff here
return $components;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/global_settings_components', $components);
This filter is located in FluentForm\App\Modules\Registerer\Menu -> renderGlobalSettings()
# fluentform/admin_i18n
You can alter or added more internationalize (i18n) for admin side string using this filter.
Parameters
$i18n(array) All the i18n Strings
Usage
add_filter('fluentform/admin_i18n', function ($i18n) {
// Do your stuff here
return $i18n;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/admin_i18n', $i18n);
This filter is located in FluentForm\App\Modules\Registerer\TranslationString -> getAdminI18n()
# fluentform/global_settings_i18n
You can alter or added more internationalize (i18n) for global settings string using this filter.
Parameters
$i18n(array) All the i18n Strings
Usage
add_filter('fluentform/global_settings_i18n', function ($i18n) {
// Do your stuff here
return $i18n;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/global_settings_i18n', $i18n);
This filter is located in FluentForm\App\Modules\Registerer\TranslationString -> getGlobalSettingsI18n()
# fluentform/editor_i18n
You can alter or added more internationalize (i18n) for form editor string using this filter.
Parameters
$i18n(array) All the i18n Strings
Usage
add_filter('fluentform/editor_i18n', function ($i18n) {
// Do your stuff here
return $i18n;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/editor_i18n', $i18n);
This filter is located in FluentForm\App\Modules\Registerer\TranslationString -> getEditorI18n()
# fluentform/entries_i18n
You can alter or added more internationalize (i18n) for form submission string using this filter.
Parameters
$i18n(array) All the i18n Strings
Usage
add_filter('fluentform/entries_i18n', function ($i18n) {
// Do your stuff here
return $i18n;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/entries_i18n', $i18n);
This filter is located in FluentForm\App\Modules\Registerer\TranslationString -> getEntriesI18n()
# fluentform/addOnModule_i18n
You can alter or added more internationalize (i18n) for addon module string using this filter.
Parameters
$i18n(array) All the i18n Strings
Usage
add_filter('fluentform/addOnModule_i18n', function ($i18n) {
// Do your stuff here
return $i18n;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/addOnModule_i18n', $i18n);
This filter is located in FluentForm\App\Modules\Registerer\TranslationString -> getAddOnModuleI18n()
# fluentform/transfer_i18n
You can alter or added more internationalize (i18n) for form transfer string using this filter.
Parameters
$i18n(array) All the i18n Strings
Usage
add_filter('fluentform/transfer_i18n', function ($i18n) {
// Do your stuff here
return $i18n;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/transfer_i18n', $i18n);
This filter is located in FluentForm\App\Modules\Registerer\TranslationString -> getTransferModuleI18n()
# fluentform/payments_i18n
You can alter or added more internationalize (i18n) for payments string using this filter.
Parameters
$i18n(array) All the i18n Strings
Usage
add_filter('fluentform/payments_i18n', function ($i18n) {
// Do your stuff here
return $i18n;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/payments_i18n', $i18n);
This filter is located in FluentForm\App\Modules\Registerer\TranslationString -> getPaymentsI18n()
# fluentform/addons_extra_menu
You can modify addon modules menus using this filter.
Parameters
$extraMenus(array) Addon Modules Menus
Usage
add_filter('fluentform/addons_extra_menu', function ($menus) {
$menus['fluentform_pdf'] = __('Fluent Forms PDF', 'fluentform');
return $menus;
}, 99, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/addons_extra_menu', $extraMenus);
This filter is located in FluentForm\App\Modules\Widgets\AddOnModule -> render()
# fluentform/user_guide_links
You can modify documentation module user guide links using this filter.
Parameters
$guides(array) User Guide Links
Usage
add_filter('fluentform/user_guide_links', function ($guides) {
// Do your stuff here
return $guides;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/user_guide_links', $guides);
This filter is located in FluentForm\App\Modules\Widgets\DocumentationModule -> getUserGuides()
# fluentform/display_add_form_button
You can toggle to support pages for showing media button using this filter.
Parameters
$isEligiblePage(array) User Guide Links
Usage
add_filter('fluentform/display_add_form_button', function ($isEligiblePage) {
// Do your stuff here
return $isEligiblePage;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/display_add_form_button', $isEligiblePage);
This filter is located in FluentForm\App\Modules\Widgets\EditorButtonModule -> pageSupportedMediaButtons()
# 'fluentform/rendering_field_data_' . $elementName
This filter is fired right before rendering an form field with the data and settings. You can use this filter to modify the output of a form field.
Parameters
$data(array) Form Field Element$form(object) Form Object
Usage
add_filter('fluentform/rendering_field_data_input_text', function ($data, $form)
{
if($form->id != 5) {
return;
}
// Do your stuffs here
return $data;
}, 10, 2);
2
3
4
5
6
7
8
9
10
add_filter('fluentform/rendering_field_data_select', function ($data, $form) {
if ($form->id != 91) {
return $data;
}
// check if the name attriibute is 'dynamic_dropdown'
if (\FluentForm\Framework\Helpers\ArrayHelper::get($data, 'attributes.name') != 'dynamic_dropdown') {
return $data;
}
// We are merging with existing options here
$data['settings']['advanced_options'] = array_merge($data['settings']['advanced_options'], [
[
"label" => "Dynamic Option 1",
"value" => "Dynamic Option 1",
"calc_value" => ""
],
[
"label" => "Dynamic Option 2",
"value" => "Dynamic Option 2",
"calc_value" => ""
]
]);
return $data;
}, 10, 2);
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Reference
apply_filters('fluentform/rendering_field_data_' . $elementName, $data, $form);
This filter is located in FluentForm\App\Services\FormBuilder\Components\Text -> compile($data, $form)
# 'fluentform/rendering_field_html_' . $elementName
This filter returns HTML output for each input of the form. You can hook into this and modify the HTML output of any field.
Parameters
$html(string) HTML output of field$data(array) Form Field Element$form(object) Form Object
Usage
add_filter('fluentform/rendering_field_html_text', function ($html, $data, $form) {
// Do your stuff here
return $html;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/rendering_field_html_' . $elementName, $html, $data, $form);
This filter is located in FluentForm\App\Services\FormBuilder\Components\Text -> compile($data, $form)
# fluentform/itl_options
You can modify international options for phone field using this filter.
Parameters
$itlOptions(array) International Options for Phone Field$data(array) Phone Field$form(object) Form Object
Usage
add_filter('fluentform/itl_options', function ($itlOptions, $data, $form) {
// Do your stuff here
return $itlOptions;
}, 10, 3);
2
3
4
5
6
$itlOptions = [
'separateDialCode' => false,
'nationalMode' => true,
'autoPlaceholder' => 'aggressive',
'formatOnDisplay' => true,
];
2
3
4
5
6
Reference
apply_filters('fluentform/itl_options', $itlOptions, $data, $form);
This filter is located in FluentForm\App\Services\FluentConversational\Classes\Converter\Converter -> getPhoneFieldSettings($data, $form)
# fluentform/ip_provider
This filter returns the IP provider used in the phone field.
Parameters
$url(array) IP provider URL
Usage
add_filter('fluentform/ip_provider', function ($url) {
// Do your stuff here
return $url;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/ip_provider', $url);
This filter is located in FluentForm\App\Services\FluentConversational\Classes\Converter\Converter -> getPhoneFieldSettings($data, $form)
# fluentform/available_date_formats
You can modify date formats using the filter.
Parameters
$dateFormats(array) Date formats
Usage
add_filter('fluentform/available_date_formats', function ($dateFormats) {
// Do your stuff here
return $dateFormats;
}, 10, 1);
2
3
4
5
6
Date formats to filter:
[
'm/d/Y' => 'm/d/Y - (Ex: 04/28/2018)', // USA
'd/m/Y' => 'd/m/Y - (Ex: 28/04/2018)', // Canada, UK
'd.m.Y' => 'd.m.Y - (Ex: 28.04.2019)', // Germany
'n/j/y' => 'n/j/y - (Ex: 4/28/18)',
'm/d/y' => 'm/d/y - (Ex: 04/28/18)',
'M/d/Y' => 'M/d/Y - (Ex: Apr/28/2018)',
'y/m/d' => 'y/m/d - (Ex: 18/04/28)',
'Y-m-d' => 'Y-m-d - (Ex: 2018-04-28)',
'd-M-y' => 'd-M-y - (Ex: 28-Apr-18)',
'm/d/Y h:i K' => 'm/d/Y h:i K - (Ex: 04/28/2018 08:55 PM)', // USA
'm/d/Y H:i' => 'm/d/Y H:i - (Ex: 04/28/2018 20:55)', // USA
'd/m/Y h:i K' => 'd/m/Y h:i K - (Ex: 28/04/2018 08:55 PM)', // Canada, UK
'd/m/Y H:i' => 'd/m/Y H:i - (Ex: 28/04/2018 20:55)', // Canada, UK
'd.m.Y h:i K' => 'd.m.Y h:i K - (Ex: 28.04.2019 08:55 PM)', // Germany
'd.m.Y H:i' => 'd.m.Y H:i - (Ex: 28.04.2019 20:55)', // Germany
'h:i K' => 'h:i K (Only Time Ex: 08:55 PM)',
'H:i' => 'H:i (Only Time Ex: 20:55)',
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Reference
apply_filters('fluentform/available_date_formats', $dateFormats);
This filter is located in FluentForm\App\Services\FormBuilder\Components\DateTime -> getAvailableDateFormats()
# fluentform/editor_countries
You can modify or add more countries using the filter.
Parameters
$country_names(array) Country Names List
Usage
add_filter('fluentform/editor_countries', function ($country_names) {
// Do your stuff here
return $country_names;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/editor_countries', $country_names);
This filter is located in FluentForm\App\Services\FormBuilder\CountryNames.php
# fluentform/form_settings_smartcodes
You can modify or add more smartcodes for form settings using the filter.
Parameters
$groups(array) All Shortcode Group$form(object) Form Object
Usage
add_filter('fluentform/form_settings_smartcodes', function ($groups, $form) {
// Do your stuff here
return $groups;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/form_settings_smartcodes', $groups, $form);
This filter is located in FluentForm\App\Services\FormBuilder\EditorShortcode -> getShortCodes($form)
# 'fluentform/validation_message_' . $ruleName
You can use this filter to modify the validation message of a specific rule.
Parameters
$message(string) Validation Message$item(object) Current Item
Usage
add_filter('fluentform/validation_message_' . $ruleName, function ($message, $item) {
// Do your stuff here
return $message;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/validation_message_' . $ruleName, $rule['message'], $item);
This filter is located in FluentForm\App\Services\FormBuilder\FormBuilder -> extractValidationRule($item)
# 'fluentform/validation_message_' . $item['element'] . '_' . $ruleName
You can use this filter to modify the validation message of an element rule.
Parameters
$message(string) Validation Message$item(object) Current Item
Usage
add_filter('fluentform/validation_message_' . $item['element'] . '_' . $ruleName, function ($message, $item) {
// Do your stuff here
return $message;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/validation_message_' . $item['element'] . '_' . $ruleName, $rule['message'], $item);
This filter is located in FluentForm\App\Services\FormBuilder\FormBuilder -> extractValidationRule($item)
# 'fluentform/item_rules_' . $item['element']
You can use this filter to modify the rules of an element.
Parameters
$message(string) Validation Message$item(object) Current Item
Usage
add_filter('fluentform/item_rules_' . $item['element'], function ($rules, $item) {
// Do your stuff here
return $rules;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/item_rules_' . $item['element'], $rule['message'], $item);
This filter is located in FluentForm\App\Services\FormBuilder\FormBuilder -> extractValidationRule($item)
# fluentform/will_return_html
You can use this filter to return Shortcode parsed data as HTML.
Parameters
$isHtml(boolean) Whether to return Parsed Data as HTML$isProvider(boolean) Whether provider data is HTML or not$key(string) Key Name
Usage
add_filter('fluentform/will_return_html', function ($isHtml, $isProvider, $key) {
// Do your stuff here
return $isHtml;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/will_return_html', $isHtml, $isProvider, $key);
This filter is located in FluentForm\App\Services\FormBuilder -> buildFormBody($form)
# fluentform/payment_smartcode
You can use this filter to modify smartcodes for Payment.
Parameters
$value(string) Form Data$property(array) Substring after {payment.$instance(Object) Shortcode Parser Instance
Usage
add_filter('fluentform/payment_smartcode', function ($value, $property, $instance) {
// Do your stuff here
return $item;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_smartcode', $value, $property, self::getInstance());
This filter is located in FluentForm\App\Services\FormBuilder\ShortcodeParser -> parseShortCodeFromString($parsable, $isUrl = false, $isHtml = false)
# fluentform/file_type_options
You can modify file types for upload files.
Parameters
$fileTypeOptions(array) Supported File Type Options
Usage
add_filter('fluentform/file_type_options', function ($fileTypeOptions) {
// Do your stuff here
return $fileTypeOptions;
}, 10, 1);
2
3
4
5
6
File Type Options Array:
$fileTypeOptions = [
[
'label' => __('Images (jpg, jpeg, gif, png, bmp)', 'fluentform'),
'value' => 'jpg|jpeg|gif|png|bmp',
],
[
'label' => __('Audio (mp3, wav, ogg, oga, wma, mka, m4a, ra, mid, midi)', 'fluentform'),
'value' => 'mp3|wav|ogg|oga|wma|mka|m4a|ra|mid|midi|mpga',
],
[
'label' => __('Video (avi, divx, flv, mov, ogv, mkv, mp4, m4v, divx, mpg, mpeg, mpe)', 'fluentform'),
'value' => 'avi|divx|flv|mov|ogv|mkv|mp4|m4v|divx|mpg|mpeg|mpe|video/quicktime|qt',
],
[
'label' => __('PDF (pdf)', 'fluentform'),
'value' => 'pdf',
],
[
'label' => __('Docs (doc, ppt, pps, xls, mdb, docx, xlsx, pptx, odt, odp, ods, odg, odc, odb, odf, rtf, txt)', 'fluentform'),
'value' => 'doc|ppt|pps|xls|mdb|docx|xlsx|pptx|odt|odp|ods|odg|odc|odb|odf|rtf|txt',
],
[
'label' => __('Zip Archives (zip, gz, gzip, rar, 7z)', 'fluentform'),
'value' => 'zip|gz|gzip|rar|7z',
],
[
'label' => __('Executable Files (exe)', 'fluentform'),
'value' => 'exe',
],
[
'label' => __('CSV (csv)', 'fluentform'),
'value' => 'csv',
],
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
Reference
apply_filters('fluentform/file_type_options', $fileTypeOptions);
This filter is located in FluentForm\App\Services\FormBuilder\ValidationRuleSettings
# fluentform/get_global_settings_values
You can modify global settings using the filter.
Parameters
$values(array) All Global Settings Values$key(string) Key Name
Usage
add_filter('fluentform/get_global_settings_values', function ($values, $key) {
// Do your stuff here
return $values;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/get_global_settings_values', $values, $key);
This filter is located in FluentForm\App\Services\GlobalSettings\GlobalSettingsService -> get($attributes = [])
# fluentform/entry_migration_max_limit
You can use this filter to set the submission migration limit.
Parameters
$maxLimit(int) Submission Migration Max Limit, By Default 1000;$key(string) Migration Key Name$totalEntries(array) Total Submissions$formId(int) Form ID
Usage
add_filter('fluentform/entry_migration_max_limit', function ($maxLimit, $key, $totalEntries, $formId) {
// Do your stuff here
return $maxLimit;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/entry_migration_max_limit', static::DEFAULT_ENTRY_MIGRATION_MAX_LIMIT, $this->key, $totalEntries, $formId);
This filter is located in FluentForm\App\Services\Migrator\Classes\CalderaMigrator -> getEntries($formId)
# fluentform/editor_shortcodes
You can use this filter to modify all the general shortcodes.
Parameters
$generalShortCodes(array) All General Shortcodes
Usage
add_filter('fluentform/editor_shortcodes', function ($generalShortCodes) {
// Do your stuff here
return $generalShortCodes;
}, 10, 1);
2
3
4
5
6
[
'title' => 'General SmartCodes',
'shortcodes' => [
'{wp.admin_email}' => __('Admin Email', 'fluentform'),
'{wp.site_url}' => __('Site URL', 'fluentform'),
'{wp.site_title}' => __('Site Title', 'fluentform'),
'{ip}' => __('IP Address', 'fluentform'),
'{date.m/d/Y}' => __('Date (mm/dd/yyyy)', 'fluentform'),
'{date.d/m/Y}' => __('Date (dd/mm/yyyy)', 'fluentform'),
'{embed_post.ID}' => __('Embedded Post/Page ID', 'fluentform'),
'{embed_post.post_title}' => __('Embedded Post/Page Title', 'fluentform'),
'{embed_post.permalink}' => __('Embedded URL', 'fluentform'),
'{http_referer}' => __('HTTP Referer URL', 'fluentform'),
'{user.ID}' => __('User ID', 'fluentform'),
'{user.display_name}' => __('User Display Name', 'fluentform'),
'{user.first_name}' => __('User First Name', 'fluentform'),
'{user.last_name}' => __('User Last Name', 'fluentform'),
'{user.user_email}' => __('User Email', 'fluentform'),
'{user.user_login}' => __('User Username', 'fluentform'),
'{browser.name}' => __('User Browser Client', 'fluentform'),
'{browser.platform}' => __('User Operating System', 'fluentform'),
'{random_string.your_prefix}' => __('Random String with Prefix', 'fluentform'),
],
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Reference
apply_filters('fluentform/editor_shortcodes', $generalShortCodes);
This filter is located in FluentForm\boot\globals.php -> fluentFormEditorShortCodes()
# fluentform/all_editor_shortcodes
You can use this filter to modify all the editor shortcodes.
Parameters
$generalShortCodes(array) All General Shortcodes$form(object) Form Object
Usage
add_filter('fluentform/all_editor_shortcodes', function ($editorShortCodes, $form) {
// Do your stuff here
return $editorShortCodes;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/all_editor_shortcodes', $editorShortCodes, $form);
This filter is located in FluentForm\boot\globals.php -> fluentFormGetAllEditorShortCodes($form)
# fluentform/dashboard_notices
You can use this filter to add dashboard notices.
Parameters
$notices(array) Notices
Usage
add_filter('fluentform/dashboard_notices', function ($notices) {
// Do your stuff here
return $notices;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/dashboard_notices', $notices);
This filter is located in FluentForm\app\views\admin\all_entries.php
# fluentform/permission_callback
This filter checks the permission callback status. You can check the current permission and change the permission status.
Parameters
$status(boolean) Permission Status$permission(string) Permission Name
Usage
add_filter('fluentform/permission_callback', function($status, $permission) {
// Do your staff
return $status;
}, 10, 2);
2
3
4
5
6
Reference apply_filters('fluentform/permission_callback', $status, $permission);
This filter is located in FluentForm\app\Hooks\filters.php
# Integration Filters
# fluentform/global_notification_active_types
This filter returns the active notification feeds for the current form ID.
Parameters
$types(array) Active Feeds
Usage
add_filter('fluentform/global_notification_active_types', function ($types) {
// Do your stuff here
$types['notifications'] = 'email_notifications';
return $types;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/global_notification_active_types', [], $form->id);
This filter is located in FluentForm\App\Hooks\Handlers\GlobalNotificationHandler -> globalNotify()
# 'fluentform/notifying_async_' . $integrationKey
This filter checks if the integration is asynchronous or not. If you are working on an integration you can return false to run the integration instantly.
Parameters
$status(boolean) True / False$formId(int) Form Id
Usage
add_filter('fluentform/notifying_async_' . $integrationKey, function ($status, $formId) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/notifying_async_' . $integrationKey, true, $form->id);
This filter is located in FluentForm\App\Hooks\Handlers\GlobalNotificationHandler -> globalNotify()
# fluentform/api_success_log
This filter checks the logging of the successful API calls for development environment status.
Parameters
$isDev(boolean) Checks whether development environment is Dev or Production$form(object) Form Object$feed(array) Current Feed object
Usage
add_filter('fluentform/api_success_log', function ($isDev, $form, $feed) {
// Do your stuff here
return $isDev;
}, 10, 3);
2
3
4
5
Reference
apply_filters('fluentform/api_success_log', $isDev, $form, $feed);
This filter is located in FluentForm\App\Hooks\actions.php
# fluentform/api_failed_log
This filter checks the logging of the failed API calls for development environment status.
Parameters
$isDev(boolean) Checks whether development environment is Dev or Production$form(object) Form$feed(array) Current Feed
Usage
add_filter('fluentform/api_failed_log', function($isDev, $form, $feed) {
// Do your stuff here
return $isDev;
}, 10, 3);
2
3
4
5
Reference
apply_filters('fluentform/api_failed_log', $isDev, $form, $feed);
This filter is located in FluentForm\App\Hooks\actions.php
# 'fluentform/get_integration_merge_fields_' . $integrationName
This filter return all merged fields for integration of the current form.
Parameters
$list(boolean) Checks whether list is True or False$listId(string) Get Integration List ID$formId(int) Form ID
Usage
add_filter('fluentform/get_integration_merge_fields_' . $integrationName, function ($list, $listId, $formId) {
// Do your stuff here
$mergedFields = $this->findMergeFields($listId);
$fields = [];
foreach ($mergedFields as $merged_field) {
$fields[$merged_field['tag']] = $merged_field['name'];
}
return $fields;
}, 10, 3);
2
3
4
5
6
7
8
9
10
11
12
Reference
apply_filters('fluentform/get_integration_merge_fields_' . $integrationName, false, $listId, $formId);
This filter is located in FluentForm\App\Https\Controllers\FormIntegrationController -> integrationListComponent()
# fluentform/validation_user_registration_errors
This filter return user registration validation error before submission.
Parameters
$errors(array) Errors$formData(array) Form Data$form(Object) Form Object$fields(array) Form Fields
Usage
add_filter('fluentform/validation_user_registration_errors', function($errors, $formData, $form, $fields) {
// Do your stuff here
return $errors;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/validation_user_registration_errors', $errors, $formData, $this->form, $fields);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateSubmission(&$fields, &$formData)
# fluentform/validation_user_update_errors
This filter return user update validation error before submission.
Parameters
$errors(array) Errors$formData(array) Form Data$form(Object) Form Object$fields(array) Form Fields
Usage
add_filter('fluentform/validation_user_update_errors', function($errors, $formData, $form, $fields) {
// Do your stuff here
return $errors;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/validation_user_update_errors', $errors, $formData, $this->form, $fields);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateSubmission(&$fields, &$formData)
# fluentform/mailchimp_keep_existing_interests
You can modify double optin status to keep existing interest in mailchimp using the filter.
Parameters
$status(string) Whether the Double Optin is pending or subscribed$formId(int) Form ID
Usage
add_filter('fluentform/mailchimp_keep_existing_interests', function ($status, $formId) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/mailchimp_keep_existing_interests', $status, $form->id);
This filter is located in FluentForm\App\Services\Integration\MailChimp\MailChimpSubscriber -> subscribe($feed, $formData, $entry, $form)
# fluentform/mailchimp_keep_existing_tags
You can modify to keep existing tags in mailchimp using the filter.
Parameters
$status(boolean) Whether the status is true or false$formId(int) Form ID
Usage
add_filter('fluentform/mailchimp_keep_existing_tags', function ($status, $formId) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/mailchimp_keep_existing_tags', true, $form->id);
This filter is located in FluentForm\App\Services\Integration\MailChimp\MailChimpSubscriber -> subscribe($feed, $formData, $entry, $form)
# 'fluentform/get_integration_values_' . $integrationName
You can modify integration mapped values and settings using the filter.
Parameters
$settings(array) Integration Settings$feed(array) Mapped Form Data$formId(int) Form ID
Usage
add_filter('fluentform/get_integration_values_' . $integrationName, function ($settings, $feed, $formId) {
// Do your stuff here
return $feed;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/get_integration_values_' . $integrationName, $settings, $feed, $formId);
This filter is located in FluentForm\App\Services\Integrations\GlobalIntegrationManager -> getIntegrationSettings()
# 'fluentform/get_integration_defaults_' . $integrationName
You can tweak integration default settings using the filter.
Parameters
$settings(array) Integration Settings$formId(int) Form ID
Usage
add_filter('fluentform/get_integration_values_' . $integrationName, function ($settings, $formId) {
// Do your stuff here
return $settings;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/get_integration_defaults_' . $integrationName, $settings, $formId);
This filter is located in FluentForm\App\Services\Integrations\GlobalIntegrationManager -> getIntegrationSettings()
# 'fluentform/save_integration_value_' . $integrationName
You can modify integration mapped form value before saving it to the database using the filter.
Parameters
$integration(array) Integration Settings$integrationId(int) Integration ID$formId(int) Form ID
Usage
add_filter('fluentform/save_integration_value_' . $integrationName, function ($integration, $integrationId, $formId) {
// Do your stuff here
return $integration;
}, 10, 3);
2
3
4
5
6
add_filter('fluentform/save_integration_value_mailchimp', [$this, 'sanitizeSettings'], 10, 3);
public function sanitizeSettings($integration, $integrationId, $formId)
{
if (fluentformCanUnfilteredHTML()) {
return $integration;
}
$sanitizeMap = [
'status' => 'rest_sanitize_boolean',
'enabled' => 'rest_sanitize_boolean',
'type' => 'sanitize_text_field',
'list_id' => 'sanitize_text_field',
'list_name' => 'sanitize_text_field',
'name' => 'sanitize_text_field',
'tags' => 'sanitize_text_field',
'tag_ids_selection_type' => 'sanitize_text_field',
'fieldEmailAddress' => 'sanitize_text_field',
'doubleOptIn' => 'rest_sanitize_bolean',
'resubscribe' => 'rest_sanitize_bolean',
'note' => 'sanitize_text_field',
];
return fluentform_backend_sanitizer($integration, $sanitizeMap);
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Reference
apply_filters('fluentform/save_integration_value_' . $integrationName, $integration, $integrationId, $formId);
This filter is located in FluentForm\App\Services\Integrations\GlobalIntegrationManager -> saveIntegrationSettings()
# 'fluentform/save_integration_value_' . $integrationName
You can modify integration settings value before saving it to the database using the filter.
Parameters
$data(array) Integration Settings$integrationId(int) Integration ID
Usage
add_filter('fluentform/save_integration_value_' . $integrationName, function ($data, $integrationId) {
// Do your stuff here
return $data;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/save_integration_value_' . $integrationName, $data, $integrationId);
This filter is located in FluentForm\App\Services\Integrations\GlobalIntegrationManager -> saveIntegrationSettings()
# fluentform/global_notification_types
You can use this filter to modify all global notifications keys.
Parameters
$notificationKeys(array) Global Notification Keys$formId(int) Form ID
Usage
add_filter('fluentform/global_notification_types', function ($notificationKeys, $formId) {
// Do your stuff here
return $notificationKeys;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/global_notification_types', $notificationKeys, $formId);
This filter is located in FluentForm\App\Services\Integration\GlobalIntegrationManager -> getAllFormIntegrations()
# 'fluentform/global_notification_feed_' . $feed->meta_key
You can use this filter to modify global notifications feed data.
Parameters
$feedData(array) Mapped Form Data$formId(int) Form ID
Usage
add_filter('fluentform/global_notification_feed_' . $feed->meta_key, function ($feedData, $formId) {
// Do your stuff here
return $feedData;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/global_notification_feed_' . $feed->meta_key, $feedData, $formId);
This filter is located in FluentForm\App\Services\Integration\GlobalIntegrationManager -> getNotificationFeeds($formId)
# fluentform/get_available_form_integrations
You can use this filter to modify all available integrations.
Parameters
$availableIntegrations(array) All Available Integrations$formId(int) Form ID
Usage
add_filter('fluentform/get_available_form_integrations', function ($availableIntegrations, $formId) {
// Do your stuff here
return $availableIntegrations;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/get_available_form_integrations', $availableIntegrations, $formId);
This filter is located in FluentForm\App\Services\Integration\GlobalIntegrationManager -> getAllFormIntegrations()
# 'fluentform/global_integration_settings_' . $settingsKey
You can use this filter to modify all integration field settings.
Parameters
$settings(array) All Available Integrations Field Settings
Usage
add_filter('fluentform/global_integration_settings_' . $settingsKey, function ($settings) {
// Do your stuff here
return $settings;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/global_integration_settings_' . $settingsKey', $settings);
This filter is located in FluentForm\App\Services\Integration\GlobalIntegrationManager -> getGlobalSettingsAjax()
# fluentform/global_addons
You can use this filter show global addons.
Parameters
$addons(string) All Addons
Usage
add_filter('fluentform/global_addons', function ($addons) use ($isEnabled) {
$addons[$this->integrationKey] = [
'title' => $this->title,
'category' => $this->category,
'disable_global_settings' => $this->disableGlobalSettings,
'description' => $this->description,
'config_url' => ('yes' != $this->disableGlobalSettings) ? admin_url('admin.php?page=fluent_forms_settings#general-' . $this->integrationKey . '-settings') : '',
'logo' => $this->logo,
'enabled' => ($isEnabled) ? 'yes' : 'no',
];
return $addons;
}, $this->priority, 1);
2
3
4
5
6
7
8
9
10
11
12
13
Reference
apply_filters('fluentform/global_addons', $addons);
This filter is located in FluentForm\app\Modules\AddOnModules -> showFluentAddOns()
# 'fluentform/integration_data_' . $this->integrationKey
You can modify any integration data through valid integration key before form submission by using this filter.
Parameters
$addData(array) Submitted Data$feed(array) Form Feed$entry(array) Submission
Usage
add_filter('fluentform/integration_data_' . $this->integrationKey, function ($addData, $feed, $entry) {
// Do your stuff here
return $addData;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/integration_data_' . $this->integrationKey, $addData, $feed, $entry);
This filter is located in FluentFormPro\src\Integrations\ActiveCampaign\Bootstrap -> notify($feed, $formData, $entry, $form)
# fluentform/integration_constantcontact_action_by
You can edit constant contact API url action using the filter.
Parameters
$actionName(array) Action Name
Usage
add_filter('fluentform/integration_constantcontact_action_by', function ($actionName) {
// Do your stuff here
return $actionName;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/integration_constantcontact_action_by', $actionName);
This filter is located in FluentFormPro\src\Integrations\ConstantContact\API -> getApiUrl($resource)
# fluentform/hubspot_field_data
You can modify hubspot feed field data before form submission using the filter.
Parameters
$fields(array) Form Fields$feed(array) Hubspot Feed$entry(array) Submission$form(object) Form Object
Usage
add_filter('fluentform/hubspot_field_data', function ($fields, $feed, $entry, $form) {
// Do your stuff here
return $fields;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/hubspot_field_data', $fields, $feed, $entry, $form);
This filter is located in FluentFormPro\src\Integrations\Hubspot\Bootstrap -> notify($feed, $formData, $entry, $form)
# fluentform/icontact_request_args
You can modify IContact GET / POST Feed data using the filter.
Parameters
$options(array) Feed Data$action(string) IContact API Action$method(string) GET/POST Method$return_key(string) Return Key
Usage
add_filter('fluentform/icontact_request_args', function ($options, $action, $method, $return_key) {
// Do your stuff here
return $options;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/icontact_request_args', $options, $action, $method, $return_key);
This filter is located in FluentFormPro\src\Integrations\IContact\IContactApi -> make_request( $action = null, $options = array(), $method = 'GET', $return_key = null )
# fluentform/integration_discord_message
You can modify discord message arguments using the filter.
Parameters
$messageArgs(array) Discord Message Args$feed(array) Form Feed
Usage
add_filter('fluentform/integration_discord_message', function ($messageArgs, $feed) {
// Do your stuff here
return $messageArgs;
}, 10, 2);
2
3
4
5
6
$messageArgs = [
'embeds' => [
0 => [
'fields' => $fields,
'title' => esc_html($messageTitle),
'url' => esc_url_raw($entryLink),
'description' => sanitize_text_field($description),
'color' => hexdec('3F9EFF'),
'footer' => [
'text' => sanitize_text_field($footer)
]
],
],
'content' => '*New submission on '. $form->title.' (#' . $entry->id . ')*'
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Reference
apply_filters('fluentform/integration_discord_message', $messageArgs, $feed);
This filter is located in FluentFormPro\src\Integrations\Discord\Bootstrap -> notify($feed, $formData, $entry, $form)
# fluentform/inventory_fields_before_render
You can use this filter to modify inventory form fields.
Parameters
$field(array) Form Fields$form(object) Form Object$previousSubmissionData(array) Previous Form Submission
Usage
add_filter('fluentform/inventory_fields_before_render', function ($field, $form, $previousSubmissionData) {
// Do your stuff here
return $field;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/inventory_fields_before_render', $field, $form, $previousSubmissionData);
This filter is located in FluentFormPro\src\classes\Inventory\InventoryFieldsRenderer -> processInventoryFields($field, $form, $previousSubmissionData)
# fluentform/inventory_inputs
You can use this filter to modify inventory input fields.
Parameters
$fields(array) Inventory Input Fields
Usage
add_filter('fluentform/inventory_inputs', function ($fields) {
// Do your stuff here
return $fields;
}, 10, 1);
2
3
4
5
6
$fields = [
'select',
'input_radio',
'input_checkbox',
'multi_payment_component'
];
2
3
4
5
6
Reference
apply_filters('fluentform/inventory_inputs', $fields);
This filter is located in FluentFormPro\src\classes\Inventory\InventorySettingsManager -> getInventoryInputs()
# fluentform/inventory_validation_error
You can use this filter to modify inventory stock out error message.
Parameters
$stockOutMsg(string) Error Message$fieldName(array) Inventory Fields$item(array) Inventory Item$formData(array) Form Data$form(object) Form
Usage
add_filter('fluentform/inventory_validation_error', function ($stockOutMsg, $fieldName, $item, $formData, $form) {
// Do your stuff here
return $stockOutMsg;
}, 10, 5);
2
3
4
5
6
Reference
apply_filters('fluentform/inventory_validation_error', $stockOutMsg, $fieldName, $item, $this->formData, $this->form);
This filter is located in FluentFormPro\src\classes\Inventory\InventoryValidation -> validate()
# Miscellaneous Filters
# fluentform/file_upload_options
You can change Fluent Forms default file upload location by using this filter.
Parameters
$locations(array) File Upload Location
Usage
add_filter('fluentform/file_upload_options', function ($locations){
// Do your stuff here
}, 10, 1);
2
3
4
Reference
apply_filters('fluentform/file_upload_options', $locations);
This filter is located in FluentForm\App\Helpers\Helper -> fileUploadLocations()
# fluentform/skip_no_conflict
You can toggle the no conflict mode using this filter.
Parameters
$isConflict(boolean) Whether no conflict mode is enabled
Usage
add_filter('fluentform/skip_no_conflict', function ($isSkip) {
// Do your stuff here
return $isSkip;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/skip_no_conflict', $isSkip);
This filter is located in FluentForm\App\Hooks\actions.php
# fluentform/permission_set
You can add or modify Fluentform Permission Set using this filter.
Parameters
$permissionSet(array) Permission set
Usage
add_filter('fluentform/permission_set', function ($permissionSet) {
// Do your stuff here
array_push($permissionSet, 'fluentform_dashboard_access');
return $permissionSet;
}, 10, 1);
2
3
4
5
6
7
Reference
apply_filters('fluentform/permission_set', $data);
This filter is located in FluentForm\App\Modules\Acl -> getPermissionSet()
# 'fluentform/verify_user_permission_' . $permission
This filter verifies each permission.
Parameters
$allowed(array) Form default Settings$formId(int) Form ID
Usage
add_filter('fluentform/verify_user_permission_' . $permission, function ($allowed, $formId) {
// Do your stuff here
return $allowed;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/verify_user_permission_' . $permission, $allowed, $formId);
This filter is located in FluentForm\App\Modules\Acl -> hasPermission($permissions, $formId = false)
# fluentform/current_user_capability
You can modify Current User Capability using this filter.
Parameters
$capability(array) User Capabilities
Usage
add_filter('fluentform/current_user_capability', function ($capability) {
// Do your stuff here
return $capability;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/current_user_capability', static::$capability);
This filter is located in FluentForm\App\Modules\Acl -> getCurrentUserCapability()
# fluentform/current_user_permissions
You can modify Current User Permission using this filter.
Parameters
$userPermissions(array) Current User Permissions
Usage
add_filter('fluentform/current_user_permissions', function ($userPermissions) {
// Do your stuff here
return $userPermissions;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/current_user_permissions', $userPermissions);
This filter is located in FluentForm\App\Models\Form -> getUserPermissions($user = false)
# fluentform/nonce_error
You can modify NONCE error message using this filter.
Parameters
$errorMessage(string) Error Message
Usage
add_filter('fluentform/nonce_error', function ($errorMessage) {
// Do your stuff here
return $errorMessage;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/nonce_error', $message);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateNonce()
# fluentform/shortcode_defaults
This filter sets the defaults values for the shortcode.
Parameters
$defaults(array) Default Shortcode Values$atts(array) Shortcode Attributes
Usage
add_filter('fluentform/shortcode_defaults', function($defaults , $atts) {
// Do your stuff here
return $atts;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/shortcode_defaults', $data, $atts);
This filter is located in FluentForm\App\Modules\Component\Component -> addFluentFormShortCode()
# fluentform/shortcode_feed_text
This filter returns the message of the shortcode for a feed.
Parameters
$feedText(string) Shortcode Feed Text$form(object) Form Object
Usage
add_filter('fluentform/shortcode_feed_text', function ($feedText, $form) {
// Do your stuff here
return $feedText;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/shortcode_feed_text', $feedText, $form);
This filter is located in FluentForm\App\Modules\Component\Component -> renderForm($atts)
# fluentform/parse_default_value
You can modify form default shortcode value using this filter.
Parameters
$value(string) Parseable Shortcode Value$form(object) Form Object
Usage
add_filter('fluentform/parse_default_value', function($value, $form) {
// Do your stuff here
return $value;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/parse_default_value', $attrDefaultValues[$pattern], $form);
This filter is located in FluentForm\App\Modules\Component\Component -> replaceEditorSmartCodes($output, $form)
# fluentform/parse_default_values
You can modify Shortcode's all parseable values using this filter.
Parameters
$attrDefaultValues(array) Parseable All Shortcode Values
Usage
add_filter('fluentform/parse_default_values', function($attrDefaultValues) {
// Do your stuff here
return $attrDefaultValues;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/parse_default_values', $attrDefaultValues);
This filter is located in FluentForm\App\Modules\Component\Component -> replaceEditorSmartCodes($output, $form)
# fluentform/akismet_fields
This filter is used in the Akismet handler.
Parameters
$info(array) Akismet Data$data(array) Form Data$form(object) Form Object
Usage
add_filter('fluentform/akismet_fields', function ($info, $data, $form) {
// Do your stuff here
return $info;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/akismet_fields', $info, $data, $form);
This filter is located in FluentForm\App\Modules\AkismetHandler -> getAkismetFields($data, $form)
# fluentform/find_shortcode_params
This filter returns Fluent Forms shortcode used in the site.
Parameters
$params(array) Post Type
Usage
add_filter('fluentform/find_shortcode_params', function($params) {
// Do your stuff here
return $params;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/find_shortcode_params', $params);
This filter is located in FluentForm\App\Services\Form\FormService -> findShortCodePage($formId)
# fluentform/will_parse_url_value
You can toggle redirect URL parsing in confirmation Message using the filter.
Parameters
$status(boolean) Whether Parse the URL$form(object) Form Object
Usage
add_filter('fluentform/will_parse_url_value', function($status, $form) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/will_parse_url_value', $parseUrl, $form);
This filter is located in FluentForm\App\Services\Form\SubmissionHandlerServices -> getReturnData($insertId, $form, $formData)
# fluentform/akismet_check_spam
You can toggle Akismet spam checking using this filter.
Parameters
$status(boolean) Whether Spam Check is enabled$formId(int) Form ID$formData(array) Form Data
Usage
add_filter('fluentform/akismet_check_spam', function($status, $formId, $formData) {
// Do your stuff here
return $status;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/akismet_check_spam', $isSpamCheck, $form->id, $formData);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> isSpam($formData, $form)
# fluentform/akismet_spam_result
You can toggle Akismet spam result using this filter.
Parameters
$isSpam(boolean) Whether Spam Check is enabled$formId(int) Form ID$formData(array) Form Data
Usage
add_filter('fluentform/akismet_spam_result', function($isSpam, $formId, $formData) {
// Do your stuff here
return $defaultSettings;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/akismet_spam_result', $isSpam, $form->id, $formData);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> isSpam($formData, $form)
# fluentform/has_recaptcha
You can toggle Recaptcha using this filter.
Parameters
$status(boolean) Whether Recaptcha is enabled
Usage
add_filter('fluentform/has_recaptcha', function($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/has_recaptcha', $hasAutoRecap);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateReCaptcha()
# fluentform/has_hcaptcha
You can toggle Hcaptcha using this filter.
Parameters
$status(boolean) Whether Hcaptcha is enabled
Usage
add_filter('fluentform/has_hcaptcha', function($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/has_hcaptcha', $hasAutoHcap);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateHCaptcha()
# fluentform/has_turnstile
You can toggle Turnstile using this filter.
Parameters
$status(boolean) Whether Turnstile is enabled
Usage
add_filter('fluentform/has_turnstile', function($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/has_turnstile', $hasAutoTurnsTile);
This filter is located in FluentForm\App\Services\Form\FormValidationService -> validateTurnstile()
# fluentform/recaptcha_v3_ref_score
You can set Recaptcha Reference Score using this filter. By default, score is set to 0.5.
Parameters
$scoreReference Score between 0 and 1
Usage
add_filter('fluentform/recaptcha_v3_ref_score', function($score) {
// Do your stuff here
return $score;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentforms/recaptcha_v3_ref_score', $value);
This filter is located in FluentForm\App\Modules\ReCaptcha\ReCaptcha -> validate($token, $secret = null, $version = ' v2_visible')
# 'fluentform/editor_shortcode_callback_group_' . $group
You can modify shortcode group using the filter.
Parameters
$handler(array) All Shortcode Group$form(object) Form Object$handlerArray(array) Shortcode Handlers Group
Usage
add_filter('fluentform/editor_shortcode_callback_group_' . $group, function ($handler, $form, $handlerArray) {
// Do your stuff here
return '{' . $handler . '}';
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/editor_shortcode_callback_group_' . $group, '{' . $handler . '}', $form, $handlerArray);
This filter is located in FluentForm\App\Services\FormBuilder\EditorShortcodeParser -> filter($value, $form)
# 'fluentform/editor_shortcode_callback_' . $handler
You can modify shortcode handler using the filter.
Parameters
$handler(array) Shortcode Handler Array$form(object) Form Object
Usage
add_filter('fluentform/editor_shortcode_callback_' . $handler, function ($handler, $form) {
// Do your stuff here
return $handler;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/editor_shortcode_callback_' . $handler, $handler, $form);
This filter is located in FluentForm\App\Services\FormBuilder\EditorShortcodeParser -> filter($value, $form)
# fluentform/editor_element_customization_settings
This filter returns the input element settings components in editor.
Parameters
$settings(array) Element settings
Usage
add_filter('fluentform/editor_element_customization_settings', function ($settings) {
if ($customSettings = $this->getEditorCustomizationSettings()) {
$settings = array_merge($settings, $customSettings);
}
return $settings;
}, 10, 1);
2
3
4
5
6
7
8
Reference
apply_filters('fluentform/editor_element_customization_settings', $element_customization_settings);
This filter is located in FluentForm\App\Services\FormBuilder\ElementCustomization
# fluentform/html_attributes
You can use this filter to modify the form attributes before form render.
Parameters
$data(array) Form HTML attributes$form(object) Form Object
Usage
add_filter('fluentform/html_attributes', function ($data, $form) {
// Do your stuff here
return $data;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/html_attributes', $data, $form);
This filter is located in FluentForm\App\Services\FormBuilder\FormBuilder -> build($form, $extraCssClass = '', $instanceCssClass = '', $atts = [])
# fluentform/all_data_skip_password_field
You can use this filter to skip password for {all_data} shortcode.
Parameters
$status(boolean) Whether to skip the password field
Usage
add_filter('fluentform/all_data_skip_password_field', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/all_data_skip_password_field', __return_true());
This filter is located in FluentForm\App\Services\FormBuilder\ShortcodeParser -> getOtherData($key)
# fluentform/all_data_without_hidden_fields
You can use this filter to skip hidden field for {all_data} shortcode.
Parameters
$status(boolean) Whether to skip the hidden field
Usage
add_filter('fluentform/all_data_without_hidden_fields', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/all_data_without_hidden_fields', __return_true());
This filter is located in FluentForm\App\Services\FormBuilder\ShortcodeParser -> getOtherData($key)
# fluentform/all_data_shortcode_html
You can use this filter to modify {all_data} shortcode as HTML.
Parameters
$html(string) HTML string$formFields(array) Form Fields$inputLabels(array) Input Labels$response(object) Form Response
Usage
add_filter('fluentform/all_data_shortcode_html', function ($html, $formFields, $inputLabels, $response) {
// Do your stuff here
return $html;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/all_data_shortcode_html', __return_true());
This filter is located in FluentForm\App\Services\FormBuilder\ShortcodeParser -> getOtherData($key)
# fluentform/shortcode_parser_callback_pdf.download_link.public
You can use this filter to modify the public PDF download link.
Parameters
$key(string) Key Name$instance(object) Shortcode Parser Instance
Usage
add_filter('fluentform/shortcode_parser_callback_pdf.download_link.public', function ($key, $instance) {
// Do your stuff here
return $key;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/shortcode_parser_callback_pdf.download_link.public', $key, $instance);
This filter is located in FluentForm\App\Services\FormBuilder -> getOtherData($key)
# fluentform/shortcode_parser_callback_random_string
You can use this filter to modify the any shortcode with random string.
Parameters
$value(string) Name of the Shortcode after .$prefix(string) Prefix of the Shortcode before .$instance(object) Shortcode Parser Instance
Usage
add_filter('fluentform/shortcode_parser_callback_random_string', function ($value, $prefix, $instance) {
// Do your stuff here
return $value;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/shortcode_parser_callback_random_string', $value, $prefix, static::getInstance());
This filter is located in FluentForm\App\Services\FormBuilder -> getOtherData($key)
# 'fluentform/smartcode_group_' . $group
You can use this filter to modify the smartcode with a specific group.
Parameters
$property(string) Smartcode Name$instance(object) Shortcode Parser Instance
Usage
add_filter('fluentform/smartcode_group_' . $group, function ($property, $instance) {
// Do your stuff here
return $value;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/smartcode_group_' . $group, $property, static::getInstance());
This filter is located in FluentForm\App\Services\FormBuilder -> getOtherData($key)
# 'fluentform/shortcode_parser_callback_' . $key
You can use this filter to modify the any shortcode with matching key.
Parameters
$key(string) Key Name$instance(object) Shortcode Parser Instance
Usage
add_filter('fluentform/shortcode_parser_callback_' . $key, function ($key, $instance) {
// Do your stuff here
return $key;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/shortcode_parser_callback_' . $key, static::getInstance());
This filter is located in FluentForm\App\Services\FormBuilder -> getOtherData($key)
# fluentform/editor_validation_rule_settings
You can modify validation rule for any input using the filter.
Parameters
$validation_rule_settings(array) Validation Rule Settings for all input
Usage
add_filter('fluentform/editor_validation_rule_settings', function ($validation_rule_settings) {
// Do your stuff here
return $validation_rule_settings;
}, 10, 1);
2
3
4
5
6
$validation_rule_settings = [
'required' => [
'template' => 'inputRadio',
'label' => __('Required', 'fluentform'),
'help_text' => __('Select whether this field is a required field for the form or not.', 'fluentform'),
'options' => [
[
'value' => true,
'label' => __('Yes', 'fluentform'),
],
[
'value' => false,
'label' => __('No', 'fluentform'),
],
],
],
'valid_phone_number' => [
'template' => 'inputRadio',
'label' => __('Validate Phone Number', 'fluentform'),
'help_text' => __('Select whether the phone number should be validated or not.', 'fluentform'),
'options' => [
[
'value' => true,
'label' => __('Yes', 'fluentform'),
],
[
'value' => false,
'label' => __('No', 'fluentform'),
],
],
],
'email' => [
'template' => 'inputRadio',
'label' => __('Validate Email', 'fluentform'),
'help_text' => __('Select whether to validate this field as email or not', 'fluentform'),
'options' => [
[
'value' => true,
'label' => __('Yes', 'fluentform'),
],
[
'value' => false,
'label' => __('No', 'fluentform'),
],
],
],
'url' => [
'template' => 'inputRadio',
'label' => __('Validate URL', 'fluentform'),
'help_text' => __('Select whether to validate this field as URL or not', 'fluentform'),
'options' => [
[
'value' => true,
'label' => __('Yes', 'fluentform'),
],
[
'value' => false,
'label' => __('No', 'fluentform'),
],
],
],
'min' => [
'template' => 'inputText',
'type' => 'number',
'label' => __('Min Value', 'fluentform'),
'help_text' => __('Minimum value for the input field.', 'fluentform'),
],
'digits' => [
'template' => 'inputText',
'type' => 'number',
'label' => __('Digits', 'fluentform'),
'help_text' => __('Number of digits for the input field.', 'fluentform'),
],
'max' => [
'template' => 'inputText',
'type' => 'number',
'label' => __('Max Value', 'fluentform'),
'help_text' => __('Maximum value for the input field.', 'fluentform'),
],
'max_file_size' => [
'template' => 'maxFileSize',
'label' => __('Max File Size', 'fluentform'),
'help_text' => __('The file size limit uploaded by the user.', 'fluentform'),
],
'max_file_count' => [
'template' => 'inputText',
'type' => 'number',
'label' => __('Max Files Count', 'fluentform'),
'help_text' => __('Maximum user file upload number.', 'fluentform'),
],
'allowed_file_types' => [
'template' => 'inputCheckbox',
'label' => __('Allowed Files', 'fluentform'),
'help_text' => __('Allowed Files', 'fluentform'),
'fileTypes' => [
[
'title' => __('Images', 'fluentform'),
'types' => ['jpg', 'jpeg', 'gif', 'png', 'bmp'],
],
[
'title' => __('Audio', 'fluentform'),
'types' => ['mp3', 'wav', 'ogg', 'oga', 'wma', 'mka', 'm4a', 'ra', 'mid', 'midi'],
],
[
'title' => __('Video', 'fluentform'),
'types' => [
'avi',
'divx',
'flv',
'mov',
'ogv',
'mkv',
'mp4',
'm4v',
'divx',
'mpg',
'mpeg',
'mpe',
],
],
[
'title' => __('PDF', 'fluentform'),
'types' => ['pdf'],
],
[
'title' => __('Docs', 'fluentform'),
'types' => [
'doc',
'ppt',
'pps',
'xls',
'mdb',
'docx',
'xlsx',
'pptx',
'odt',
'odp',
'ods',
'odg',
'odc',
'odb',
'odf',
'rtf',
'txt',
],
],
[
'title' => __('Zip Archives', 'fluentform'),
'types' => ['zip', 'gz', 'gzip', 'rar', '7z', ],
],
[
'title' => __('Executable Files', 'fluentform'),
'types' => ['exe'],
],
[
'title' => __('CSV', 'fluentform'),
'types' => ['csv'],
],
],
'options' => $fileTypeOptions,
],
'allowed_image_types' => [
'template' => 'inputCheckbox',
'label' => __('Allowed Images', 'fluentform'),
'help_text' => __('Allowed Images', 'fluentform'),
'fileTypes' => [
[
'title' => __('JPG', 'fluentform'),
'types' => ['jpg|jpeg', ],
],
[
'title' => __('PNG', 'fluentform'),
'types' => ['png'],
],
[
'title' => __('GIF', 'fluentform'),
'types' => ['gif'],
],
],
'options' => [
[
'label' => __('JPG', 'fluentform'),
'value' => 'jpg|jpeg',
],
[
'label' => __('PNG', 'fluentform'),
'value' => 'png',
],
[
'label' => __('GIF', 'fluentform'),
'value' => 'gif',
],
],
],
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
Reference
apply_filters('fluentform/editor_validation_rule_settings', $validation_rule_settings);
This filter is located in FluentForm\App\Services\FormBuilder\ValidationRuleSettings
# fluentform/cleanup_days_count
You can use this filter to set days count for cleanup old data through scheduler.
Parameters
$days(int) Days Count, By default 60
Usage
add_filter('fluentform/cleanup_days_count', function ($days) {
// Do your stuff here
return $days;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/cleanup_days_count', $days);
This filter is located in FluentForm\App\Services\Scheduler\Scheduler -> cleanUpOldData()
# fluentform/allowed_html_tags
You can use this filter to add HTML attributes for sanitization.
Parameters
$tags(array) HTML Attributes
Usage
add_filter('fluentform/allowed_html_tags', function ($tags) {
// Do your stuff here
return $tags;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/allowed_html_tags', $tags);
This filter is located in FluentForm\boot\globals.php -> fluentform_sanitize_html($html)
# fluentform/backend_sanitized_values
You can use this filter to add inputs values for sanitization.
Parameters
$inputs(array) Form Inputs
Usage
add_filter('fluentform/backend_sanitized_values', function ($inputs) {
// Do your stuff here
return $inputs;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/backend_sanitized_values', $inputs);
This filter is located in FluentForm\boot\globals.php -> fluentform_backend_sanitizer($inputs, $sanitizeMap = [])
# fluentform/disable_fields_sanitize
You can use this filter to toggle disable fields sanitization.
Parameters
$status(boolean) Whether disabled fields sanitization is enabled
Usage
add_filter('fluentform/disable_fields_sanitize', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/disable_fields_sanitize', $status);
This filter is located in FluentForm\boot\globals.php -> fluentformCanUnfilteredHTML()
# fluentform/disabled_components
You can use this filter to modify disabled components.
Parameters
$disabled(array) Disabled Components
Usage
add_filter('fluentform/disabled_components', function ($disabled) {
// Do your stuff here
return $disabled;
}, 10, 1);
2
3
4
5
6
$disabled['ratings'] = [
'disabled' => true,
'title' => __('Ratings', 'fluentform'),
'description' => __('Ratings is not available with the free version. Please upgrade to pro to get all the advanced features.', 'fluentform'),
'image' => '',
'video' => 'https://www.youtube.com/embed/YGdkNspMaEs',
];
$disabled['tabular_grid'] = [
'disabled' => true,
'title' => __('Checkable Grid', 'fluentform'),
'description' => __('Checkable Grid is not available with the free version. Please upgrade to pro to get all the advanced features.', 'fluentform'),
'image' => '',
'video' => 'https://www.youtube.com/embed/ayI3TzXXANA',
];
2
3
4
5
6
7
8
9
10
11
12
13
14
Reference
apply_filters('fluentform/disabled_components', $disabled);
This filter is located in FluentForm\app\Services\Form\FormServices -> getDisabledComponents()
# fluentform/validation_error
This filter hook is fired before form render. You can use this to change rendered form.
Parameters
$errors(array) Validation Errors$formData(array) Form Data$form(object) Form Object$fields(array) Form Fields
Usage
add_filter('fluentform/validation_error', function ($errors, $formData, $form, $fields) {
// Do your stuff here
return $returnData;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/validation_error', $errors, $this->form, $fields, $this->formData);
This filter is located in FluentForm\app\Services\Form\SubmissionHandlerService -> getReturnData($insertId, $form, $formData)
# fluentform/nonce_verify
You can use this to toggle the nonce verification of the rendered form.
Parameters
$status(boolean) Whether the nonce verification is enabled$formId(int) Form ID
Usage
add_filter('fluentform/nonce_verify', function ($status, $formId) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/nonce_verify', false, $formId);
This filter is located in FluentForm\app\Services\Form\FormValidationService -> validateNonce()
# fluentform/https_local_ssl_verify
You can use this to toggle the local SSL verification for async requests.
Parameters
$status(boolean) Whether local SSL verification is enabled
Usage
add_filter('fluentform/https_local_ssl_verify', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/https_local_ssl_verify', false);
This filter is located in FluentForm\app\Services\WPAsync\FluentFormAsyncRequest -> dispatchAjax($data = [])
# fluentform/conditional_shortcode_defaults
You can use this filter to modify shortcode default.
Parameters
$default(array) Shortcode Default$atts(array) Shortcode Attributes
Usage
add_filter('fluentform/conditional_shortcode_defaults', function ($default, $atts) {
// Do your stuff here
return $default;
}, 10, 2);
2
3
4
5
6
$default = [
'field' => '',
'is' => '',
'to' => ''
];
2
3
4
5
Reference
apply_filters('fluentform/conditional_shortcode_defaults', $default, $atts);
This filter is located in FluentFormPro\src\classes\ConditionalContent -> handle($atts, $content)
# fluentform/disable_attachment_delete
You can toggle double option confirmation file attachment by using this filter.
Parameters
$status(boolean) Whether the attachment is disabled$formId(int) Form ID
Usage
add_filter('fluentform/disable_attachment_delete', function ($status, $formId) {
// Do your stuff here
return $status;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/disable_attachment_delete', $status, $entry->form_id));
This filter is located in FluentFormPro\src\classes\DoubleOption -> deleteAssociateFiles($entry)
# fluentform/style_presets
You can modify form styler by using this filter.
Parameters
$presets(array) Form Styler Presets
Usage
add_filter('fluentform/style_presets', function ($presets) {
// Do your stuff here
return $presets;
}, 10, 1);
2
3
4
5
6
$presets = [
'' => [
'label' => __('Default', ''),
'src' => ''
],
'ffs_modern_b' => [
'label' => __('Modern (Bold)', ''),
'src' => FLUENTFORMPRO_DIR_URL . 'public/css/skin_modern_bold.css'
],
'ffs_modern_l' => [
'label' => __('Modern (Light)', ''),
'src' => FLUENTFORMPRO_DIR_URL . 'public/css/skin_modern_light.css'
],
'ffs_classic' => [
'label' => __('Classic', ''),
'src' => FLUENTFORMPRO_DIR_URL . 'public/css/skin_classic.css'
],
'ffs_bootstrap' => [
'label' => __('Bootstrap Style', ''),
'src' => FLUENTFORMPRO_DIR_URL . 'public/css/skin_bootstrap.css'
],
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
Reference
apply_filters('fluentform/style_presets', $presets);
This filter is located in FluentFormPro\src\classes\FormStyler -> getPresets()
# fluentform/post_type_selection_types_args
You can modify post type args using this filter.
Parameters
$args(array) Post Type Args
Usage
add_filter('fluentform/post_type_selection_types_args', function ($args) {
// Do your stuff here
return $args;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/post_type_selection_types_args', $args);
This filter is located in FluentFormPro\src\Components\PostSelectionField -> generalEditorElement()
# fluentform/post_selection_types
You can modify post selection types using this filter.
Parameters
$formattedTypes(array) Post Selection Types
Usage
add_filter('fluentform/post_selection_types', function ($formattedTypes) {
// Do your stuff here
return $formattedTypes;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/post_selection_types', $formattedTypes);
This filter is located in FluentFormPro\src\Components\PostSelectionField -> generalEditorElement()
# fluentform/pdf_html_format
You can set HTML formatted value on PDF header, body or footer using this filter.
Parameters
$feed(array) PDF parts (header, body or footer)
Usage
add_filter('fluentform/pdf_html_format', function($feed) {
$feed[] = 'body';
return $feed;
}, 10, 1);
2
3
4
5
Reference
apply_filters('fluentform/pdf_html_format', []);
This filter is located in FluentForm\app\Hooks\Filters.php
# fluentform/email_exists_validation_message
Change User registration existing email validation message
Parameters
validationMsg(string) Message$form(object) Form Object$feed(array) Integraion Feed Data$email(string) Email
Usage
add_filter('fluentform/email_exists_validation_message', function($validationMsg) {
$validationMsg = "This email is already registered. Please choose another one.";
return $validationMsg;
}, 10, 1);
2
3
4
5
Reference
apply_filters('fluentform/email_exists_validation_message', $validationMsg, $form, $feed, $email);
This filter is located in fluentformpro/src/Integrations/UserRegistration/UserRegistrationApi.php
# Email Filters
# fluentform/email_summary_config
You can use this filter to modify email summary configuration.
Parameters
$config(array) Email Summary Configuration
Usage
add_filter('fluentform/email_summary_config', function ($config) {
// Do your stuff here
return $config;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/email_summary_config', $config);
This filter is located in FluentForm\App\Services\Scheduler\Scheduler -> processEmailReport()
# fluentform/email_summary_body
You can use this filter to modify email body.
Parameters
$emailBody(string) Email Body$data(string) Email Send Data
Usage
add_filter('fluentform/email_summary_body', function ($emailBody, $data) {
// Do your stuff here
return $emailBody;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/email_summary_body', $emailBody, $data);
This filter is located in FluentForm\App\Services\Scheduler\Scheduler -> processEmailReport()
# fluentform/email_summary_subject
You can use this filter to modify email subject.
Parameters
$emailSubject(string) Email Subject
Usage
add_filter('fluentform/email_summary_subject', function ($$emailSubject) {
// Do your stuff here
return $emailSubject;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/email_summary_subject', $emailSubject);
This filter is located in FluentForm\App\Services\Scheduler\Scheduler -> processEmailReport()
# fluentform/email_summary_body_text
You can use this filter to modify email summary body.
Parameters
$generateText(string) Email Summary Body$submissions(array) All Submissions
Usage
add_filter('fluentform/email_summary_body_text', function ($generateText, $submissions) {
// Do your stuff here
return $generateText;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/email_summary_body_text', $generateText, $submissions);
This filter is located in FluentForm\app\views\email\report\body.php
# fluentform/email_summary_footer_text
You can use this filter to modify email summary footer.
Parameters
$footerText(string) Email Summary Footer
Usage
add_filter('fluentform/email_summary_footer_text', function ($footerText) {
// Do your stuff here
return $footerText;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/email_summary_footer_text', $footerText);
This filter is located in FluentForm\app\views\email\report\body.php
# fluentform/email_template_footer_credit
You can use this filter to modify email template footer credit text.
Parameters
$poweredBy(string) Credit Text By Default Powered by FluentForm$form(object) Form Object$notification(array) Email Notification
Usage
add_filter('fluentform/email_template_footer_credit', function ($poweredBy, $form, $notification) {
// Do your stuff here
return $footerText;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/email_template_footer_credit', $poweredBy, $form, $notification);
This filter is located in FluentForm\app\views\email\template\footer.php
# fluentform/email_template_email_heading
You can use this filter to toggle email template header.
Parameters
$status(boolean) Whether the email heading is enabled$form(object) Form Object$notification(array) Email Notification
Usage
add_filter('fluentform/email_template_email_heading', function ($status, $form, $notification) {
// Do your stuff here
return $status;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/email_template_email_heading', false, $form, $notification);
This filter is located in FluentForm\app\views\email\template\header.php
# fluentform/email_template_header_image
You can use this filter to toggle email header image.
Parameters
$status(boolean) Whether the email header image is enabled$form(object) Form Object$notification(array) Email Notification
Usage
add_filter('fluentform/email_template_header_image', function ($status, $form, $notification) {
// Do your stuff here
return $status;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/email_template_header_image', false, $form, $notification);
This filter is located in FluentForm\app\views\email\template\header.php
# fluentform/email_content_type_header
You can use this filter to add email content type to header.
Parameters
$contentType(string) Email Header Content Type By Default, text/html; charset=UTF-8
Usage
add_filter('fluentform/email_content_type_header', function ($contentType) {
// Do your stuff here
return $contentType;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/email_content_type_header', false, $form, $notification);
This filter is located in FluentForm\app\views\email\template\header.php
# fluentform/email_template_colors
You can use this filter to modify email template colors.
Parameters
$colors(array) Colors
Usage
add_filter('fluentform/email_template_colors', function ($colors) {
// Do your stuff here
return $colors;
}, 10, 1);
2
3
4
5
6
$colors = array(
'background_color' => '#f6f6f6',
'body_background_color' => '#ffffff',
'base_color' => '#444444',
'text_color' => '#444444'
);
2
3
4
5
6
Reference
apply_filters('fluentform/email_template_colors', $colors);
This filter is located in FluentForm\app\views\email\template\styles.php
# fluentform/email_form_resume_link_config
You can change form resume link for partial submission of forms by using this filter.
Parameters
$emailFormat(array) Email Format$submittedData(array) Partial Submitted Data$requestData(array) Request Data$form(object) Form
Usage
add_filter('fluentform/email_form_resume_link_config', function ($emailFormat, $submittedData, $requestData, $form) {
// Do your stuff here
return $emailFormat;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/email_form_resume_link_config', $emailFormat, $submittedData, $requestData, $form));
This filter is located in FluentFormPro\src\classes\DraftSubmissionsManager -> emailProgressLink()
# fluentform/email_resume_link_response
You can modify email resume link confirmation message by using this filter.
Parameters
$message(string) Email Confirmation Message
Usage
add_filter('fluentform/email_resume_link_response', function ($message) {
// Do your stuff here
return $message;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/email_resume_link_response', $message);
This filter is located in FluentFormPro\src\classes\DraftSubmissionsManager -> emailProgressLink()
# fluentform/email_resume_link_body
You can modify email body of resume link for partial submission by using this filter.
Parameters
$emailBody(string) Email Body$form(object) Form Object$link(string) Email Resume Link
Usage
add_filter('fluentform/email_resume_link_body', function ($emailBody, $form, $link) {
// Do your stuff here
return $emailBody;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/email_resume_link_body', $emailBody, $form, $link);
This filter is located in FluentFormPro\src\classes\DraftSubmissionsManager -> processEmail($settings, $form, $link, $toEmail)
# fluentform/failed_integration_notify_email_data
You can modify failed integration email notification by using this filter.
Parameters
$data(array) Failed Integration Email Notification
Usage
add_filter('fluentform/failed_integration_notify_email_data', function ($data) {
// Do your stuff here
return $data;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/failed_integration_notify_email_data', $data);
This filter is located in FluentFormPro\src\classes\FailedIntegrationNotification -> broadCast($data)
# fluentform/email_attachments
You can modify email attachments by using this filter.
Parameters
$attachments(array) Email Attachment$processedValues(array) Shortcode Parsed Value$formData(array) Form Data$entry(array) Submission Data$form(object) Form Object
Usage
add_filter('fluentform/email_attachments', function ($attachments, $processedValues, $formData, $entry, $form) {
// Do your stuff here
return $attachments;
}, 10, 5);
2
3
4
5
6
Reference
apply_filters('fluentform/email_attachments', $attachments, $processedValues, $formData, $entry, $form);
This filter is located in FluentFormPro\src\classes\ResendNotificationHandler -> resendEntryEmail($entryId, $feed, $sendToType, $customRecipient, $form)
# fluentform/email_to
This filter returns the destination email for emails. Multiple emails can be added by (,) comma separator.
Parameters
$address(string) Email Address$notification(array) Notification Data$submittedData(array) Submitted Data$form(object) Form Object
Usage
add_filter('fluentform/email_to', function ($address, $notification, $submittedData, $form) {
// Do your stuff here
return $address;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/email_to', $address, $notification, $submittedData, $form);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> notify($notification, $submittedData, $form, $entryId = false)
# fluentform/send_plain_html_email
You can toggle to send plain html as email.
Parameters
$isSendAsPlain(boolean) Whether send email as plain text$form(object) Form Object$notification(array) Notification Data
Usage
add_filter('fluentform/send_plain_html_email', function ($isSendAsPlain, $form, $notification) {
// Do your stuff here
return $isSendAsPlain;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/send_plain_html_email', $isSendAsPlain, $form, $notification);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> notify($notification, $submittedData, $form, $entryId = false)
# fluentform/submission_message_parse
This filter returns parsed message from submission as email body.
Parameters
$emailBody(string) Email Body$entryId(int) Submission ID$submittedData(array) Submitted Data$form(object) Form Object
Usage
add_filter('fluentform/submission_message_parse', function ($emailBody, $entryId, $submittedData, $form) {
// Do your stuff here
return $emailBody;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_message_parse', $emailBody, $entryId, $submittedData, $form);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> notify($notification, $submittedData, $form, $entryId = false)
# fluentform/email_subject
You can hook into this filter and modify the email subject.
Parameters
$subject(string) Email Subject$notification(array) Notification Data$submittedData(array) Submitted Data$form(object) Form Object
Usage
add_filter('fluentform/email_subject', function ($subject, $notification, $submittedData, $form) {
// Do your stuff here
return $subject;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/email_subject', $notification['subject'], $notification, $submittedData, $form);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> notify($notification, $submittedData, $form, $entryId = false)
# fluentform/filter_email_attachments
You can hook into this filter and modify the email attachments.
Parameters
$notificationAttachments(string) Email Attachments$notification(array) Notification Data$form(object) Form Object$submittedData(array) Submitted Data
Usage
add_filter('fluentform/filter_email_attachments', function ($notificationAttachments, $notification, $form, $submittedData) {
// Do your stuff here
return $notificationAttachments;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/filter_email_attachments', $notificationAttachments, $notification, $form, $submittedData);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> notify($notification, $submittedData, $form, $entryId = false)
# fluentform/email_body
You can hook into this filter and modify the email body.
Parameters
$emailBody(string) Email Body$notification(array) Notification Data$submittedData(array) Submitted Data$form(object) Form Object
Usage
add_filter('fluentform/email_body', function ($emailBody, $notification, $submittedData, $form) {
// Do your stuff here
return $emailBody;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/email_body', $emailBody, $notification, $submittedData, $form);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> notify($notification, $submittedData, $form, $entryId = false)
# fluentform/email_header
You can hook into this filter and modify the email header.
Parameters
$emailHeader(string) Email Header$form(object) Form Object$notification(array) Notification Data
Usage
add_filter('fluentform/email_header', function ($emailHeader, $form, $notification) {
// Do your stuff here
return $emailHeader;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/email_header', $emailHeader, $form, $notification);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> getEmailWithTemplate($emailBody, $form, $notification)
# fluentform/email_footer
You can hook into this filter and modify the email footer.
Parameters
$emailFooter(string) Email Footer$form(object) Form Object$notification(array) Notification Data
Usage
add_filter('fluentform/email_footer', function ($emailFooter, $form, $notification) {
// Do your stuff here
return $emailFooter;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/email_footer', $emailFooter, $form, $notification);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> getEmailWithTemplate($emailBody, $form, $notification)
# fluentform/email_styles
You can hook into this filter and modify the email styles using css.
Parameters
$css(string) Styles for the email$form(object) Form Object$notification(array) Notification Data
Usage
add_filter('fluentform/email_styles', function ($css, $form, $notification) {
// Do your stuff here
return $css;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/email_styles', $css, $form, $notification);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> getEmailWithTemplate($emailBody, $form, $notification)
# fluentform/email_template_footer_text
You can hook into this filter and modify the email template footer text.
Parameters
$footerText(string) Email Template Footer Text$form(object) Form Object$notification(array) Notification Data
Usage
add_filter('fluentform/email_template_footer_text', function ($footerText, $form, $notification) {
// Do your stuff here
return $footerText;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/email_template_footer_text', $footerText, $form, $notification);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> getFooterText($form, $notification)
# fluentform/email_template_header
You can hook into this filter and modify the email template header array.
Parameters
$headers(array) Email Template Header Data$notification(array) Notification Data
Usage
add_filter('fluentform/email_template_header', function ($headers, $notification) {
// Do your stuff here
return $headers;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/email_template_header', $headers, $notification);
This filter is located in FluentForm\app\Services\FormBuilder\Notifications\EmailNotifications -> getHeaders($notification, $isSendAsPlain = false)
# File Uploader Filters
# fluentform/file_upload_validations
You can modify file upload validation rules and message using the filter.
Parameters
$delegateValidations(array) Rules and Message Set$form(object) Form Object
Usage
add_filter('fluentform/file_upload_validations', function ($delegateValidations, $form) {
// Do your stuff here
return $delegateValidations;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/file_upload_validations', $delegateValidations, $this->form);
This filter is located in FluentFormPro\src\Uploader -> upload()
# fluentform/file_upload_validation_error
You can modify file upload validation error using the filter.
Parameters
$errors(array) Validation Error$form(object) Form Object
Usage
add_filter('fluentform/file_upload_validation_error', function ($errors, $form) {
// Do your stuff here
return $errors;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/file_upload_validation_error', $errors, $this->form);
This filter is located in FluentFormPro\src\Uploader -> upload()
# fluentform/file_upload_params
You can modify file upload location using the filter.
Parameters
$param(array) File Upload Location URL and Path$formData(array) Form Data$form(object) Form Object
Usage
add_filter('fluentform/file_upload_params', function ($param, $formData, $form) {
// Do your stuff here
return $param;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/file_upload_params', $param, $this->formData, $this->form);
This filter is located in FluentFormPro\src\Uploader -> upload()
# fluentform/uploaded_file_name
You can modify uploaded file name using the filter.
Parameters
$file(array) Uploaded File$originalFileArray(array) Original File$formData(array) Form Data$form(object) Form Object
Usage
add_filter('fluentform/uploaded_file_name', function ($file, $originalFileArray, $formData, $form) {
// Do your stuff here
return $file;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/uploaded_file_name', $file, $originalFileArray, $this->formData, $this->form);
This filter is located in FluentFormPro\src\Uploader -> renameFileName($file)
# fluentform/default_upload_path
You can modify uploaded file default path using the filter.
Parameters
$filePath(array) File Default Path$form(object) Form Object
Usage
add_filter('fluentform/default_upload_path', function ($filePath, $form) {
// Do your stuff here
return $filePath;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/default_upload_path', $filePath, $this->form);
This filter is located in FluentFormPro\src\Uploader -> copyToDefault($files)
# fluentform/uploader_args
You can modify uploaded file args using the filter.
Parameters
$args(array) Upload Files Args$filesArray(array) Files Array$form(object) Form Object
Usage
add_filter('fluentform/uploader_args', function ($args, $filesArray, $form) {
// Do your stuff here
return $args;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/uploader_args', $args, $filesArray, $this->form);
This filter is located in FluentFormPro\src\Uploader -> uploadToTemp($files, $field)
# fluentform/file_uploaded
You can modify uploaded file using the filter.
Parameters
$uploadFile(array) Uploaded File$formData(array) Form Data$form(object) Form Object
Usage
add_filter('fluentform/file_uploaded', function ($uploadFile, $formData, $form) {
// Do your stuff here
return $args;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/file_uploaded', $uploadFile, $formData, $form);
This filter is located in FluentFormPro\src\Uploader -> uploadToTemp($files, $field)
# fluentform/default_file_upload_url
You can modify default file upload path using the filter.
Parameters
$filePath(string) File Location Path$form(object) Form Object
Usage
add_filter('fluentform/default_file_upload_url', function ($filePath, $form) {
// Do your stuff here
return $filePath;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/default_file_upload_url', $filePath, $form);
This filter is located in FluentFormPro\src\Uploader -> getProcessedUrl($file, $location)
# fluentform/temp_file_delete_time
You can modify temporary file delete time using the filter.
Parameters
$time(string) Temp File Delete Time (milliseconds)
Usage
add_filter('fluentform/temp_file_delete_time', function ($time) {
// Do your stuff here
return $time;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/temp_file_delete_time', 2 * 3600);
This filter is located in FluentFormPro\src\Uploader -> removeOldTempFiles()
# Quiz Filters
# fluentform/quiz_result_table_html
You can use this filter to modify quiz result table HTML.
Parameters
$html(array) Quiz Result Table HTML$form(object) Form Object$results(array) Quiz Results$quizSettings(array) Quiz Settings$entry(array) Submission
Usage
add_filter('fluentform/quiz_result_table_html', function ($html, $form, $results, $quizSettings, $entry) {
// Do your stuff here
return $html;
}, 10, 5);
2
3
4
5
6
Reference
apply_filters('fluentform/quiz_result_table_html', $html, $form, $results, $quizSettings, $entry);
This filter is located in FluentFormPro\src\classes\Quiz\QuizController -> getQuizResultTable($shortCode, ShortCodeParser $parser)
# fluentform/quiz_case_sensitive_off
You can use this filter to toggle quiz case sensitivity.
Parameters
$status(array) Whether Quiz Case Sensitivity is enabled
Usage
add_filter('fluentform/quiz_case_sensitive_off', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/quiz_case_sensitive_off', __return_false());
This filter is located in FluentFormPro\src\classes\Quiz\QuizController -> isCorrect($settings, $userValue, $correctValue = '', $options = [])
# fluentform/quiz_wrong_ans_icon
You can use this filter to change quiz wrong answer icon.
Parameters
$icon(string) Icon Link in SVG Format
Usage
add_filter('fluentform/quiz_wrong_ans_icon', function ($icon) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/quiz_wrong_ans_icon', $icon);
This filter is located in FluentFormPro\src\classes\Quiz\QuizController -> getWrongIcon()
# fluentform/quiz_right_ans_icon
You can use this filter to change quiz right answer icon.
Parameters
$icon(string) Icon Link in SVG Format
Usage
add_filter('fluentform/quiz_right_ans_icon', function ($icon) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/quiz_right_ans_icon', $icon);
This filter is located in FluentFormPro\src\classes\Quiz\QuizController -> getRightIcon()
# fluentform/quiz_no_grade_label
You can use this filter to change text of quiz result grade label.
Parameters
$gradeLabel(string) Grade Label Name
Usage
add_filter('fluentform/quiz_no_grade_label', function ($gradeLabel) {
// Do your stuff here
return $gradeLabel;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/quiz_no_grade_label', __('Not Graded', 'fluentformpro'));
This filter is located in FluentFormPro\src\classes\Quiz\QuizScoreComponent -> addScoreToSubmission($value, $field, $submissionData, $form)
# fluentform/quiz_score_value
You can use this filter to modify quiz score value.
Parameters
$result(string) Quiz Score$formId(int) Form ID$scoreType(string) Quiz Score Type$quizResults(array) Quiz Score Formatted Result
Usage
add_filter('fluentform/quiz_score_value', function ($result, $formId, $scoreType, $quizResults) {
// Do your stuff here
return $result;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/quiz_score_value', $result, $formId, $scoreType, $quizResults);
This filter is located in FluentFormPro\src\classes\Quiz\QuizScoreComponent -> addScoreToSubmission($value, $field, $submissionData, $form)
# User Registration Filters
# fluentform/user_registration_field_defaults
You can modify User Registration integration default fields using the filter.
Parameters
$fields(array) Default Integration Fields$formId(int) Form ID
Usage
add_filter('fluentform/user_registration_field_defaults', function ($fields, $formId) {
// Do your stuff here
return $fields;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/user_registration_field_defaults', $fields, $formId);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\Bootstrap -> getIntegrationDefaults($settings, $formId = null)
# fluentform/user_registration_feed_fields
You can modify User Registration feed fields using the filter.
Parameters
$fields(array) Form Fields$formId(int) Form ID
Usage
add_filter('fluentform/user_registration_feed_fields', function ($fields, $formId) {
// Do your stuff here
return $fields;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/user_registration_feed_fields', $fieldSettings['fields'], $formId);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\Bootstrap -> getSettingsFields($settings, $formId = null)
# fluentform/user_update_feed_fields
You can modify User Update feed fields using the filter.
Parameters
$fields(array) Form Fields$formId(int) Form ID
Usage
add_filter('fluentform/user_update_feed_fields', function ($fields, $formId) {
// Do your stuff here
return $fields;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/user_update_feed_fields', $fieldSettings['fields'], $formId);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\Bootstrap -> getSettingsFields($settings, $formId = null)
# fluentform/user_registration_creatable_roles
You can modify user roles for User Registration integration using the filter.
Parameters
$validRoles(array) User Roles
Usage
add_filter('fluentform/user_registration_creatable_roles', function ($validRoles) {
// Do your stuff here
return $validRoles;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/user_registration_creatable_roles', $validRoles);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\UserRegistrationApi -> getUserRoles()
# fluentform/user_registration_feed
You can modify User Registration feed using the filter.
Parameters
$feed(array) Form Feed$entry(array) Form Submission$form(object) Form Object
Usage
add_filter('fluentform/user_registration_feed', function ($feed, $entry, $form) {
// Do your stuff here
return $feed;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/user_registration_feed', $feed, $entry, $form);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\UserRegistrationApi -> createUser($feed, $formData, $entry, $form, $integrationKey)
# fluentform/user_registration_map_fields
You can modify User Registration field mapper using the filter.
Parameters
$fields(array) Map Fields
Usage
add_filter('fluentform/user_registration_map_fields', function ($fields) {
// Do your stuff here
return $fields;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/user_registration_map_fields', $fields);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\UserRegistrationApi -> userRegistrationMapFields()
# fluentform/user_update_map_fields
You can modify User Update field mapper using the filter.
Parameters
$fields(array) Map Fields
Usage
add_filter('fluentform/user_update_map_fields', function ($fields) {
// Do your stuff here
return $fields;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/user_update_map_fields', $fields);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\UserUpdateFormHandler -> userUpdateMapFields()
# fluentform/user_registration_feed_fields
You can modify user registration feed fields using the filter.
Parameters
$fields(array) User Registration Feed Fields$formId(int) Form ID
Usage
add_filter('fluentform/user_registration_feed_fields', function ($fields, $formId) {
// Do your stuff here
return $fields;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/user_registration_feed_fields', $fieldSettings['fields'], $formId);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\Bootstrap -> getSettingsFields($settings, $formId = null)
# fluentform/user_update_feed_fields
You can modify user update feed fields using the filter.
Parameters
$fields(array) User Update Feed Fields$formId(int) Form ID
Usage
add_filter('fluentform/user_update_feed_fields', function ($fields, $formId) {
// Do your stuff here
return $fields;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/user_update_feed_fields', $fieldSettings['fields'], $formId);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\Bootstrap -> getSettingsFields($settings, $formId = null)
# fluentform/user_registration_field_defaults
You can modify user registration default fields using the filter.
Parameters
$fields(array) User Update Feed Fields$formId(int) Form ID
Usage
add_filter('fluentform/user_registration_field_defaults', function ($fields, $formId) {
// Do your stuff here
return $fields;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/user_registration_field_defaults', $fieldSettings['fields'], $formId);
This filter is located in FluentFormPro\src\Integrations\UserRegistration\Bootstrap -> getIntegrationDefaults($settings, $formId = null)
# Webhook Filters
# fluentform/webhook_request_args
You can modify webhook request arguments using the filter.
Parameters
$payload(array) Webhook Request Payload$settings(array) Webhook Feed$formData(array) Form Data$form(object) Form Object$entryId(int) Submission ID
Usage
add_filter('fluentform/webhook_request_args', function ($payload, $settings, $formData, $form, $entryId) {
// Do your stuff here
return $payload;
}, 10, 5);
2
3
4
5
6
Reference
apply_filters('fluentform/webhook_request_args', $payload, $settings, $formData, $form, $entry->id);
This filter is located in FluentFormPro\src\Integrations\WebHook\NotifyTrait -> notify($feed, $formData, $entry, $form)
# fluentform/webhook_request_method
You can modify webhook request method using the filter.
Parameters
$method(array) Webhook Request Method$settings(array) Webhook Feed$data(array) Form Data$form(object) Form Object$entryId(int) Submission ID
Usage
add_filter('fluentform/webhook_request_method', function ($method, $settings, $data, $form, $entryId) {
// Do your stuff here
return $method;
}, 10, 5);
2
3
4
5
6
Reference
apply_filters('fluentform/webhook_request_method', $method, $settings, $data, $form, $entryId);
This filter is located in FluentFormPro\src\Integrations\WebHook\NotifyTrait -> getWebHookRequestMethod($settings, $data, $form, $entryId)
# fluentform/webhook_request_headers
You can modify webhook request header data using the filter.
Parameters
$requestHeaders(array) Webhook Request Header$settings(array) Webhook Feed$data(array) Form Data$entryId(int) Submission ID
Usage
add_filter('fluentform/webhook_request_headers', function ($requestHeaders, $settings, $data, $form, $entryId) {
// Do your stuff here
return $requestHeaders;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/webhook_request_headers', $requestHeaders, $settings, $data, $form, $entryId);
This filter is located in FluentFormPro\src\Integrations\WebHook\NotifyTrait -> getWebHookRequestMethod($settings, $data, $form, $entryId)
# fluentform/webhook_request_data
You can modify webhook selected request data using the filter.
Parameters
$selectedData(array) Webhook Request Selected Data$settings(array) Webhook Feed$data(array) Form Data$form(object) Form Object$entryId(int) Submission ID
Usage
add_filter('fluentform/webhook_request_data', function ($selectedData, $settings, $data, $form, $entry) {
// Do your stuff here
return $selectedData;
}, 10, 5);
2
3
4
5
6
Reference
apply_filters('fluentform/webhook_request_data', $selectedData, $settings, $data, $form, $entryId);
This filter is located in FluentFormPro\src\Integrations\WebHook\NotifyTrait -> getWebHookRequestData($settings, $data, $form, $entry)
# fluentform/webhook_request_url
You can modify webhook request URL using the filter.
Parameters
$url(array) Webhook Request URL$settings(array) Webhook Feed$data(array) Form Data$form(object) Form Object$entryId(int) Submission ID
Usage
add_filter('fluentform/webhook_request_url', function ($url, $settings, $data, $form, $entryId) {
// Do your stuff here
return $url;
}, 10, 5);
2
3
4
5
6
Reference
apply_filters('fluentform/webhook_request_url', $re$url, $settings, $data, $form, $entryId);
This filter is located in FluentFormPro\src\Integrations\WebHook\NotifyTrait -> getWebHookRequestUrl($settings, $data, $form, $entryId, $requestMethod, $requestData)
# Payment Filters
# fluentform/payment_submission_data
You can use this filter to modify payment form submission data.
Parameters
$submission(string) Form Submission Data$form(object) Form Object
Usage
add_filter('fluentform/payment_submission_data', function ($submission, $form) {
// Do your stuff here
return $submission;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_submission_data', $submission, $this->form);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentAction -> draftFormEntry()
# fluentform/submission_order_items
You can use this filter to modify payment order items data.
Parameters
$orderItems(array) Payment Order Items$submissionData(array) Form Submission Data$form(object) Form Object
Usage
add_filter('fluentform/submission_order_items', function ($orderItems, $submissionData, $form) {
// Do your stuff here
return $submission;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_order_items', $this->orderItems, $this->submissionData, $this->form);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentAction -> getOrderItems($forced = false)
# 'fluentform/payment_field_' . $elementName . '_pricing_options'
You can use this filter to modify payment order items data.
Parameters
$pricingOptions(array) Payment Pricing Options$item(array) Payment Input$form(object) Form Object
Usage
add_filter('fluentform/payment_field_' . $elementName . '_pricing_options', function ($pricingOptions, $item, $this->form) {
// Do your stuff here
return $pricingOptions;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_field_' . $elementName . '_pricing_options', $pricingOptions, $item, $this->form);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentAction -> getItemFromVariables($item, $key)
# fluentform/submission_subscription_items
You can use this filter to modify payment subscription items data.
Parameters
$subscriptionItems(array) Payment Subscription Items$submissionData(array) Form Submission Data$form(object) Form Object
Usage
add_filter('fluentform/submission_subscription_items', function ($subscriptionItems, $submissionData, $form) {
// Do your stuff here
return $submission;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/submission_subscription_items', $this->subscriptionItems, $this->submissionData, $this->form);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentAction -> getSubscriptionItems()
# fluentform/payment_entries_human_date
You can use this filter to get payment submission date as human-readable format.
Parameters
$status(boolean) Whether Payment Submission Date is in human-readable Format
Usage
add_filter('fluentform/payment_entries_human_date', function ($status) {
// Do your stuff here
return $status;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_entries_human_date', true);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentEntries -> loadApp()
# 'fluentform/payment_manager_class_' . $submission->payment_method
You can use this filter to toggle payment subscription cancellation status for payment methods.
Parameters
$handler(boolean) Whether Payment Subscription is cancelled
Usage
add_filter('fluentform/payment_manager_class_' . $submission->payment_method, function ($handler) {
// Do your stuff here
return $handler;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_manager_class_' . $submission->payment_method, $handler);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentManagement -> cancelSubscription($subscription)
# fluentform/payment_receipt_pre_render_payment_info
You can use this filter to modify payment information pre render text.
Parameters
$preRender(string) Payment Info Text$entry(object) Form Submission Object
Usage
add_filter('fluentform/payment_receipt_pre_render_payment_info', function ($preRender, $entry) {
// Do your stuff here
return $preRender;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_receipt_pre_render_payment_info', $preRender, $this->entry);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentReceipt -> paymentInfo()
# fluentform/payment_receipt_pre_render_payment_info
You can use this filter to modify payment information table's pre render text.
Parameters
$preRender(string) Payment Info Table Text$entry(object) Form Submission Object
Usage
add_filter('fluentform/payment_receipt_pre_render_payment_info', function ($preRender, $entry) {
// Do your stuff here
return $preRender;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_receipt_pre_render_payment_info', $preRender, $this->entry);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentReceipt -> paymentInfoTable()
# fluentform/payment_receipt_pre_render_item_details
You can use this filter to modify payment order items pre render text.
Parameters
$preRender(string) Payment Order Item Text$entry(object) Form Submission Object$orderItems(object) Order Items Object
Usage
add_filter('fluentform/payment_receipt_pre_render_item_details', function ($preRender, $entry, $orderItems) {
// Do your stuff here
return $preRender;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_receipt_pre_render_item_details', $preRender, $this->entry, $orderItems);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentReceipt -> itemDetails()
# fluentform/payment_receipt_pre_render_submission_details
You can use this filter to modify payment submission details pre render text.
Parameters
$preRender(string) Payment Submission Details Text$entry(object) Form Submission Object
Usage
add_filter('fluentform/payment_receipt_pre_render_submission_details', function ($preRender, $entry) {
// Do your stuff here
return $preRender;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_receipt_pre_render_submission_details', $preRender, $this->entry);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentReceipt -> customerDetails()
# fluentform/payment_receipt_pre_render_subscription_details
You can use this filter to modify payment subscription details pre render text.
Parameters
$preRender(string) Payment Subscription Text$entry(object) Form Submission Object$subscriptions(object) Payment Subscription Object
Usage
add_filter('fluentform/payment_receipt_pre_render_subscription_details', function ($preRender, $entry, $subscriptions) {
// Do your stuff here
return $preRender;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_receipt_pre_render_subscription_details', $preRender, $this->entry, $subscriptions);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentReceipt -> getSubscriptionsAndPaymentTotal($submission)
# 'fluentform/payment_field_' . $elementName . '_pricing_options'
You can use this filter to modify payment pricing options.
Parameters
$pricingOptions(array) Payment Pricing Options$item(array) Form Payment Inputs$form(object) Form Object
Usage
add_filter('fluentform/payment_field_' . $elementName . '_pricing_options', function ($pricingOptions, $item, $form) {
// Do your stuff here
return $pricingOptions;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_field_' . $elementName . '_pricing_options', $pricingOptions, $item, $this->form);
This filter is located in FluentFormPro\src\Payments\Classes\PaymentAction -> getItemFromVariables($item, $key)
# fluentform/available_payment_methods
You can use this filter to modify available payment methods.
Parameters
$available_methods(array) Available Payment Methods
Usage
add_filter('fluentform/available_payment_methods', function ($available_methods) {
// Do your stuff here
return $available_methods;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/available_payment_methods', $available_methods);
This filter is located in FluentFormPro\src\Payments\Components\PaymentMethods -> getComponent()
# 'fluentform/payment_method_contents_' . $methodName
You can use this filter to modify specific payment method contents.
Parameters
$selectedMarkups(string) Payment Content Markup in HTML$method(array) Payment Method$data(array) Form Data$form(object) Form Object
Usage
add_filter('fluentform/payment_method_contents_' . $methodName, function ($selectedMarkups, $method, $data, $form) {
// Do your stuff here
return $selectedMarkups;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_method_contents_' . $methodName, $selectedMarkups, $method, $data, $form);
This filter is located in FluentFormPro\src\Payments\Components\PaymentMethods -> render($data, $form)
# 'fluentform/transaction_data_' . $transaction->payment_method
You can use this filter to modify payment method of transaction which has already been completed.
Parameters
$transaction(array) Transaction Data
Usage
add_filter('fluentform/transaction_data_' . $transaction->payment_method, function ($transaction) {
// Do your stuff here
return $transaction;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/transaction_data_' . $transaction->payment_method, $transaction);
This filter is located in FluentFormPro\src\Payments\Order\OrderData -> getRefunds($submissionId)
# 'fluentform_subscription_items_' . $transaction->payment_method
You can use this filter to modify subscription payments which has already been completed.
Parameters
$transaction(array) Transaction Data
Usage
add_filter('fluentform_subscription_items_' . $transaction->payment_method, function ($transaction) {
// Do your stuff here
return $transaction;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/transaction_data_' . $transaction->payment_method, [], $transaction);
This filter is located in FluentFormPro\src\Payments\Order\OrderData -> getSubscriptionTransactions($subscriptionId)
# fluentform/subscription_transactions
You can use this filter to modify payment subscription's transaction.
Parameters
$transactions(array) Transaction Data$subscriptionId(int) Payment Subscription ID
Usage
add_filter('fluentform/subscription_transactions', function ($transactions, $subscriptionId) {
// Do your stuff here
return $transactions;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/subscription_transactions', $transactions, $subscriptionId);
This filter is located in FluentFormPro\src\Payments\Orders\OrderData -> getSubscriptionTransactions($subscriptionId)
# 'fluentform/payment_settings_' . $method
You can use this filter to modify payment methods settings.
Parameters
$payments(array) Payment Details
Usage
add_filter('fluentform/payment_settings_' . $method, function ($payments) {
// Do your stuff here
return $payments;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_settings_' . $method, []);
This filter is located in FluentFormPro\src\Payments\AjaxEndpoints -> getPaymentMethodSettings()
# 'fluentform/payment_method_settings_validation_' . $method
You can use this filter to modify payment methods validation settings.
Parameters
$payments(array) Payment Method Settings
Usage
add_filter('fluentform/payment_method_settings_validation_' . $method, function ($payments, $settings) {
// Do your stuff here
return $payments;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_method_settings_validation_' . $method, [], $settings);
This filter is located in FluentFormPro\src\Payments\AjaxEndpoints -> savePaymentMethodSettings()
# 'fluentform/payment_method_settings_save_' . $method
You can use this filter to modify payment methods settings before saving.
Parameters
$settings(array) Payment Method Settings
Usage
add_filter('fluentform/payment_method_settings_save_' . $method, function ($settings) {
// Do your stuff here
return $settings;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_method_settings_save_' . $method, $settings);
This filter is located in FluentFormPro\src\Payments\AjaxEndpoints -> savePaymentMethodSettings()
# fluentform/payment_stripe_publishable_key
You can use this filter to modify stripe publishable key for specific form.
Parameters
$stripeKey(string) Stripe Publishable Key$formId(int) Form ID
Usage
add_filter('fluentform/payment_stripe_publishable_key', function ($stripeKey, $formId) {
// Do your stuff here
return $stripeKey;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_stripe_publishable_key', StripeSettings::getPublishableKey($form->id), $form->id);
This filter is located in FluentFormPro\src\PaymentsHandler -> init()
# fluentform/accepted_currencies
You can use this filter to modify accepted currencies.
Parameters
$currencies(array) All Accepted Currencies
Usage
add_filter('fluentform/accepted_currencies', function ($currencies) {
// Do your stuff here
return $currencies;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/accepted_currencies', $currencies);
This filter is located in FluentFormPro\src\PaymentsHelper -> getCurrencies()
# fluentform/currency_symbol
You can use this filter to modify currency symbol of accepted currencies.
Parameters
$currency_symbol(array) Currency Symbols$currency(string) Currency Name
Usage
add_filter('fluentform/currency_symbol', function ($currency_symbol, $currency) {
// Do your stuff here
return $currency_symbol;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/currency_symbol', $currency_symbol, $currency);
This filter is located in FluentFormPro\src\PaymentsHelper -> getCurrencies()
# fluentform/currencies_symbols
You can use this filter to modify all available currency symbols.
Parameters
$symbols(array) Currency Symbols Array
Usage
add_filter('fluentform/currencies_symbols', function ($symbols) {
// Do your stuff here
return $symbols;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/currencies_symbols', $symbols);
This filter is located in FluentFormPro\src\PaymentsHelper -> getCurrencySymbols()
# fluentform/zero_decimal_currencies
You can use this filter to modify all available zero decimal currencies.
Parameters
$zeroDecimalCurrencies(array) Zero Decimal Currencies
Usage
add_filter('fluentform/zero_decimal_currencies', function ($zeroDecimalCurrencies) {
// Do your stuff here
return $zeroDecimalCurrencies;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/zero_decimal_currencies', $zeroDecimalCurrencies);
This filter is located in FluentFormPro\src\PaymentsHelper -> zeroDecimalCurrencies()
# fluentform/available_payment_statuses
You can use this filter to modify payment statuses.
Parameters
$paymentStatuses(array) Payment Statuses
Usage
add_filter('fluentform/available_payment_statuses', function ($paymentStatuses) {
// Do your stuff here
return $paymentStatuses;
}, 10, 1);
2
3
4
5
6
$paymentStatuses = [
'paid' => __('Paid', 'fluentformpro'),
'processing' => __('Processing', 'fluentformpro'),
'pending' => __('Pending', 'fluentformpro'),
'failed' => __('Failed', 'fluentformpro'),
'refunded' => __('Refunded', 'fluentformpro'),
'partially-refunded' => __('Partial Refunded', 'fluentformpro'),
'cancelled' => __('Cancelled', 'fluentformpro')
];
2
3
4
5
6
7
8
9
Reference
apply_filters('fluentform/available_payment_statuses', $paymentStatuses);
This filter is located in FluentFormPro\src\PaymentsHelper -> getPaymentStatuses()
# fluentform/payment_receipt_template_base_path
You can use this filter to change payment receipt template base path.
Parameters
$basePath(string) Base Path$fileName(string) File Name$data(array) Payment Receipt Data
Usage
add_filter('fluentform/payment_receipt_template_base_path', function ($basePath, $fileName, $data) {
// Do your stuff here
return $basePath;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_receipt_template_base_path', FLUENTFORMPRO_DIR_PATH . 'src/views/receipt/', $fileName, $data);
This filter is located in FluentFormPro\src\PaymentsHelper -> loadView($fileName, $data)
# fluentform/recurring_payment_summary_texts
You can use this filter to modify payment subscription summary text.
Parameters
$paymentSummaryText(string) Payment Summary$plan(array) Subscription Plan$formId(int) Form ID
Usage
add_filter('fluentform/recurring_payment_summary_texts', function ($paymentSummaryText, $plan, $formId) {
// Do your stuff here
return $paymentSummaryText;
}, 10, 3);
2
3
4
5
6
$paymentSummaryText = [
'has_signup_fee' => __('{first_interval_total} for first {billing_interval} then {subscription_amount} for each {billing_interval}', 'fluentformpro'),
'has_trial' => __('Free for {trial_days} days then {subscription_amount} for each {billing_interval}', 'fluentformpro'),
'onetime_only' => __('One time payment of {first_interval_total}', 'fluentformpro'),
'normal' => __('{subscription_amount} for each {billing_interval}', 'fluentformpro'),
'bill_times' => __(', for {bill_times} installments', 'fluentformpro'),
'single_trial' => __('Free for {trial_days} days then {subscription_amount} one time')
];
2
3
4
5
6
7
8
Reference
apply_filters('fluentform/recurring_payment_summary_texts', FLUENTFORMPRO_DIR_PATH . 'src/views/receipt/', $fileName, $data);
This filter is located in FluentFormPro\src\PaymentsHelper -> getPaymentSummaryText($plan, $formId, $currency, $withMarkup = true)
# fluentform/transaction_view_url
You can use this filter to modify transaction file URL.
Parameters
$urlBase(string) Transaction File URL
Usage
add_filter('fluentform/transaction_view_url', function ($urlBase) {
// Do your stuff here
return $urlBase;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/transaction_view_url', $urlBase);
This filter is located in FluentFormPro\src\TransactionShortcodes -> getViewConfig()
# fluentform/payment_view_config
You can use this filter to modify payment transaction configuration.
Parameters
$config(string) Payment Configurations
Usage
add_filter('fluentform/payment_view_config', function ($config) {
// Do your stuff here
return $config;
}, 10, 1);
2
3
4
5
6
$config = [
'new_tab' => false,
'view_text' => __('View', 'fluentformpro'),
'base_url' => $urlBase,
'date_format' => get_option('date_format'),
'date_time_format' => $wpDateTimeFormat,
'transactions_title' => __('Payments', 'fluentformpro'),
'subscriptions_title' => __('Subscriptions', 'fluentformpro'),
'sub_cancel_confirm_heading' => __('Are you sure you want to cancel this subscription?', 'fluentformpro'),
'sub_cancel_confirm_btn' => __('Yes, cancel this subscription', 'fluentformpro'),
'sub_cancel_close' => __('Close', 'fluentformpro')
];
2
3
4
5
6
7
8
9
10
11
12
Reference
apply_filters('fluentform/payment_view_config', $config);
This filter is located in FluentFormPro\src\TransactionShortcodes -> getViewConfig()
# 'fluentform/pay_method_has_sub_cancel_' . $method
You can use this filter to modify payment method if subscription has been canceled.
Parameters
$hasCancel(boolean) Whether Payment Subscription Has Been Canceled
Usage
add_filter('fluentform/pay_method_has_sub_cancel_' . $method, function ($hasCancel) {
// Do your stuff here
return $hasCancel;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/pay_method_has_sub_cancel_' . $method, false);
This filter is located in FluentFormPro\src\TransactionShortcodes -> canCancelSubscription($subscription)
# 'fluentform/payment_manager_class_' . $submission->payment_method
You can use this filter to modify a certain payment if subscription has been canceled.
Parameters
$handler(boolean) Whether Payment Subscription Has Been Canceled
Usage
add_filter('fluentform/payment_manager_class_' . $submission->payment_method, function ($handler) {
// Do your stuff here
return $handler;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_manager_class_' . $submission->payment_method, false);
This filter is located in FluentFormPro\src\TransactionShortcodes -> cancelSubscriptionAjax()
# fluentform/mollie_payment_args
You can use this filter to modify payment arguments of mollie payment method.
Parameters
$paymentArgs(array) Mollie Payment Arguments$submission(array) Form Submission$transaction(array) Payment Transaction$form(object) Form Object
Usage
add_filter('fluentform/mollie_payment_args', function ($paymentArgs, $submission, $transaction, $form) {
// Do your stuff here
return $paymentArgs;
}, 10, 4);
2
3
4
5
6
$paymentArgs = [
'amount' => [
'currency' => $transaction->currency,
'value' => number_format((float) $transaction->payment_total / 100, 2, '.', '')
],
'description' => $form->title,
'redirectUrl' => $successUrl,
'webhookUrl' => $listener_url,
'metadata' => json_encode([
'form_id' => $form->id,
'submission_id' => $submission->id
]),
'sequenceType' => 'oneoff'
];
2
3
4
5
6
7
8
9
10
11
12
13
14
Reference
apply_filters('fluentform/mollie_payment_args', $paymentArgs, $submission, $transaction, $form);
This filter is located in FluentFormPro\src\PaymentMethods\Mollie\MollieProcessor -> handleRedirect($transaction, $submission, $form, $methodSettings)
# 'fluentform/payment_method_public_name_' . $paymentMethod
You can use this filter to modify payment method to before showing payment info.
Parameters
$paymentMethod(array) Payment Method Details
Usage
add_filter('fluentform/payment_method_public_name_' . $paymentMethod, function ($paymentMethod) {
// Do your stuff here
return $paymentMethod;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_method_public_name_' . $paymentMethod', $paymentMethod);
This filter is located in FluentFormPro\src\views\receipt\payment-info.php
# fluentform/paypal_checkout_args
You can use this filter to modify payment arguments of PayPal payment method before checkout.
Parameters
$paypal_args(array) PayPal Payment Arguments$submission(array) Form Submission$transaction(array) Payment Transaction$form(object) Form Object
Usage
add_filter('fluentform/paypal_checkout_args', function ($paypal_args, $submission, $transaction, $form) {
// Do your stuff here
return $paypal_args;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/paypal_checkout_args', $paypal_args, $submission, $transaction, $form);
This filter is located in FluentFormPro\src\PaymentMethods\PayPal\PayPalProcessor -> handlePayPalRedirect($transaction, $submission, $form, $methodSettings, $hasSubscriptions)
# fluentform/paypal_pending_message
You can use this filter to modify PayPal payment method default pending message.
Parameters
$message(array) PayPal Payment Arguments$submission(array) Form Submission
Usage
add_filter('fluentform/paypal_pending_message', function ($message, $submission) {
// Do your stuff here
return $message;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/paypal_pending_message', $message, $submission);
This filter is located in FluentFormPro\src\PaymentMethods\PayPal\PayPalProcessor -> handleSessionRedirectBack($data)
# fluentform/paypal_url
You can use this filter to modify PayPal payment method URL redirection.
Parameters
$paypal_uri(string) PayPal Payment Redirect URI$ssl_check(boolean) Whether SSL is enabled or not, By Default False$ipn(boolean) Whether Instant Payment Notification (IPN) is enabled or not, By Default False$isLive(boolean) Whether the PayPal Payment Method is live or not, By Default True
Usage
add_filter('fluentform/paypal_url', function ($paypal_uri, $ssl_check, $ipn, $isLive) {
// Do your stuff here
return $paypal_uri;
}, 10, 4);
2
3
4
5
6
Reference
apply_filters('fluentform/paypal_url', $paypal_uri, $ssl_check, $ipn, $isLive);
This filter is located in FluentFormPro\src\PaymentMethods\PayPal\PayPalProcessor -> getPaypalRedirect($ssl_check = false, $ipn = false)
# fluentform/process_paypal_ipn_data
You can use this filter to modify PayPal payment method Instant Payment Notification (IPN) data.
Parameters
$encoded_data_array(array) Instant Payment Notification (IPN) Data
Usage
add_filter('fluentform/process_paypal_ipn_data', function ($encoded_data_array) {
// Do your stuff here
return $encoded_data_array;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/process_paypal_ipn_data', $encoded_data_array);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\API\Customer -> createCustomer($customerArgs, $formId)
# fluentform/razorpay_payment_args
You can use this filter to modify payment arguments of RazorPay payment method.
Parameters
$paymentArgs(array) Razorpay Payment Arguments$submission(array) Form Submission$transaction(array) Payment Transaction Details$form(object) Form Object
Usage
add_filter('fluentform/razorpay_payment_args', function ($paymentArgs, $submission, $transaction, $form) {
// Do your stuff here
return $paymentArgs;
}, 10, 4);
2
3
4
5
6
$paymentArgs = [
'amount' => intval($transaction->payment_total),
'currency' => strtoupper($transaction->currency),
'description' => $form->title,
'reference_id' => $transaction->transaction_hash,
'customer' => [
'email' => PaymentHelper::getCustomerEmail($submission, $form),
'name' => PaymentHelper::getCustomerName($submission, $form),
'contact' => PaymentHelper::getCustomerPhoneNumber($submission, $form),
],
"options" => [
"checkout" => [
'name' => PaymentHelper::getCustomerName($submission, $form),
]
],
'callback_url' => $successUrl,
'notes' => [
'form_id' => $form->id,
'submission_id' => $submission->id
],
'callback_method' => 'get',
'notify' => [
'email' => in_array('email', $globalSettings['notifications']),
'sms' => in_array('sms', $globalSettings['notifications']),
]
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
Reference
apply_filters('fluentform/razorpay_payment_args', $paymentArgs, $submission, $transaction, $form);
This filter is located in FluentFormPro\src\PaymentMethods\RazorPay\RazorPayProcessor -> handleRedirect($transaction, $submission, $form, $methodSettings)
# fluentform/stripe_request_headers
You can use this filter to modify stripe API request header.
Parameters
$headers(array) Stripe API Request Headers
Usage
add_filter('fluentform/stripe_request_headers', function ($headers) {
// Do your stuff here
return $headers;
}, 10, 1);
2
3
4
5
6
$headers = [
'Authorization' => 'Basic ' . base64_encode(self::get_secret_key() . ':'),
'Stripe-Version' => self::STRIPE_API_VERSION,
'User-Agent' => $app_info['name'] . '/' . $app_info['version'] . ' (' . $app_info['url'] . ')',
'X-Stripe-Client-User-Agent' => json_encode($user_agent),
];
2
3
4
5
6
Reference
apply_filters('fluentform/stripe_request_headers', $headers);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\API\ApiRequest -> get_headers()
# fluentform/stripe_idempotency_key
You can use this filter to modify stripe payment method idempotency key. Stripe use idempotency key for safely retrying requests without accidentally performing the same operation twice.
Parameters
$key(string) Stripe Idempotency Key$request(array) Stripe API Request
Usage
add_filter('fluentform/stripe_idempotency_key', function ($key, $request) {
// Do your stuff here
return $key;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/stripe_idempotency_key', $key, $request);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\API\ApiRequest -> request($request, $api = 'charges', $method = 'POST')
# fluentform/stripe_request_body
You can use this filter to modify stripe payment method API request.
Parameters
$request(array) Stripe API Request$api(string) Stripe Idempotency Key
Usage
add_filter('fluentform/stripe_request_body', function ($request, $api) {
// Do your stuff here
return $request;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/stripe_request_body', $request, $api);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\API\ApiRequest -> request($request, $api = 'charges', $method = 'POST')
# fluentform/payment_stripe_secret_key
You can use this filter to modify stripe payment method API secret key.
Parameters
$secretKey(string) Stripe API Secret Key$formId(int) Form ID
Usage
add_filter('fluentform/payment_stripe_secret_key', function ($secretKey, $formId) {
// Do your stuff here
return $secretKey;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_stripe_secret_key', $secretKey, $formId);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\API\Customer -> createCustomer($customerArgs, $formId)
# fluentform/stripe_plan_name_generated
You can use this filter to modify stripe payment method plan subscription ID before generating plan name.
Parameters
$subscriptionId(string) Stripe Subscription ID$subscription(array) Stripe Subscription Data$currency(string) Selected Currency, By Default USD
Usage
add_filter('fluentform/stripe_plan_name_generated', function ($subscriptionId, $subscription, $currency) {
// Do your stuff here
return $subscriptionId;
}, 10, 3);
2
3
4
5
6
Reference
apply_filters('fluentform/stripe_plan_name_generated', $subscriptionId, $subscription, $currency);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\API\Plan -> getGeneratedSubscriptionId($subscription, $currency = 'USD')
# fluentform/stripe_plan_name
You can use this filter to modify stripe payment method plan name.
Parameters
$planName(string) Stripe Plan Name$subscription(array) Stripe Subscription Data
Usage
add_filter('fluentform/stripe_plan_name', function ($planName, $subscription) {
// Do your stuff here
return $planName;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/stripe_plan_name', $planName, $subscription);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\API\Plan -> getSubscriptionPlanBySubscription($subscription, $currency)
# fluentform/stripe_checkout_args
You can use this filter to modify stripe checkout arguments.
Parameters
$checkoutArgs(string) Stripe Checkout Arguments$submission(array) Form Submission Data$transaction(array) Transaction Details$form(object) Form Object
Usage
add_filter('fluentform/stripe_checkout_args', function ($checkoutArgs, $submission, $transaction, $form) {
// Do your stuff here
return $checkoutArgs;
}, 10, 4);
2
3
4
5
6
$checkoutArgs = [
'cancel_url' => wp_sanitize_redirect($cancelUrl),
'success_url' => wp_sanitize_redirect($successUrl),
'locale' => 'auto',
'billing_address_collection' => 'auto',
'client_reference_id' => $submission->id,
'customer_email' => $transaction->payer_email,
'metadata' => [
'submission_id' => $submission->id,
'form_id' => $form->id,
'transaction_id' => ($transaction) ? $transaction->id : ''
]
];
2
3
4
5
6
7
8
9
10
11
12
13
Reference
apply_filters('fluentform/stripe_checkout_args', $checkoutArgs, $submission, $transaction, $form);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\StripeProcessor -> handleCheckoutSession($transaction, $submission, $form, $methodSettings)
# fluentform/disable_stripe_connect
You can use this filter to toggle stripe connection.
Parameters
$isDisableStripeConnect(boolean) Whether Stripe Connection is disabled, By Default false
Usage
add_filter('fluentform/disable_stripe_connect', function ($isDisableStripeConnect) {
// Do your stuff here
return $isDisableStripeConnect;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/disable_stripe_connect', $isDisableStripeConnect);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\StripeSettings -> getSettings()
# fluentform/stripe_supported_shipping_countries
You can use this filter to modify stripe supported shipping countries list.
Parameters
$countries(array) Stripe Supported Shipping Countries
Usage
add_filter('fluentform/stripe_supported_shipping_countries', function ($countries) {
// Do your stuff here
return $countries;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/stripe_supported_shipping_countries', $countries);
This filter is located in FluentFormPro\src\PaymentMethods\Stripe\StripeSettings -> supportedShippingCountries()
# fluentform/stripe_strong_customer_verify_waiting_message
You can use this filter to modify stripe strong customer verify waiting message
Parameters
$message(string) Waiting Message
Usage
add_filter('fluentform/stripe_strong_customer_verify_waiting_message', function ($message) {
// replace message if you need
return $message;
});
2
3
4
5
6
Reference
apply_filters('fluentform/stripe_strong_customer_verify_waiting_message', $message);
This filter is located in FluentFormPro\src\Payments\PaymentMethods\Stripe\StripeInlineProcessor.php -> handlePaymentIntent()
# fluentform/square_payment_args
You can use this filter to modify payment arguments of Square payment method.
Parameters
$paymentArgs(array) Square Payment Arguments$submission(array) Form Submission$transaction(array) Payment Transaction Details$form(object) Form Object
Usage
add_filter('fluentform/square_payment_args', function ($paymentArgs, $submission, $transaction, $form) {
// Do your stuff here
return $countries;
}, 10, 4);
2
3
4
5
6
$paymentArgs = [
"idempotency_key" => $transaction->transaction_hash,
"order" => [
"order" => [
"location_id" => ArrayHelper::get($keys, "location_id"),
"line_items" => [
[
"quantity" => '1',
"item_type" => "ITEM",
"metadata" => [
'form_id' => 'Form Id ' . strval($form->id),
'submission_id' => 'Submission Id ' . strval($submission->id)
],
"name" => $this->getProductNames(),
"base_price_money" => [
"amount" => intval($transaction->payment_total),
"currency" => $transaction->currency
]
]
],
]
],
'pre_populated_data' => [
'buyer_email' => PaymentHelper::getCustomerEmail($submission, $form),
'buyer_phone_number' => PaymentHelper::getCustomerPhoneNumber($submission, $form),
],
"redirect_url" => $listenerUrl
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Reference
apply_filters('fluentform/square_payment_args', $paymentArgs, $submission, $transaction, $form);
This filter is located in FluentFormPro\src\PaymentMethods\Square\SquareProcessor -> handleRedirect()
# fluentform/payment_methods_global_settings
You can use this filter to modify payment methods global settings.
Parameters
$globalSettings(array) Base Payment Method Global Settings
Usage
add_filter('fluentform/payment_methods_global_settings', function ($globalSettings) {
// Do your stuff here
return $globalSettings;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/payment_methods_global_settings', $globalSettings);
This filter is located in FluentFormPro\src\Payments\PaymentHandler -> renderPaymentSettings()
# fluentform/accepted_currencies
You can use this filter to modify payment methods accepted currencies list.
Parameters
$currencies(array) Base Payment Method Currencies
Usage
add_filter('fluentform/accepted_currencies', function ($currencies) {
// Do your stuff here
return $currencies;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/accepted_currencies', $currencies);
This filter is located in FluentFormPro\src\Payments\PaymentHandler -> getCurrencies()
# fluentform/currency_symbol
You can use this filter to modify currency symbols of payment methods accepted currencies.
Parameters
$currency_symbol(string) Currency Symbol in Unicode$currency(string) Currency Name
Usage
add_filter('fluentform/currency_symbol', function ($currency_symbol, $currency) {
// Do your stuff here
return $currency_symbol;
}, 10, 2);
2
3
4
5
6
Reference
apply_filters('fluentform/currency_symbol', $currency_symbol, $currency);
This filter is located in FluentFormPro\src\Payments\PaymentHandler -> getCurrencySymbol($currency = '')
# fluentform/currencies_symbols
You can use this filter to modify currency symbols of payment methods accepted currencies.
Parameters
$symbols(array) Currency Symbols List in Unicode
Usage
add_filter('fluentform/currencies_symbols', function ($symbols) {
// Do your stuff here
return $symbols;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/currencies_symbols', $symbols);
This filter is located in FluentFormPro\src\Payments\PaymentHelper -> getCurrencySymbols()
# fluentform/zero_decimal_currencies
You can use this filter to modify zero payment supported currencies of payment methods.
Parameters
$zeroDecimalCurrencies(array) Zero Decimal Payment Supported Currencies
Usage
add_filter('fluentform/zero_decimal_currencies', function ($zeroDecimalCurrencies) {
// Do your stuff here
return $zeroDecimalCurrencies;
}, 10, 1);
2
3
4
5
6
Reference
apply_filters('fluentform/zero_decimal_currencies', $zeroDecimalCurrencies);
This filter is located in FluentFormPro\src\Payments\PaymentHelper -> zeroDecimalCurrencies()