# Fluent Forms Action Hooks
FluentForms Core IntermediateFluent Forms has many interesting action hooks that let developers change default settings and even extend Fluent Forms with new functionality.
# What are Action Hooks
Action hooks are used to run custom code when certain events occur.
# Available Action Hooks
# Plugin Specific
# fluentform/loaded
Description
This action fires after fluentform plugin is loaded.
Parameters
$app(object) App Instance
Usage
add_action('fluentform/loaded', function($app) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/loaded', $app);
This hook is located in fluentform/boot/app.php
# fluentform/pre_load_scripts
Description
This action fires after fluentform plugin is loaded.
Parameters
$post(object) Global post
Usage
add_action('fluentform/pre_load_scripts', function($post) {
// Do your stuff here
}, 10, 1);
2
3
Reference
$this->app->doAction('fluentform/pre_load_scripts', $post);
This hook is located in fluentform/app/Modules/Component/Component.php
# fluentform/scripts_registered
Description
This action fires after fluentform scripts are registered.
Usage
add_action('fluentform/scripts_registered', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/scripts_registered');
This hook is located in fluentform/app/Modules/Component/Component.php
# fluentform/loading_editor_assets
Description
This action runs during asset loading for the editor. You can hook into this action and load your custom scripts or do other tasks.
Parameters
$form(object) Form
Usage
add_action('fluentform/loading_editor_assets', function($form) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/loading_editor_assets', $form);
This hook is located in fluentform/app/Modules/Registerer/Menu.php.
# fluentform/global_menu
Description
This action runs before rendering the admin menu.
Usage
add_action('fluentform/global_menu', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/global_menu');
This hook is located in app/Views/admin/**/*.php.
# Submission Specific
# fluentform/before_insert_submission
Description
This action runs before a submission is inserting
Parameters
$insertDataInsert Model$dataForm Data$formForm Object
Usage:
add_action('fluentform/before_insert_submission', function($insertData, $data, $form) {
// Do whatever you want before inserting a submission
}, 10, 3);
2
3
Reference
do_action('fluentform/before_insert_submission', $insertData, $formDataRaw, $this->form);
This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php
# fluentform/submission_inserted
Description
This action runs after a submission was inserted
Parameters
$submissionIdSubmission ID$formDataForm Data$formForm Object
Usage:
add_action('fluentform/submission_inserted', function($submissionId, $formData, $form) {
// Do whatever you want with the new submission
}, 10, 3);
2
3
Reference
$this->app->doAction('fluentform/submission_inserted', $insertId, $formData, $form);
This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php
# fluentform/before_submission_confirmation
Description
This action runs after all the actions are completed regarding the form submission and before the submission confirmation message.
Parameters
$submissionIdSubmission ID$formDataForm Data$formForm Object
Usage:
add_action('fluentform/before_submission_confirmation', function($submissionId, $formData, $form) {
// Do whatever you want here
}, 10, 3);
2
3
Reference
do_action('fluentform/before_submission_confirmation', $insertId, $formData, $form);
This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php
# fluentform/entry_confirmation
Description
This action runs during the confirmation process of double opt-in. Using this action fluent form confirms the subscription of double optin. You can also use this to run your script during the confirmation process.
Parameters
$_REQUEST(array) Global PHP Request
Usage:
add_action('fluentform/entry_confirmation', function($_REQUEST) {
// Do whatever you want here
}, 10);
2
3
Reference
do_action('fluentform/entry_confirmation', $_REQUEST);
This action is located in fluentformpor/src/classes/SharePage/SharePage.php
# fluentform/before_form_actions_processing
Description
This action fires after form submission and before processing the form’s additional actions. If you want to do any task before form submission
Parameters
$submissionIdSubmission ID$formDataForm Data$formForm Object
Usage:
add_action('fluentform/before_form_actions_processing', function($submissionId, $formData, $form){
// Do your stuff here
}, 10, 3)
2
3
Reference
do_action('fluentform/before_form_actions_processing', $insertId, $this->formData, $this->form);
This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php
# fluentform/before_insert_payment_form
Description
If the form has payment then this action will be fired before submission. You can use this to do your payment related custom tasks.
Parameters
$insertDataForm response data$formDataForm Raw Data$formForm Object
Usage:
add_action('fluentform/before_insert_payment_form', function ($insertData, $formRawData, $form){
// Do your stuff here
}, 10, 3);
2
3
Reference
do_action('fluentform/before_insert_payment_form', $insertData, $formDataRaw, $this->form);
This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php
# fluentform/submission_inserted_{$form_type}_form
Description
This action runs after a submission was inserted
Parameters
$submissionId(int) Submission Id$formData(array) Form Raw Data$form(object) Form Object
Usage:
add_action('fluentform/submission_inserted_{$form_type}_form', function ($submissionId, $formData, $form){
// Do whatever you want with the new submission base on specifiy form type
}, 10, 3);
2
3
Note: {$form_type} is dynamic value. Replace {$form_type} with your form type.
Reference
$this->app->doAction('fluentform/submission_inserted', $insertId, $formData, $form);
This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php
# fluentform/notify_on_form_submit
Description
This action runs after a submission was inserted
Parameters
$submissionId(int) Submission Id$formData(array) Form Raw Data$form(object) Form Object
Usage:
add_action('fluentform/notify_on_form_submit', function ($submissionId, $formData, $form){
// Do whatever you want with the new submission base on specifiy form type
}, 10, 3);
2
3
Reference
do_action('fluentform/notify_on_form_submit', $insertId, $this->formData, $this->form);
This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php, fluentfomrpro/src/Payments/Classes/PaymentAction.php.
# fluentform/submission_user_changed
Description
This action runs after a submission user changed
Parameters
$submission(object) Submission$user(object) User
Usage:
add_action('fluentform/submission_user_changed', function ($submission, $user){
// Do your stuff
}, 10, 2);
2
3
Reference
do_action('fluentform/submission_user_changed', $submission, $user);
This action is located in fluentform/app/Services/Submission/SubmissionService.php -> updateSubmissionUser().
# fluentform/before_deleting_entries
Description
This action runs before deleting a submission.
Parameters
$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/before_deleting_entries', function ($submissionIds, $formId){
// Do your stuff
}, 10, 2);
2
3
Reference
do_action('fluentform/before_deleting_entries', $submissionIds, $formId);
This action is located in fluentform/app/Services/Submission/SubmissionService.php -> deleteEntries().
# fluentform/after_deleting_submissions
Description
This action runs after deleting a submission.
Parameters
$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/after_deleting_submissions', function ($submissionIds, $formId){
// Do your stuff
}, 10, 2);
2
3
Reference
do_action('fluentform/after_deleting_submissions', $submissionIds, $formId);
This action is located in fluentform/app/Services/Submission/SubmissionService.php -> deleteEntries().
# fluentform/submission_note_stored
Description
This action runs after submission note saved.
Parameters
$submissionMetaId(int) Submission meta ID$submissionMeta(object) Submission meta
Usage:
add_action('fluentform/submission_note_stored', function ($submissionMetaId, $submissionMeta){
// Do your stuff
}, 10, 2);
2
3
Reference
do_action('fluentform/submission_note_stored', $submissionMeta->id, $submissionMeta);
This action is located in fluentform/app/Services/Submission/SubmissionService.php -> storeNote().
# fluentform/log_data
Description
This action for adding log on FluentForm log table. You should do_action and pass log data for adding log.
Usage:
do_action('fluentform/log_data', [
'parent_source_id' => $submission->form_id,
'source_type' => 'submission_item',
'source_id' => $submission->id,
'component' => 'My Log',
'status' => 'info',
'title' => 'Log title',
'description' => 'Log Description',
]);
2
3
4
5
6
7
8
9
Data
parent_source_id(int) Form IDsource_type(string) Source typesource_id(int) Submission IDcomponent(sort string) Component titlestatus(string) StatusinfoFor informative logpendingFor pending logerrorFor error logsuccessFor success logfailedFor failed log
title(string) Message titledescription(string) Message details
This action is added in fluentform/app/Hooks/actions.php.
# Partial Submission Specific
# fluentform/partial_submission_added
Description
This action runs after partial submission saved.
Parameters
$formData(array) Form raw data$response(array) Inserted data$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/partial_submission_added', function ($formData, $response, $submissionId, $formId){
// Do your stuff
}, 10, 4);
2
3
Reference
do_action('fluentform/partial_submission_added', $formData['data'], $response, $insertId, $formId);
This action is located in fluentformpro/src/classes/DraftSubmissionsManager.php -> saveState().
# fluentform/saved_progress_submission_added
Description
This action runs when partial submission have no steps.
Parameters
$formData(array) Form raw data$response(array) Inserted data$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/saved_progress_submission_added', function ($formData, $response, $submissionId, $formId){
// Do your stuff
}, 10, 4);
2
3
Reference
do_action('fluentform/saved_progress_submission_added', $formData['data'], $response, $insertId, $formId);
This action is located in fluentformpro/src/classes/DraftSubmissionsManager.php -> saveState().
# fluentform/partial_submission_step_completed
Description
This action runs when partial submission steps complete.
Parameters
$activeStep(array) Active Step$formData(array) Form raw data$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/partial_submission_step_completed', function ($activeStep, $formData, $submissionId, $formId){
// Do your stuff
}, 10, 4);
2
3
Reference
do_action('fluentform/partial_submission_step_completed', $formData['active_step'], $formData['data'], $insertId, $formId);
This action is located in fluentformpro/src/classes/DraftSubmissionsManager.php -> saveState().
# fluentform/partial_submission_updated
Description
This action runs after partial submission steps complete.
Parameters
$formData(array) Form raw data$activeStep(array) Active Step$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/partial_submission_updated', function ($formData, $activeStep, $submissionId, $formId){
// Do your stuff
}, 10, 4);
2
3
Reference
do_action('fluentform/partial_submission_updated', $formData['data'], $formData['active_step'], $insertId, $formId);
This action is located in fluentformpro/src/classes/DraftSubmissionsManager.php -> saveState().
# fluentform/saved_progress_submission_updated
Description
This action runs when partial submission has no active step is.
Parameters
$formData(array) Form raw data$activeStep(array) Active Step$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/saved_progress_submission_updated', function ($formData, $activeStep, $submissionId, $formId){
// Do your stuff
}, 10, 4);
2
3
Reference
do_action('fluentform/saved_progress_submission_updated', $formData['data'], $formData['active_step'], $insertId, $formId);
This action is located in fluentformpro/src/classes/DraftSubmissionsManager.php -> saveState().
# fluentform/before_partial_entry_deleted
Description
This action runs before partial submission deleted.
Parameters
$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/before_partial_entry_deleted', function ($submissionId, $formId){
// Do your stuff
}, 10, 2);
2
3
Reference
do_action('fluentform/before_partial_entry_deleted', $formData['data'], $formData['active_step'], $insertId, $formId);
This action is located in fluentformpro/src/classes/StepFormEntries.php -> deleteEntryById().
# fluentform/after_partial_entry_deleted
Description
This action runs after partial submission deleted.
Parameters
$submissionId(int) Submission ID$formId(int) Form ID
Usage:
add_action('fluentform/after_partial_entry_deleted', function ($submissionId, $formId){
// Do your stuff
}, 10, 2);
2
3
Reference
do_action('fluentform/after_partial_entry_deleted', $formData['data'], $formData['active_step'], $insertId, $formId);
This action is located in fluentformpro/src/classes/StepFormEntries.php -> deleteEntryById().
# fluentform/saved_progress_submission_deleted
Description
This action runs after partial state deleted.
Parameters
$draft(array) Form raw data$formId(int) Form ID
Usage:
add_action('fluentform/saved_progress_submission_deleted', function ($draft, $formId){
// Do your stuff
}, 10, 2);
2
3
Reference
do_action('fluentform/saved_progress_submission_deleted', $draft, $form->id);
This action is located in fluentformpro/src/classes/DraftSubmissionsManager.php -> deleteSavedStateDraft().
# fluentform/partial_submission_deleted
Description
This action runs after partial state deleted.
Parameters
$draft(array) Form raw data$formId(int) Form ID
Usage:
add_action('fluentform/partial_submission_deleted', function ($draft, $formId){
// Do your stuff
}, 10, 2);
2
3
Reference
do_action('fluentform/partial_submission_deleted', $draft, $form->id);
This action is located in fluentformpro/src/classes/DraftSubmissionsManager.php -> deleteSavedStateDraft().
# fluentform/email_form_resume_link_before_sent
Description
This action fire before sending email resume link for partial submission.
Parameters
$emailFormat(array) Email Format$submittedData(array) Partial Submitted Data$requestData(array) Request Data$form(object) Form
Usage:
add_action('fluentform/email_form_resume_link_before_sent', function($emailFormat, $submittedData, $requestData, $form) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/email_form_resume_link_before_sent', $emailFormat, $submittedData, $requestData, $form);
This action is located in fluentformpro/src/classes/DraftSubmissionsManager.php -> emailProgressLink()
# Form Specific
# fluentform/inserted_new_form
Description
This action fires after the new form is created. If you want to do certain task after a form creation then you can catch this action hook and do your staff.
parameters
$formId(int) Form Id$data(array) Form Data
Usage:
add_action('fluentform/inserted_new_form', function($formId, $data) {
// Do your stuff when form is created
}, 10, 2);
2
3
Reference
do_action('fluentform/inserted_new_form', $form->id, $data);
This action is located in fluentform/app/Services/Form/FormService.php
# fluentform/form_element_start
Description
This action runs before rendering the input elements of the form. If you need to do anything in the background you can use this action.
parameters
$form(object) Form Object
Usage:
add_action('fluentform/form_element_start', function($formId, $data) {
// Do your stuff when form element start
}, 10, 1);
2
3
Reference
do_action('fluentform/form_element_start', $form);
This action is located in fluentform/app/Services/FormBuilder/FormBuilder.php -> build()
# fluentform/form_duplicated
Description
After a form is duplicated this action is fired.
parameters
$newFormId(int) Form Id
Usage:
add_action('fluentform/form_duplicated', function($form$newFormId) {
// Do your stuff when form is duplicated
}, 10, 1);
2
3
Reference
do_action('fluentform/form_duplicated', $form->id);
This action is located in fluentform/app/Services/Form/FormService.php
# oxygen_add_plus_fluentform_form
Description
This action runs when register Fluent Forms Oxygen widget sections.
Usage:
add_action('oxygen_add_plus_fluentform_form', function() {
// Do your stuff when register oxyget plus widget
}, 10, 0);
2
3
Reference
do_action('oxygen_add_plus_fluentform_form');
This action is located in fluentform/app/Modules/Widgets/OxygenWidget.php
# fluentform/load_form_assets
Description
This action fires when loading the form asset.
Parameters
$formId(int) Form Id
Usage:
add_action('fluentform/load_form_assets', function($formId) {
// Do your stuff when load form assets
}, 10, 1);
2
3
Reference
do_action('fluentform/load_form_assets', $formId);
This action is located in fluentform/app/Modules/Widgets/OxygenWidget.php, fluentformpro/src/classes/SharePage/SharePage.php, fluentform/app/Hooks/actions.php.
# fluentform/init_custom_stylesheet
Description
This action run when a custom style is applied to the form . You can also push your own style using this.
Parameters
$selectedStyle(string) Selected style type$formId(int) Form Id
Usage:
add_action('fluentform/init_custom_stylesheet', function($selectedStyle, $formId) {
// Do your stuffs here
// enque style
}, 10, 2);
2
3
4
Reference
do_action('fluentform/init_custom_stylesheet', $selectedStyle, $formId);
This action is located in fluentformpro/src/classes/FormStyler.php, fluentform/app/Hooks/actions.php.
# fluentform/form_application_view_{$route}
Description
This action runs admin page view. You can hook into it and run your script depending on the current route and form ID.
Parameters
$form_id(int) Form ID
Usage:
add_action('fluentform/form_application_view_{$route}', function($form_id) {
// Do your stuff here
}, 10, 2);
2
3
Note: {$route} is a dynamic route. Replace {$route} with Fluent Forms admin route key.
Reference
do_action('fluentform/form_application_view_' . $route, $form_id);
This action is located in fluentform/app/Views/admin/form/form_wrapper.php
# fluentform/after_form_navigation
Description
This action runs after add navigation buttons to the admin page header.
Parameters
$form_id(int) Form ID$route(string) Current Route
Usage:
add_action('fluentform/after_form_navigation', function($form_id, $route) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/after_form_navigation', $form_id, $route);
This action is located in fluentform/app/Views/admin/form/form_wrapper.php
# fluentform/after_form_navigation_{$route}
Description
This action runs after add navigation buttons to the admin page header.
Parameters
$form_id(int) Form ID
Usage
add_action('fluentform/after_form_navigation_{$route}', function($form_id) {
// Do your stuff here
}, 10, 1);
2
3
Note: {$route} is a dynamic route. Replace {$route} with Fluent Forms admin route key.
Reference
do_action('fluentform/after_form_navigation_' . $route, $form_id);
This action is located in fluentform/app/Views/admin/form/form_wrapper.php
# fluentform/before_permission_set_assignment
Description
This action runs before fluentform is going to assign permission set to a role.
Usage
add_action('fluentform/before_permission_set_assignment', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/before_permission_set_assignment');
This hook is located in fluentform/app/Modules/Acl/Acl.php
# fluentform/after_permission_set_assignment
Description
This action runs after fluentform is assigned permission set to a role.
Usage
add_action('fluentform/after_permission_set_assignment', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/after_permission_set_assignment');
This hook is located in fluentform/app/Modules/Acl/Acl.php
# fluentform/rendering_calculation_form
Description
This action runs if the form input has calculation in it and during rendering the input . If you need to do anything in the background you can use this action.
Parameters
$form(object) Form$field(array) Input Element
Usage
add_action('fluentform/rendering_calculation_form', function($form, $field) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/rendering_calculation_form', $form, $field);
This hook is located in fluentform/app/Services/FluentConversational/Classes/Converter/Converter.php, fluentfomr/app/Services/FormBuilder/Components/Text.php.
# fluentform/render_item_{$item_element}
Description
This action runs every time an input item is rendered. If you need to do anything in the background you can use this action. $item is the key of the component that is being rendered.
Parameters
$item(array) Input Element$form(object) Form Object
Usage
add_action('fluentform/render_item_{$item_element}', function($item, $form) {
// Do your stuff here
}, 10, 2);
2
3
Note: {$item_element} is dynamic field element name. Replace {$item_element} with valid Fluent Forms field element name.
Reference
do_action('fluentform/render_item_' . $item['element'], $item, $form);
This hook is located in fluentform/app/Modules/Component/Component.php.
# fluentform/after_form_render
Description
This action runs after the form rendering is completed. If you need to do anything in the background you can use this action.
Parameters
$form(object) Form Object
Usage
add_action('fluentform/after_form_render', function($form) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/after_form_render', $form);
This hook is located in fluentform/app/Services/FormBuilder/FormBuilder.php.
# fluentform/form_imported
Description
This action is fired after a form is imported. So you can use this hook and run your script after a form is imported
Parameters
$form_id(int) Form ID
Usage
add_action('fluentform/form_imported', function($form_id) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/form_imported', $formId);
This hook is located in fluentform/app/Services/Form/FormService.php.
# fluentform/before_form_render
Description
This action fires right before the form is rendered. If you want to do certain task after a form rendering then you can catch this action hook and do your staff.
Parameters
$form(object) Form Object
Usage
add_action('fluentform/before_form_render', function($form) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/before_form_render', $form);
This hook is located in fluentform/app/Services/FormBuilder/FormBuilder.php.
# fluentform/before_all_forms_render
Description
This action fires before the all form page is rendering.
Usage
add_action('fluentform/before_all_forms_render', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/before_all_forms_render');
This hook is located in fluentform/app/Views/admin/all_forms.php.
# fluentform/after_all_forms_render
Description
This action fires after all form page was rendered.
Usage
add_action('fluentform/after_all_forms_render', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/after_all_forms_render');
This hook is located in fluentform/app/Views/admin/all_forms.php.
# fluentform/before_form_screen_wrapper
Description
This action runs after the fluent form editor wrapper in the admin panel. If you need to do anything in the background you can use this action.
Parameters
$form_id(int) Form ID$route(string) Route
Usage
add_action('fluentform/before_form_screen_wrapper', function($form_id, $route) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/before_form_screen_wrapper', $form_id, $route);
This hook is located in fluentform/app/Views/admin/form/form_wrapper.php.
# fluentform/after_form_screen_wrapper
Description
This action runs after the fluent form editor wrapper in the admin panel. If you need to do anything in the background you can use this action.
Parameters
$form_id(int) Form ID$route(string) Route
Usage
add_action('fluentform/after_form_screen_wrapper', function($form_id, $route) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/after_form_screen_wrapper', $form_id, $route);
This hook is located in fluentform/app/Views/admin/form/form_wrapper.php.
# fluentform/render_item_submit_button
Description
This action runs every time when submit button is rendered. If you need to do anything in the background you can use this action.
Parameters
$submitButton(array) Input Element$form(object) Form Object
Usage
add_action('fluentform/render_item_submit_button', function($submitButton, $form) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/render_item_submit_button', $form->fields['submitButton'], $form);
This hook is located in fluentform/app/Modules/Component/Component.php.
# fluentform/starting_file_upload
Description
This action run before uploading a file.
Parameters
$files(array) Files$form(object) Form Object
Usage
add_action('fluentform/starting_file_upload', function($files, $form) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/starting_file_upload', $files, $this->form);
This hook is located in fluentformpro/src/Uploader.php -> upload().
# fluentform/starting_file_processing
Description
This action run when processing uploaded file.
Parameters
$files(array) Files$uploadLocation(string) Files Upload Location$formData(array) Submission Data$form(object) Form Object
Usage
add_action('fluentform/starting_file_processing', function($files, $uploadLocation, $formData, $form) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/starting_file_processing', $files, $uploadLocation, $formData, $form);
This hook is located in fluentformpro/src/Uploader.php -> processFiles().
# fluentform/rendering_address_field
Description
This action run when render address field.
Parameters
$field(array) Field Data$form(object) Form Object
Usage
add_action('fluentform/rendering_address_field', function($field, $form) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/rendering_address_field', $data, $form);
This hook is located in fluentform/app/Services/FormBuilder/Components/Address.php -> compile().
# fluentform/before_documentation_wrapper
Description
This action run before render support page documentation.
Usage
add_action('fluentform/before_documentation_wrapper', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/before_documentation_wrapper');
This hook is located in fluentform/app/Views/admin/docs/index.php.
# fluentform/after_documentation_wrapper
Description
This action run after render support page documentation.
Usage
add_action('fluentform/after_documentation_wrapper', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/after_documentation_wrapper');
This hook is located in fluentform/app/Views/admin/docs/index.php.
# Form Styler Specific
# fluentform/form_styler
Description
This action runs before rendering the form styler in preview section.
parameters
$formId(int) Form Id
Usage:
add_action('fluentform/form_styler', function($formId) {
// Do your stuff
}, 10, 1);
2
3
Reference
do_action('fluentform/form_styler', $form_id);
This action is located in fluentform/app/Views/frameless/show_preview.php
# fluentform/after_style_generated
Description
This action runs after generating the style meta for the form.
parameters
$formId(int) Form Id
Usage:
add_action('fluentform/after_style_generated', function($formId) {
// Do your stuff
}, 10, 1);
2
3
Reference
do_action('fluentform/after_style_generated', $formId);
This action is located in fluentformpro/src/classes/FormStyler.php
# Editor Specific
# fluentform/editor_init
Description
This action runs right after initializing the fluent form editor in the admin panel. If you need to do anything in the background you can use this action.
Parameters
$components(array) Editor Components
Usage
add_action('fluentform/editor_init', function($components) {
// Do your stuff here
}, 10, 1);
2
3
Reference
$this->app->doAction('fluentform/editor_init', $components);
This hook is located in fluentform/app/Modules/Component/Component.php.
# fluentform/before_editor_start
Description
This action runs before the fluent form editor in the admin panel. If you need to do anything in the background you can use this action.
Usage
add_action('fluentform/before_editor_start', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/before_editor_start');
This hook is located in fluentform/app/Views/admin/form/editor.php.
# fluentform/after_editor_start
Description
This action runs after the fluent form editor wrapper. If you need to do anything in the background you can use this action.
Usage
add_action('fluentform/after_editor_start', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/after_editor_start');
This hook is located in fluentform/app/Views/admin/form/editor.php.
# fluentform/after_all_entries_render
Description
This action runs after rendering the all entries page.
Usage
add_action('fluentform/after_all_entries_render', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/after_all_entries_render');
This hook is located in fluentform/app/views/admin/all_entries.php.
# fluentform/before_all_entries_render
Description
This action runs before rendering the all entries page.
Usage
add_action('fluentform/before_all_entries_render', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/before_all_entries_render');
This hook is located in fluentform/app/views/admin/all_entries.php.
# fluentform/admin_nave_menu_{$itemKey}
Description
This action runs when admin menu render. You can hook into it and run your script when admin menu render.
Usage:
add_action('fluentform/admin_nave_menu_{$itemKey}', function() {
// Do your stuff here
}, 10, 0);
2
3
Note: {$itemKey} is a dynamic nav item name. Replace {$itemKey} with Fluent Forms admin name item key.
Reference
do_action("fluentform/admin_nav_menu_{$itemKey}");
This action is located in fluentform/app/Modules/Registerer/AdminBar.php
# fluentform/before_no_permission
Description
This action runs before rendering no permission view.
Usage:
add_action('fluentform/before_no_permission', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/before_no_permission');
This action is located in fluentform/app/Views/admin/no_permission.php
# fluentform/after_no_permission
Description
This action runs after rendering no permission view.
Usage:
add_action('fluentform/after_no_permission', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/after_no_permission');
This action is located in fluentform/app/Views/admin/no_permission.php
# Settings Specific
# fluentform/admin_nav_menu_{$item_key}
Description
This action runs when add Fluent Forms admin menu
Usage:
add_action('fluentform/admin_nav_menu_{$item_key}', function() {
// Do your stuff when add fluentform admin menu
}, 10, 0);
2
3
Note: {$item_key} is a dynamic key. Replace {$item_key} with Fluent Forms admin menu key.
Reference
do_action("fluentform/admin_nav_menu_{$itemKey}");
This action is located in fluentform/app/Modules/Registerer/AdminBar.php
# fluentform/after_save_form_settings
Description
This action runs after saving the form from admin panel. You can hook into this action and extract any data you data need from the $allSettings array.
Parameters
- $formId (int) Form Id
- $allSettings (array) Form All Settings
Usage:
add_action('fluentform/after_save_form_settings', function($formId, $allSettings) {
// Do your stuff when
}, 10, 2);
2
3
Reference
do_action('fluentform/after_save_form_settings', $formId, $attributes);
This action is located in fluentform/app/Services/Settings/SettingsService.php, fluentform/app/Modules/Form/Settings/FormSettings.php
# fluentform/before_global_settings_wrapper
Description
Before rendering the form global settings page this hook is available.
Usage:
add_action('fluentform/before_global_settings_wrapper', function() {
// Do your stuff when
}, 10, 0);
2
3
Reference
do_action('fluentform/before_global_settings_wrapper');
This action is located in fluentform/app/Views/admin/settings/index.php
# fluentform/after_global_settings_wrapper
Description
After rendering the form settings page this hook is available.
Usage:
add_action('fluentform/after_global_settings_wrapper', function() {
// Do your stuff when
}, 10, 0);
2
3
Reference
do_action('fluentform/after_global_settings_wrapper');
This action is located in fluentform/app/Views/admin/settings/index.php
# fluentform/before_form_settings_app
Description
This action fires before fluentform plugin rendered.
Parameters
$form_id(int) Form ID
Usage:
add_action('fluentform/before_form_settings_app', function($form_id) {
// Do your stuff when
}, 10, 1);
2
3
Reference
do_action('fluentform/before_form_settings_app', $form_id);
This action is located in fluentform/app/Views/admin/form/settings.php
# fluentform/after_form_settings_app
Description
This action fires after fluentform plugin is loaded.
Parameters
$form_id(int) Form ID
Usage:
add_action('fluentform/after_form_settings_app', function($form_id) {
// Do your stuff when
}, 10, 1);
2
3
Reference
do_action('fluentform/after_form_settings_app', $form_id);
This action is located in fluentform/app/Views/admin/form/settings.php
# fluentform/before_global_settings_option_render
Description
This action fires on each global settings component before rendering the page.
Usage:
add_action('fluentform/before_global_settings_option_render', function() {
// Do your stuff when
}, 10, 0);
2
3
Reference
do_action('fluentform/before_global_settings_option_render');
This action is located in fluentform/app/Views/admin/settings/settings.php
# fluentform/after_global_settings_option_render
Description
This hook is available before rendering the global settings option page. Fore example Custom CSS/JS page.
Usage:
add_action('fluentform/after_global_settings_option_render', function() {
// Do your stuff when
}, 10, 0);
2
3
Reference
do_action('fluentform/after_global_settings_option_render');
This action is located in fluentform/app/Views/admin/settings/settings.php
# fluentform/form_settings_container_{$current_route}
Description
This hook runs before rendering the settings page container.
Parameters
$form_id(int) Form ID
Usage:
add_action('fluentform/form_settings_container_{$current_route}', function($form_id) {
// Do your stuff when add fluentform admin menu
}, 10, 1);
2
3
Note: {$current_route} is a dynamic settings route. Replace {$current_route} with Fluent Forms settings route.
Reference
do_action('fluentform/form_settings_container_' . $current_sub_route, $form_id);
This action is located in fluentform/app/Views/admin/form/settings_wrapper.php
# fluentform/global_settings_component_{$current_component}
Description
This action fires on each global settings component. For example reCaptcha
Usage:
add_action('fluentform/global_settings_component_{$current_component}', function() {
// Do your stuff when add fluentform admin menu
}, 10, 0);
2
3
Note: {$current_component} is a dynamic component name. Replace {$current_component} with Fluent Forms component name.
Reference
do_action('fluentform/global_settings_component_' . $currentComponent);
This action is located in fluentform/app/Views/admin/settings/index.php
# fluentform/before_tools_wrapper
Description
This action fires before tool settings render. Do your stuff before tool settings rendered.
Usage:
add_action('fluentform/before_tools_wrapper', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/before_tools_wrapper');
This action is located in fluentform/app/Views/admin/tools/index.php
# fluentform/after_tools_wrapper
Description
This action fires after tool settings render. Do your stuff after tool settings rendered.
Usage:
add_action('fluentform/after_tools_wrapper', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/after_tools_wrapper');
This action is located in fluentform/app/Views/admin/tools/index.php
# fluentform/before_tools_container
Description
This action fires before tool setting body render. Do your stuff before tool settings body rendered.
Usage:
add_action('fluentform/before_tools_container', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/before_tools_container');
This action is located in fluentform/app/Views/admin/tools/index.php
# fluentform/after_tools_container
Description
This action fires after tool settings body render. Do your stuff after tool settings body rendered.
Usage:
add_action('fluentform/after_tools_container', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/after_tools_container');
This action is located in fluentform/app/Views/admin/tools/index.php
# fluentform/email_template_after_footer
Description
This action fire after email template footer rendered.
Parameters
$form(object) Form Object$notification(array) Email Notification
Usage:
add_action('fluentform/email_template_after_footer', function($form, $notification) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action( 'fluentform/email_template_after_footer', $form, $notification );
This action is located in fluentform/app/Views/email/template/footer.php
# fluentform/do_scheduled_tasks
Description
This action fire when register schedule task event.
Usage:
add_action('fluentform/do_scheduled_tasks', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action( 'fluentform/do_scheduled_tasks');
This action is located in fluentform/app/Hooks/Handlers/ActivationHandler.php -> setCronSchedule(), fluentform/app/Hooks/actions.php
# fluentform/do_email_report_scheduled_tasks
Description
This action fire when register email report schedule task event.
Usage:
add_action('fluentform/do_email_report_scheduled_tasks', function() {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action( 'fluentform/do_email_report_scheduled_tasks');
This action is located in fluentform/app/Hooks/Handlers/ActivationHandler.php -> setCronSchedule(), fluentform/app/Hooks/actions.php
# fluentform/email_summary_details
Description
This action fire when process email report.
Parameters
$emailData(array) Email Send Data$data(array) Config Data$emailResult(bool|mixed) wp_mail response
Usage:
add_action('fluentform/email_summary_details', function($emailData, $data, $emailResult) {
// Do your stuff here
}, 10, 3);
2
3
Reference
do_action('fluentform/email_summary_details', [
'recipients' => $recipients,
'email_subject' => $emailSubject,
'email_body' => $emailBody
], $data, $emailResult);
2
3
4
5
This action is located in fluentform/app/Services/Scheduler/Scheduler.php -> processEmailReport()
# fluentform/saving_global_settings_with_key_method
Description
This action fire when store global settings.
Parameters
$attributes(array) Request params
Usage:
add_action('fluentform/saving_global_settings_with_key_method', function($attributes) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/saving_global_settings_with_key_method', $attributes);
This action is located in fluentform/app/Services/GlobalSettings/GlobalSettingsService.php-> store()
# Payment Specific
# fluentform/rendering_payment_form
Description
This action runs when rendering payment form.
Parameters
$form(object) Payment Form
Usage
add_action('fluentform/rendering_payment_form', function($form) {
// Do your stuff when rendering payment form
}, 10, 1);
2
3
Reference
do_action('fluentform/rendering_payment_form', $form);
This action is located in fluentform/app/Modules/Component/Component.php
# fluentform/before_insert_payment_form
Description
If the form has payment then this action will be fired before submission. You can use this to do your payment related custom tasks.
Parameters
$insertDataForm response data$formDataForm Raw Data$formForm Object
Usage:
add_action('fluentform/before_insert_payment_form', function ($insertData, $formRawData, $form){
// Do your stuff here
}, 10, 3);
2
3
Reference
$this->app->doAction('fluentform/submission_inserted_' . $form->type . '_form', $insertId, $formData, $form);
This action is located in fluentform/app/Services/Form/SubmissionHandlerService.php
# fluentform/render_payment_entries
Description
This action runs before rendering the payment entries.
Usage:
add_action('fluentform/render_payment_entries', function (){
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/render_payment_entries');
This action is located in fluentform/app/Modules/Registerer/Menu.php
# fluentform/rendering_payment_method_{$methodName}
Description
This action runs when rendering the payment active methods.
Parameters
$paymentMethod- (string) Current Payment Method$data- (array) Current Payment Element$form- (object) Form
Usage:
add_action('fluentform/rendering_payment_method_{$methodName}', function ($paymentMethod, $data, $form){
// Do your stuff here
}, 10, 3);
2
3
Note: {$methodName} is dynamic method name. Replace {$methodName} with Fluent Forms payment methods name.
Reference
do_action('fluentform/rendering_payment_method_' . $methodName, $activatedMethod, $data, $form);
This action is located in fluentformpro/src/Payments/Components/PaymentMethods.php, fluentform/app/Services/FluentConversational/Classes/Converter/Converter.php
# fluentform/payment_frameless_{$paymentMethod}
Description
This action runs before rendering the payment redirect handler page.
Parameters
$data- (array) Payment Data
Usage:
add_action('fluentform/payment_frameless_{$paymentMethod}', function ($data){
// Do your stuff here
}, 10, 1);
2
3
Note: {$paymentMethod} is dynamic method name. Replace {$paymentMethod} with Fluent Forms payment methods name.
Reference
do_action('fluentform/payment_frameless_' . $paymentMethod, $data);
This action is located in fluentformpro/src/Payments/PaymentHandler.php
# fluentform/payment_method_render_{$paymentMethod}
Description
This action runs if the form has single payment method, then the payment method is rendered using this method.
Parameters
$methodElement(array) Payment Method Data$form(object) Form Object
Usage:
add_action('fluentform/payment_method_render_{$paymentMethod}', function ($methodElement, $data){
// Do your stuff here
}, 10, 2);
2
3
Note: {$paymentMethod} is dynamic method name. Replace {$paymentMethod} with Fluent Forms payment methods name.
Reference
do_action('fluentform/payment_method_render_' . $paymentMethod, $methodElement, $data);
This action is located in fluentformpro/src/Payments/Components/PaymentMethods.php
# fluentform/payment_refunded
Description
This action runs after a successful refund on every payment method. You can hook into this and get the refund data.
Parameters
$refund(array) Refund Data$form_id(int) Form ID
Usage:
add_action('fluentform/payment_refunded', function($refund, $form_id) {
// Do your stuff here
}, 10, 2);
2
3
Note: {$paymentMethod} is dynamic method name. Replace {$paymentMethod} with Fluent Forms payment methods name.
Reference
do_action('fluentform/payment_refunded', $refund, $refund->form_id);
This action is located in fluentformpro/src/Payments/PaymentMethods/BaseProcessor.php
# fluentform/ipn_mollie_action_{$status}
Description
This action runs when Mollie ipn verification response.
Parameters
$submission(object) Submission Object$vendorData- (array) Transaction vendor data$data(array) Encoded vendor data
Usage:
add_action('fluentform/ipn_mollie_action_{$status}', function($submission, $vendorData, $data) {
// Do your stuff here
}, 10, 3);
2
3
Note: {$status} is valid Mollie payment status (opens new window). Replace {$status} with INP transaction type.
Reference
do_action('fluentform/ipn_mollie_action_' . $status, $submission, $vendorTransaction, $data);
This action is located in fluentformpro/src/Payments/PaymentMethods/Mollie/API/IPN.php
# fluentform/ipn_mollie_action_refunded
Description
This action runs when Mollie ipn verification response with refund.
Parameters
$amount(int) Refund Amount$submission(object) Submission Object$vendorData- (array) Transaction vendor data$data(array) Encoded vendor data
Usage:
add_action('fluentform/ipn_mollie_action_refunded', function($amount, $submission, $vendorData, $data) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/ipn_mollie_action_refunded', $refundAmount, $submission, $vendorTransaction, $data);
This action is located in fluentformpro/src/Payments/PaymentMethods/Mollie/API/IPN.php
# fluentform/ipn_razorpay_action_{$status}
Description
This action runs when Razorpay ipn verification response.
Parameters
$submission(object) Submission Object$vendorData- (array) Transaction vendor data$data(array) Encoded vendor data
Usage:
add_action('fluentform/ipn_razorpay_action_{$status}', function($submission, $vendorData, $data) {
// Do your stuff here
}, 10, 3);
2
3
Note: {$status} is valid Razorpay payment status.
Reference
do_action('fluentform/ipn_razorpay_action_' . $status, $submission, $vendorTransaction, $data);
This action is located in fluentformpro/src/Payments/PaymentMethods/RazorPay/API.php
# fluentform/ipn_razorpay_action_refunded
Description
This action runs when Razorpay ipn verification response with refund.
Parameters
$amount(int) Refund Amount$submission(object) Submission Object$vendorData- (array) Transaction vendor data$data(array) Encoded vendor data
Usage:
add_action('fluentform/ipn_razorpay_action_refunded', function($amount, $submission, $vendorData, $data) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/ipn_razorpay_action_refunded', $refundAmount, $submission, $vendorTransaction, $data);
This action is located in fluentformpro/src/Payments/PaymentMethods/RazorPay/API.php
# fluentform/stripe_customer_created
Description
This action runs after created Stripe customer.
Parameters
$data(array) Customer API response$customerArgs(array) Customer Args
Usage:
add_action('fluentform/stripe_customer_created', function($data, $customerArgs) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/stripe_customer_created', $response, $customerArgs);
This action is located in fluentformpro/src/Payments/PaymentMethods/Stripe/API/Customer.php
# fluentform/payment_stripe_failed
Description
This action runs when handle payment charge error.
Parameters
$submission(object) Submission$transaction(object) Transaction$formId(int) Form Id$charge(bool) Charged or not$type(string) Typecustomersubscriptioninvoicepayment_intentpayment_error
Usage:
add_action('fluentform/payment_stripe_failed', function($submission, $transaction, $formId, $charge, $type) {
// Do your stuff here
}, 10, 5);
2
3
Reference
do_action('fluentform/payment_stripe_failed', $submission, $transaction, $this->form->id, $charge, $type);
This action is located in fluentformpro/src/Payments/PaymentMethods/Stripe/StripeProcessor.php -> handlePaymentChargeError()
# fluentform/payment_failed
Description
This action runs when handle payment charge error.
Parameters
$submission(object) Submission$transaction(object) Transaction$formId(int) Form Id$charge(bool) Charged or not$type(string) Typecustomersubscriptioninvoicepayment_intentpayment_error
Usage:
add_action('fluentform/payment_failed', function($submission, $transaction, $formId, $charge, $type) {
// Do your stuff here
}, 10, 5);
2
3
Reference
do_action('fluentform/payment_failed', $submission, $transaction, $this->form->id, $charge, $type);
This action is located in fluentformpro/src/Payments/PaymentMethods/Stripe/StripeProcessor.php -> handlePaymentChargeError()
# fluentform/transactions_before_table
Description
This action runs before creating transactions receipt table.
Parameters
$transaction(array) Transactions
Usage:
add_action('fluentform/transactions_before_table', function($transactions) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/transactions_before_table', $transactions);
This action is located in fluentformpro/src/views/receipt/transactions_table.php
# fluentform/transaction_table_thead_row
Description
This action runs after creating transactions receipt table head (th).
Parameters
$transactions(array) Transactions
Usage:
add_action('fluentform/transaction_table_thead_row', function($transactions) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/transaction_table_thead_row', $transactions);
This action is located in fluentformpro/src/views/receipt/transactions_table.php
# fluentform/transactions_actions
Description
This action runs when render transaction receipt table body actions.
Parameters
$transaction(object) Transaction
Usage:
add_action('fluentform/transactions_actions', function($transaction) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/transactions_actions', $transaction);
This action is located in fluentformpro/src/views/receipt/transactions_table.php
# fluentform/transaction_table_tbody_row
Description
This action runs after render transaction receipt table body td.
Parameters
$transaction(object) Transaction$transactions(array) Transactions
Usage:
add_action('fluentform/transaction_table_tbody_row', function($transaction, $transactions) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/transaction_table_tbody_row', $transaction, $transactions);
This action is located in fluentformpro/src/views/receipt/transactions_table.php
# fluentform/transactions_before_table_close
Description
This action runs before closing transactions receipt table.
Parameters
$transactions(array) Transactions
Usage:
add_action('fluentform/transactions_before_table_close', function($transactions) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/transactions_before_table_close', $transactions);
This action is located in fluentformpro/src/views/receipt/transactions_table.php
# fluentform/transactions_after_table
Description
This action runs after created transaction receipt table.
Parameters
$transactions(array) Transactions
Usage:
add_action('fluentform/transactions_after_table', function($transactions) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/transactions_after_table', $transactions);
This action is located in fluentformpro/src/views/receipt/transactions_table.php
# fluentform/after_transaction_status_change
Description
This action runs when change transaction status.
Parameters
$status(string) Valid Payment Status$submission(object) Submission$transtionId(int) Transaction ID
Usage:
add_action('fluentform/after_transaction_status_change', function($status, $submission, $transtionId) {
// Do your stuff here
}, 10, 3);
2
3
Reference
do_action( 'fluentform/after_transaction_status_change', $newStatus, $this->getSubmission(), $transactionId );
This action is located in fluentformpro/src/Payments/PaymentMethods/BaseProcessor.php
# fluentform/ipn_paypal_action_{$txn_type}
Description
This action runs when PayPal ipn verification response. You can use to specify transaction type processing you want to perform.
Parameters
$encoded_data_array(array) Encoded Data$submissionId(int) Submission ID$submission(object) Submission Object$ipnVerified(boolean) Ipn Verification
Usage:
add_action('fluentform/ipn_paypal_action_{$txn_type}', function($encoded_data_array, $submissionId, $submission, $ipnVerified) {
// Do your stuff here
}, 10, 4);
2
3
Note: {$txn_type} is dynamic IPN transaction types (opens new window). Replace {$txn_type} with INP transaction type.
Reference
do_action('fluentform/ipn_paypal_action_' . $encoded_data_array['txn_type'], $encoded_data_array, $submissionId, $submission, $ipnVerified);
This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php
# fluentform/ipn_paypal_action_web_accept
Description
This action runs during the web accept PayPal ipn.
Parameters
$encoded_data_array(array) Encoded Data$submissionId(int) Submission ID$submission(object) Submission Object$ipnVerified(boolean) Ipn Verification
Usage:
add_action('fluentform/ipn_paypal_action_web_accept', function($encoded_data_array, $submissionId, $submission, $ipnVerified) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/ipn_paypal_action_web_accept', $encoded_data_array, $submissionId, $submission, $ipnVerified);
This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php
# fluentform/process_payment
Description
This action runs when process payment
Parameters
$submissionId(int) Form ID$submissionData(array) Submission Data$form(object) Form$methodSettings(array) Selected Method Settings$subscriptionItems(boolean) Is Subscription$totalPayable(int) Payable amount$submissionServiceHandler(object) Service Handler Instance
Usage:
add_action('fluentform/process_payment', function($submissionId, $submissionData, $form, $methodSettings, $subscriptionItems, $totalPayable, $submissionServiceHandler) {
// Do your stuff here
}, 10, 7);
2
3
Reference
do_action('fluentform/process_payment', $this->submissionId, $this->submissionData, $this->form, $this->methodSettings, !!$subscriptionItems, $totalPayable, $this->submissionServiceHandler);
This action is located in fluentformpro/src/Payments/Classes/PaymentAction.php
# fluentform/process_payment_{$method_name}
Description
This action runs when process payment.
Parameters
$submissionId(int) Form ID$submissionData(array) Submission Data$form(object) Form$methodSettings(array) Selected Method Settings$subscriptionItems(boolean) Is Subscription$totalPayable(int) Payable amount
Usage:
add_action('fluentform/process_payment_{$method_name}', function($submissionId, $submissionData, $form, $methodSettings, $subscriptionItems, $totalPayable) {
// Do your stuff here when process payment
}, 10, 6);
2
3
Note: {$method_name} is dynamic value. Replace {$method_name} with valid fluent form payment method name.
Reference
do_action('fluentform/process_payment_' . $this->selectedPaymentMethod, $this->submissionId, $this->submissionData, $this->form, $this->methodSettings, !!$subscriptionItems, $totalPayable);
This action is located in fluentformpro/src/Payments/Classes/PaymentAction.php
# fluentform/form_payment_success
Description
This action runs after PayPal subscription complete
Parameters
$submission(object) Submission Object$transaction(array) Transaction Data$formId(int) Form ID$ipnVerified(boolean) Ipn Verification
Usage:
add_action('fluentform/form_payment_success', function($submission, $transaction, $formId, $ipnVerified) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/form_payment_success', $submission, $transaction, $formId, false);
This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php
# fluentform/before_entry_payment_deleted
Description
This action runs before payment entries delete
Parameters
$entries(array) Deleted entries id$transactions(array) Transaction entries to delete
Usage:
add_action('fluentform/before_entry_payment_deleted', function($entries, $transactions) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/before_entry_payment_deleted', $entries, $transactionData);
This action is located in fluentformpro/src/Payments/Classes/PaymentEntries.php
# fluentform/after_entry_payment_deleted
Description
This action runs after payment entries deleted
Parameters
$entries(array) Deleted entries id$transactions(array) Transaction entries to delete
Usage:
add_action('fluentform/after_entry_payment_deleted', function($entries, $transactions) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/after_entry_payment_deleted', $entries, $transactionData);
This action is located in fluentformpro/src/Payments/Classes/PaymentEntries.php
# fluentform/form_submission_activity_start
Description
This action runs when PayPal INP process subscription payment or Stripe handle cancelled subscription.
Parameters
$formId(ing) Form Id
Usage:
add_action('fluentform/form_submission_activity_start', function($formId) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/form_submission_activity_start', $submission->form_id);
This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php -> processSubscriptionPayment()
This action is located in fluentformpro/src/Payments/PaymentMethods/Stripe/API/StripeListener.php -> handleSubscriptionCancelled()
# fluentform/payment_subscription_status_to_cancelled
Description
This action runs when subscription payment status change to cancelled
Parameters
$subscription(object) Subscription data$submission(object) Submission data$oldStatus(string) Subscription old status
Usage:
add_action('fluentform/payment_subscription_status_to_cancelled', function($subscription, $submission, $oldStatus) {
// Do your stuff here
}, 10, 3);
2
3
Reference
do_action('fluentform/payment_subscription_status_to_cancelled', $subscription, $submission, $oldStatus);
This action is located in fluentformpro/src/Payments/Classes/PaymentManagement.php
# fluentform/payment_subscription_status_{$payment_method}_to_{$newStatus}
Description
This action runs when subscription payment status change to cancelled
Parameters
$subscription(object) Subscription data$submission(object) Submission data$oldStatus(string) Subscription old status
Usage:
add_action('fluentform/payment_subscription_status_{$payment_method}_to_{$newStatus}', function($subscription, $submission, $oldStatus) {
// Do your stuff here
}, 10, 3);
2
3
Note: {$payment_method} and {$newSatus} is dynamic value. Replace {$payment_method} with fluentform valid payment method and {$newSatus} with valid subscription payment status for responsible payment method.
Reference
do_action('fluentform/payment_subscription_status_' . $submission->payment_method . '_to_' . $newStatus, $subscription, $submission, $oldStatus);
This action is located in fluentformpro/src/Payments/Classes/PaymentManagement.php
# fluentform/payment_receipt_before_content
Description
This action runs before rendering payment receipt
Parameters
$submission(object) Submission data
Usage:
add_action('fluentform/payment_receipt_before_content', function($submission) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/payment_receipt_before_content', $this->entry);
This action is located in fluentformpro/src/Payments/Classes/PaymentReceipt.php
# fluentform/payment_receipt_after_content
Description
This action runs after rendered payment receipt
Parameters
$submission(object) Submission data
Usage:
add_action('fluentform/payment_receipt_after_content', function($submission) {
// Do your stuff here
}, 10, 1);
2
3
Reference
do_action('fluentform/payment_receipt_after_content', $this->entry);
This action is located in fluentformpro/src/Payments/Classes/PaymentReceipt.php
# fluentform/payment_view_{$route}
Description
This action runs before rendering the payment handler view.
Parameters
$data- (array) Payment Data
Usage:
add_action('fluentform/payment_view_{$route}', function($data) {
// Do your stuff here
}, 10, 1);
2
3
Note: {$route} is dynamic value. Replace {$route} with valid payment view route.
Reference
do_action('fluentform/payment_view_' . $route, $data);
This action is located in fluentformpro/src/Payments/PaymentHandler.php
# fluentform/ipn_endpoint_{$paymentMethod}
Description
This action runs when payment handler api notify.
Usage:
add_action('fluentform/ipn_endpoint_{$paymentMethod}', function() {
// Do your stuff here
}, 10, 0);
2
3
Note: {$paymentMethod} is dynamic value. Replace {$paymentMethod} with valid payment method.
Reference
do_action('fluentform/ipn_endpoint_' . $paymentMethod);
This action is located in fluentformpro/src/Payments/PaymentHandler.php
# fluentform/subscription_payment_received
Description
This action runs when PayPal new subscription received.
Parameters
$submission- (object) Submission data$updatedSubscription- (array) Subscription updated data$formId- (int) Form Id$subscription- (object) Subscription data
Usage:
add_action('fluentform/subscription_payment_received', function($subscription, $submission, $vendorData) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/subscription_payment_received', $subscription, $submission, $vendorData);
This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php
# fluentform/subscription_payment_received_paypal
Description
This action runs when PayPal new subscription received.
Parameters
$submission- (object) Submission data$updatedSubscription- (array) Subscription updated data$formId- (int) Form Id$subscription- (object) Subscription data
Usage:
add_action('fluentform/subscription_payment_received_paypal', function($subscription, $submission, $vendorData) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/subscription_payment_received_paypal', $subscription, $submission, $vendorData);
This action is located in fluentformpro/src/Payments/PaymentMethods/PayPal/API/IPN.php
# fluentform/subscription_payment_canceled
Description
This action runs when recorded subscription cancelled.
Parameters
$subscription- (object) Subscription data$submission- (object) Submission data$vendorData- (array) Subscription vendor data
Usage:
add_action('fluentform/subscription_payment_canceled', function($subscription, $submission, $vendorData) {
// Do your stuff here
}, 10, 3);
2
3
Reference
do_action('fluentform/subscription_payment_canceled', $subscription, $submission, $vendorData);
This action is located in fluentformpro/src/Payments/PaymentHelper.php
# fluentform/subscription_payment_canceled_{$payment_method}
Description
This action runs when recorded subscription cancelled.
Parameters
$subscription- (object) Subscription data$submission- (object) Submission data$vendorData- (array) Subscription vendor data
Usage:
add_action('fluentform/subscription_payment_canceled_{$payment_method}', function($subscription, $submission, $vendorData) {
// Do your stuff here
}, 10, 3);
2
3
Note: {$payment_method} is dynamic value. Replace {$payment_method} with valid fluentform payment method name.
Reference
do_action('fluentform/subscription_payment_canceled_' . $submission->payment_method, $subscription, $submission, $vendorData);
This action is located in fluentformpro/src/Payments/PaymentHelper.php
# Integration Specific
# fluentform/maybe_scheduled_jobs
Description
This is a smart background action to process jobs like integration data pushing by schedule time.
Usage:
add_action('fluentform/maybe_scheduled_jobs' ,function () {
// Do your stuff here
}, 10, 0);
2
3
Reference
do_action('fluentform/maybe_scheduled_jobs');
This action is located in fluentform/boot/globals.php
# fluentform/global_notify_completed
Description
This action fires after completing form integration data pushing process.
Parameters
$insertId(int) Submission ID$form(object) Form Object
Usage:
add_action('fluentform/global_notify_completed' ,function ($insertId, $form) {
// Do your stuff here
}, 10, 2);
2
3
Reference
do_action('fluentform/global_notify_completed', $insertId, $form);
This action is located in fluentform/app/Services/Integrations/GlobalNotificationManager.php, fluentform/app/Services/WPAsync/FluentFormAsyncRequest.php
# fluentform/after_submission_api_response_{$status}
Description
This action fires when creating log base on integration API response.
Parameters
$form(object) Form Object$entryId(int) Submission Id$data(array) Integration Date$feed(array) Integration feed value$response(array) Api call response$message(string) Response message
Usage:
add_action('fluentform/after_submission_api_response_{$status}', function ($form, $entryId, $data, $feed, $response, $message) {
// Do your stuff here
}, 10, 6);
2
3
Note: {$status} is dynamic status. Replace {$status} with one of bellow statuses.
successWhen response successfailedWhen response failedcompletedWhen response complete
Reference
do_action('fluentform/after_submission_api_response_{$status}', $form, $entryId, $data, $feed, $response, $message);
This action is located in fluentform/app/Helpers/IntegrationManagerHelper.php
# fluentform/save_global_integration_settings_{$settingsKey}
Description
This action runs when saving a global integration settings with the settings key appended.
Parameters
$integration(array) Integration Settings
Usage:
add_action('fluentform/save_global_integration_settings_{$settingsKey}', function ($integration) {
// Do your stuff here
}, 10, 1);
2
3
Note: {$settingsKey} is dynamic integration key. Replace {$settingsKey} with specific integration key.
Reference
do_action('fluentform/save_global_integration_settings_' . $settingsKey, $integration);
This action is located in fluentform/app/Http/Controllers/GlobalIntegrationController.php
# fluentform/integration_action_result
Description
This action runs after completing an integration process.
Parameters
$feed(array) Current Feed$status(string) Status$note(string) Note
Usage:
add_action('fluentform/integration_action_result', function ($feed, $status, $note) {
// Do your stuff here
}, 10, 3);
2
3
Reference
do_action('fluentform/integration_action_result', $feed, $status, $message);
This action is located in fluentformpro/src/Integrations/**/Bootstrap.php
# fluentform/user_registration_before_start
Description
This action runs before register user. Do your stuff before user is registering by fluentform.
Parameters
$feed(array) User Feed$submission(object) Submission$form(object) Form
Usage:
add_action('fluentform/user_registration_before_start', function ($feed, $submission, $form) {
// Do your stuff here
}, 10, 3);
2
3
Reference
do_action('fluentform/user_registration_before_start', $feed, $entry, $form);
This action is located in fluentformpro/src/Integrations/UserRegistration/UserRegistrationApi.php -> registerUser()
# fluentform/created_user
Description
This action runs after user created. Do your stuff after user is created by fluentform.
Parameters
$userId(int) User ID$feed(array) User Feed$submission(object) Submission$form(object) Form
Usage:
add_action('fluentform/created_user', function ($userId, $feed, $submission, $form) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/created_user', $userId, $feed, $entry, $form);
This action is located in fluentformpro/src/Integrations/UserRegistration/UserRegistrationApi.php -> createUser()
# fluentform/user_registration_completed
Description
This action runs after user registration completed. Do your stuff after user is registered by fluentform.
Parameters
$userId(int) User ID$feed(array) User Feed$submission(object) Submission$form(object) Form
Usage:
add_action('fluentform/user_registration_completed', function ($userId, $feed, $submission, $form) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/user_registration_completed', $userId, $feed, $entry, $form);
This action is located in fluentformpro/src/Integrations/UserRegistration/UserRegistrationApi.php -> createUser()
# fluentform/user_update_completed
Description
This action runs after user update completed. Do your stuff after user is updated by fluentform.
Parameters
$userId(int) User ID$feed(array) User Feed$submission(object) Submission$form(object) Form
Usage:
add_action('fluentform/user_update_completed', function ($userId, $feed, $submission, $form) {
// Do your stuff here
}, 10, 4);
2
3
Reference
do_action('fluentform/user_update_completed', $userId, $feed, $entry, $form);
This action is located in fluentformpro/src/Integrations/UserRegistration/UserUpdateFormHandler.php -> handleUpdateUser()
# Addon Specific
# fluentform/addons_page_render_{$current_menu_item}
Description
This action runs before rendering any addon page , for example PDF addon.
Usage
add_action('fluentform/addons_page_render_{$current_menu_item}', function() {
// Do your stuff here
}, 10, 0);
2
3
Note: $current_menu_item is dynamic addon item. Replace $current_menu_item with your addon menu item key.
Reference
do_action('fluentform/addons_page_render_' . $current_menu_item);
This hook is located in fluentform/app/Views/admin/addons/index.php.
# fluentform/addons_page_render_fluentform_pdf_settings
Description
This action runs when register PDF addon page after installed FluentForm PDF.
Usage:
add_action('fluentform/addons_page_render_fluentform_pdf_settings', function() {
// Do whatever you want when rendering pdf addon page
}, 10, 0);
2
3
Reference
do_action('fluentform/addons_page_render_fluentform_pdf_settings');
This action is located in fluentform/app/Views/admin/addons/pdf_promo.php
# Conversational Specific
# fluentform/conversational_frame_head
Description
This action runs after rendering the conversational frame header.
Usage
add_action('fluentform/conversational_frame_head', function() {
// Do your stuff
}, 10, 0);
2
3
Reference
do_action('fluentform/conversational_frame_head');
This action is located in fluentform/app/Views/public/conversational-form.php
# fluentform/conversational_frame_footer
Description
This action runs after rendering the conversational frame footer.
Usage
add_action('fluentform/conversational_frame_footer', function() {
// Do your stuff
}, 10, 0);
2
3
Reference
do_action('fluentform/conversational_frame_footer');
This action is located in fluentform/app/Views/public/conversational-form.php