DescriptionUsageParametersExamplesSource Code
Description
Add new or modify existing confirmation settings that display on the Confirmation Edit screen.
This filter is deprecated in Gravity Forms 2.5 and greater. Use the gform_confirmation_settings_fields filter instead.
Usage
Apply to all forms:
add_filter( 'gform_confirmation_ui_settings', 'my_custom_function', 10, 3 );
Apply to a specific form ID:
add_filter( 'gform_confirmation_ui_settings_5', 'my_custom_function', 10, 3 );
Parameters
$ui_settings array
An array of settings for the confirmation UI. Each setting contains the HTML which will be displayed for that setting.
$confirmation Confirmation Object
The current confirmation object being edited.
$form Form Object
The current form object to which the confirmation being edited belongs.
Examples
This example demonstrates how you can add custom confirmation UI setting. Use with the gform_confirmation_before_save hook to save your custom settings.
add_filter( 'gform_confirmation_ui_settings', 'my_custom_confirmation_setting', 10, 3 );
function my_custom_confirmation_setting( $ui_settings, $confirmation, $form ) {
$ui_settings['my_custom_setting'] = '
';
return $ui_settings;
}
Source Code
This filter is located in GFFormSettings::get_confirmation_ui_settings() in form_settings.php.