The image_hopper_filepond_config filter lets you manipulate the FilePond instance configuration. FilePond is the JavaScript library that powers Image Hopper’s upload functionality, so customizing its configuration gives you fine-grained control over the user experience.
Filter Signature
image_hopper_filepond_config(config, FilePond, $form, currentPage, formId, fieldId, entryId, files, fileInput)Parameters
- config (object) — The FilePond configuration object. Accepts all properties listed in the FilePond instance documentation.
- FilePond (object) — The FilePond public API object.
- $form (object) — A jQuery object matching the encompassing Gravity Forms
<form>element. - currentPage (integer) — The current page number of the Gravity Forms form.
- formId (integer) — The Gravity Forms form ID.
- fieldId (integer) — The Image Hopper field ID.
- entryId (integer) — The Gravity Forms entry ID (if one exists).
- files (array) — A list of files already uploaded at initialization.
- fileInput (object) — The
<input type="file">object being enhanced by Image Hopper.
Examples
- Limit image file types — restrict uploads to JPG, PNG, and GIF.
- Disable instant upload — require users to manually trigger upload instead of on drop.
- Disable image reordering — prevent drag-to-reorder functionality.
- Add a text watermark (without Editor) — overlay text on uploaded images automatically.
- Add an image watermark (without Editor) — overlay an image file on uploaded images automatically.
- Pre-populate an image on form load — seed the field with an existing image on page load.
- Listen for FilePond events — tap into FilePond lifecycle events to trigger custom logic.
Usage
You can create a separate JavaScript file and enqueue it when your form is displayed, or add an HTML field to your form and wrap the filter in <script type="text/javascript"></script> tags. The HTML field approach is simpler:
Additional Info
You can customize any property documented in the FilePond API reference, but we recommend avoiding these properties to prevent breaking core functionality or relying on unsupported features:
namestatuselementservercaptureMethodallowReorder