koduvaal / wp-graphql-gravity-forms

GraphQL API for interacting with Gravity Forms.

WPGraphQL for Gravity Forms

A WordPress plugin that provides a GraphQL API for interacting with Gravity Forms.

• Join the WPGraphQL community on Slack.
• Documentation

Overview

Using WordPress as a headless CMS with a separate JavaScript-powered frontend single-page app is an increasingly popular tech stack. Traditionally, REST APIs have been used for the purpose of sending data back & forth between the frontend and backend in setups like this but the REST architecture has its limitations.

Using GraphQL means that if your frontend app needs to fetch data for a number of different resources, all of that data can be fetched from the server with a single request. Your frontend app can even define which fields it requires for each of the resources, giving it full control over which pieces of data are fetched and included in the response.

Fortunately, a GraphQL implementation exists for WordPress - WPGraphQL.

WPGraphQL for Gravity Forms extends the WPGraphQL plugin, allowing frontend apps to interact with the Gravity Forms data stored in a headless WordPress backend. This plugin couples the great forms functionality of Gravity Forms with the powerful WordPress-specific GraphQL implementation that WPGraphQL provides.

Our hope for this open source project is that it will enable more teams to leverage GraphQL for building fast, interactive frontend apps that source their data from WordPress and Gravity Forms.

System Requirements

• PHP 7.4+ || 8.0
• WordPress 5.4.1+
• WPGraphQL 1.6.4+
• Gravity Forms 2.5+
• ( 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 zip of this repository and upload it to your WordPress install, and activate the plugin.

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 Experimental form fields Github Issue
• Ability to query for lists of draft entries.
• Ability to get the total count for a list of 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
• 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