README

WPGraphQL for Gravity Forms

A WordPress plugin that adds WPGraphQL support for Gravity Forms.

• Join the WPGraphQL community on Discord.
• Documentation

Overview

The WPGraphQL for Gravity Forms plugin is a powerful extension for WPGraphQL that provides a comprehensive suite of features that allows developers to interact with Gravity Forms via GraphQL.

This plugin enhances the developer experience by offering a GraphQL schema tailored for Gravity Forms. The schema provides improved type safety, prevents over-fetching, and makes it easier to interact with your forms and entries than (and even provides functionality not available in) Gravity Form's traditional PHP and REST APIs.

WPGraphQL for Gravity Forms is an essential tool for those leveraging decoupled and headless WordPress architectures. Whether you're using WordPress as a data source for your headless application, integrating Gravity Forms data into an external service, or building custom, interactive form experiences, this plugin offers improved developer experience and features to make your frontend code more robust. It's designed to be a versatile tool, capable of handling any decoupled project from simple form submissions to complex, form-driven applications scalable at an enterprise level.

System Requirements

• PHP: 7.4-8.2+
• WordPress: 6.0+
• WPGraphQL: 1.26.0+
• Gravity Forms: 2.7+
• Recommended: WPGraphQL Upload - used for File Upload and Post Image submissions.

Quick Install

1. Install & activate WPGraphQL.
2. Install & activate Gravity Forms and any supported addons.
3. Download the wp-graphql-gravity-forms.zip file from the latest release upload it to your WordPress install, and activate the plugin.

Important

Make sure you are downloading the wp-graphql-gravity-forms.zip file from the releases page, not the Source code (zip) file nor a clone of the repository.

If you wish to use the source code, you will need to run composer install inside the plugin folder to install the required dependencies.

With Composer

composer require harness-software/wp-graphql-gravity-forms

Updating and Versioning

As we work towards a 1.0 Release, we will need to introduce numerous breaking changes. We will do our best to group multiple breaking changes together in a single release, to make it easier on developers to keep their projects up-to-date.

Until we hit v1.0, we're using a modified version of Semantic Versioning

v0.x: "Major" releases. These releases introduce new features, and may contain breaking changes to either the PHP API or the GraphQL schema. v0.x.y: "Minor" releases. These releases introduce new features and enhancements and address bugs. They do not contain breaking changes. v0.x.y.z: "Patch" releases. These releases are reserved for addressing issue with the previous release only.

Development and Support

Development of WPGraphQL for Gravity Forms is provided by AxePress Development. Community contributions are welcome and encouraged.

Basic support is provided for free, both in this repo and in WPGraphQL's official Discord.

Priority support and custom development are available to our Sponsors.

Supported Features

• Querying forms and entries.
• Submitting forms.
• Updating entries and draft entries.
• Deleting entries and draft entries.
• Triggering builds with WPGatsby and Jamstack Deployments

Future Feature Enhancements

View all Feature Requests

• Add support for remaining form fields
• Ability to query for lists of draft entries.
• Ability to create, update, and delete an individual Gravity Form.

Documentation

• Supported Gravity Forms form fields
• Using Global IDs vs Database IDs
• Querying forms
• Querying entries & draft entries
• Querying formFields and their values
• Submitting forms
• Updating entries & draft entries
• Deleting entries & draft entries
• Internationalization & Localization
• Actions & Filters

Recipes

• Register a Gravity Forms Form to a custom GraphQL field
• Register a custom GraphQL connection to Gravity Forms entries
• Register a custom Gravity Forms field to the GraphQL schema
• Add GraphQL mutation support for a custom Gravity Forms field

Sponsors