gpfup_block_submission_on_error

  1. Description
  2. Usage
  3. Parameters
  4. Since
  5. Examples
    1. Block Submission on Any Failed Upload
    2. Block Submission for a Specific Field

Description

Filter whether files that failed to upload should block form submission or forward page navigation.

Usage

window.gform.addFilter( 'gpfup_block_submission_on_error', function ( blockSubmission, formId, fieldId, gpfupInstance ) {
	return blockSubmission;
} );

Parameters

  • blockSubmission boolean

    Whether to block submission. Defaults to false.

  • formId number

    The current form ID.

  • fieldId number

    The current File Upload field ID.

  • gpfupInstance object

    The current GP File Upload Pro uploader instance for the field.

Since

This filter is available since version 1.5.16.

Examples

Block Submission on Any Failed Upload

Prevent the form from being submitted while any file is in an errored state.

window.gform.addFilter('gpfup_block_submission_on_error', function() {
	return true;
});

Block Submission for a Specific Field

Only block submission for field 4 on form 123.

window.gform.addFilter('gpfup_block_submission_on_error', function(blockSubmission, formId, fieldId) {
	if (formId === 123 && fieldId === 4) {
		return true;
	}

	return blockSubmission;
});