You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,15 +14,11 @@ A WordPress plugin that adds <a href="https://wpgraphql.com" target="_blank">WPG
14
14
15
15
## Overview
16
16
17
-
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.
17
+
The WPGraphQL for Gravity Forms plugin is a powerful extension for [WPGraphQL](https://www.wpgraphql.com/) that provides a comprehensive suite of features that allows developers to interact with [Gravity Forms](https://www.gravityforms.com/) via GraphQL.
18
18
19
-
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.
19
+
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.
20
20
21
-
Fortunately, a GraphQL implementation exists for WordPress - [WPGraphQL](https://www.wpgraphql.com/).
22
-
23
-
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.
24
-
25
-
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.
21
+
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.
26
22
27
23
## System Requirements
28
24
@@ -38,10 +34,11 @@ Our hope for this open source project is that it will enable more teams to lever
38
34
2. Install & activate [Gravity Forms](https://www.gravityforms.com/) and any supported addons.
39
35
3. Download the `wp-graphql-gravity-forms.zip` file from the [latest release](https://github.com/AxeWP/wp-graphql-gravity-forms/releases/latest) upload it to your WordPress install, and activate the plugin.
40
36
41
-
> [!IMPORTANT]
42
-
> Make sure you are downloading the [`wp-graphql-gravity-forms.zip`](https://github.com/axewp/wp-graphql-gravity-forms/releases/latest/download/wp-graphql-gravity-forms.zip) file from the releases page, not the `Source code (zip)` file nor a clone of the repository.
43
-
>
44
-
> If you wish to use the source code, you will need to run `composer install` inside the plugin folder to install the required dependencies.
37
+
> [!IMPORTANT]
38
+
>
39
+
> Make sure you are downloading the [`wp-graphql-gravity-forms.zip`](https://github.com/axewp/wp-graphql-gravity-forms/releases/latest/download/wp-graphql-gravity-forms.zip) file from the releases page, not the `Source code (zip)` file nor a clone of the repository.
40
+
>
41
+
> If you wish to use the source code, you will need to run `composer install` inside the plugin folder to install the required dependencies.
Copy file name to clipboardExpand all lines: docs/querying-formfields.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -118,6 +118,7 @@ Luckily, we can use [GraphQL Interfaces](https://graphql.org/learn/schema/#inter
118
118
Entry values can be accessed similarly to other Gravity Forms Field properties, by including the corresonding GraphQL field in the fragment.
119
119
120
120
> [!IMPORTANT]
121
+
>
121
122
> Due to GraphQL limitations regarding Union types, you must use the specific value type specific to that field. A full list of field value types and their corresponding field fragments are below.
Copy file name to clipboardExpand all lines: docs/querying-forms.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,6 +90,7 @@ Gravity Forms can be embedded in a post or page using the [Gravity Forms block](
90
90
When coupled with [WPGraphQL Content Blocks](https://github.com/wpengine/wp-graphql-content-blocks), you can query the embedded form directly from the parsed block content, using the `GravityformsForm.attributes.form` field.
91
91
92
92
> [!IMPORTANT]
93
+
>
93
94
> To query the `GfForm` object from the block content, you must have the `WPGraphQL Content Blocks` plugin version v4.0+ installed and activated.
Copy file name to clipboardExpand all lines: docs/submitting-forms.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,6 +7,7 @@ This mutation can be used either to submit an Entry or to submit a draft entry,
7
7
The `fieldValues` input takes an array of objects containing the `id` of the field, and a value input that corresponds to the Gravity Forms Field type.
8
8
9
9
> [!IMPORTANT]
10
+
>
10
11
> Due to [GraphQL's current lack of support for Input Union types](https://github.com/axewp/wp-graphql-gravity-forms/issues/4#issuecomment-563305561), you must use the specific value type specific to that field. A full list of field value types and their corresponding field fragments are below.
To enable WPGraphQL support for submitting files (via the `fileUploadValues` or `postImageValues` inputs ), you must first install and activate the [WPGraphQL Upload](https://github.com/dre1080/wp-graphql-upload) extension, which will add the `Upload` scalar type to the GraphQL schema.
204
205
205
206
> [!IMPORTANT]
207
+
>
206
208
> The GraphQL Spec - and many GraphQL clients - does not natively implement support the [`graphql-multipart-request-spec`](https://github.com/jaydenseric/graphql-multipart-request-spec) and may require an additional dependency such as [apollo-upload-client](https://github.com/jaydenseric/apollo-upload-client).
0 commit comments