feat: add support for wp-graphql-content-blocks (#430)

Author: justlevine

CHANGELOG.md

@@ -11,6 +11,7 @@
 - fix: Check for Submission Confirmation url before attempting to get the associated post ID.
 - fix: Flush static Gravity Forms state between multiple calls to `GFUtils::submit_form()`. 
 - feat: Add `FieldError.connectedFormField` connection to `FieldError` type.
+- feat: Add support for WPGraphQL Content Blocks.
 - dev: Remove `vendor` directory from the GitHub repository.
 - dev: Use `FormFieldsDataLoader` to resolve fields instead of instantiating a new `Model`.
 - chore!: Remove deprecated fields from the schema: `FormsConnectionOrderbyInput.field`, `GfFieldWithDisableQuantitySetting.isQuantityDisabled`. `GfSubmittedEntry.entryId`. `GfForm.button`, `gfForm.entryId`, `gfForm.lastPageButton`.

bin/_lib.sh

@@ -145,6 +145,12 @@ install_plugins() {
 	fi
 	wp plugin activate wp-graphql-upload
 
+	# Install WPGraphQL Content Blocks and Activate
+	if ! $( wp plugin is-installed wp-graphql-content-blocks ); then
+		wp plugin install https://github.com/wpengine/wp-graphql-content-blocks/releases/latest/download/wp-graphql-content-blocks.zip
+	fi
+	wp plugin activate wp-graphql-content-blocks
+
 	# Install WPGatsby and Activate
 	if ! $( wp plugin is-installed wp-gatsby ); then
 		wp plugin install wp-gatsby

codeception.dist.yml

@@ -79,13 +79,16 @@ modules:
                 - gravityformsquiz/quiz.php
                 - gravityformssignature/signature.php
                 - wp-graphql/wp-graphql.php
-                - wp-graphql-gravity-forms/wp-graphql-gravity-forms.php
                 - wp-graphql-upload/wp-graphql-upload.php
+                - wp-graphql-content-blocks/wp-graphql-content-blocks.php
+                - wp-graphql-gravity-forms/wp-graphql-gravity-forms.php
             activatePlugins:
                 - gravityforms/gravityforms.php
                 - gravityformschainedselects/chainedselects.php
                 - gravityformsquiz/quiz.php
                 - gravityformssignature/signature.php
                 - wp-graphql/wp-graphql.php
                 - wp-graphql-upload/wp-graphql-upload.php
+                - wp-graphql-content-blocks/wp-graphql-content-blocks.php
+                - wp-graphql-gravity-forms/wp-graphql-gravity-forms.php
             configFile: 'tests/_data/config.php'

docs/querying-forms.md

@@ -83,3 +83,43 @@ The code comments in the example query below shows how you can fetch and filter
   }
 }
 ```
+## Get an embedded Form from the Gravity Forms Block.
+
+Gravity Forms can be embedded in a post or page using the [Gravity Forms block](https://docs.gravityforms.com/adding-a-form-using-block/).
+
+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.
+
+> [!IMPORTANT]
+> To query the `GfForm` object from the block content, you must have the `WPGraphQL Content Blocks` plugin version v4.0+ installed and activated.
+
+### Example Query
+
+```graphql
+{
+  post(id: $post_id, idType: DATABASE_ID) {
+    databaseId
+    editorBlocks { # Added by WPGraphQL Content Blocks
+      name
+      ... on GravityformsForm {
+        attributes {
+          form { # The GfForm object.
+            databaseId
+            formFields {
+              nodes {
+                databaseId
+                type
+                ... on TextField {
+                  label
+                  description
+                }
+              }
+            }
+            title
+            # other GraphQL fields. 
+          }
+        }
+      }
+    }
+  }
+}
+```

docs/recipes/register-form-to-custom-field.md

@@ -34,7 +34,7 @@ function my_add_form_to_post() {
         $form_id = get_post_meta( $source->ID, 'my_custom_meta_field_form_id', true );
 
         // Return the form.
-        return $context->get_loader( \WPGraphQL\GF\Data\Loader\FormsLoader::$name )->load_deferred( (int) $form_id );
+        return \WPGraphQL\GF\Data\Factory::resolve_form( $form_id, $context );
       }
     ]
   );

src/Extensions/Extensions.php

@@ -14,6 +14,7 @@
 use WPGraphQL\GF\Extensions\GFQuiz\GFQuiz;
 use WPGraphQL\GF\Extensions\GFSignature\GFSignature;
 use WPGraphQL\GF\Extensions\WPGatsby\WPGatsby;
+use WPGraphQL\GF\Extensions\WPGraphQLContentBlocks\WPGraphQLContentBlocks;
 use WPGraphQL\GF\Extensions\WPJamstackDeployments\WPJamstackDeployments;
 use WPGraphQL\GF\Interfaces\Hookable;
 
@@ -29,6 +30,7 @@ public static function register_hooks(): void {
 		GFQuiz::register_hooks();
 		GFSignature::register_hooks();
 		WPGatsby::register_hooks();
+		WPGraphQLContentBlocks::register_hooks();
 		WPJamstackDeployments::register_hooks();
 	}
 }

src/Extensions/WPGraphQLContentBlocks/WPGraphQLContentBlocks.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ * Enables and initializes the Gravity Forms Action Monitor
+ *
+ * @package WPGraphQL\GF\Extensions\WPGraphQLContentBlocks
+ * @since 0.10.0
+ */
+
+declare( strict_types = 1 );
+
+namespace WPGraphQL\GF\Extensions\WPGraphQLContentBlocks;
+
+use WPGraphQL\AppContext;
+use WPGraphQL\GF\Data\Factory;
+use WPGraphQL\GF\Interfaces\Hookable;
+use WPGraphQL\GF\Interfaces\Registrable;
+use WPGraphQL\GF\Type\WPObject\Form\Form;
+
+/**
+ * Class - WPGraphQLContentBlocks
+ */
+class WPGraphQLContentBlocks implements Hookable, Registrable {
+	/**
+	 * {@inheritDoc}
+	 */
+	public static function register_hooks(): void {
+		if ( ! self::is_plugin_enabled() ) {
+			return;
+		}
+
+		// Register action monitors.
+		add_action( 'graphql_register_types', [ self::class, 'register' ] );
+	}
+
+	/**
+	 * Returns whether WPGraphQLContentBlocks is enabled.
+	 */
+	public static function is_plugin_enabled(): bool {
+		return class_exists( 'WPGraphQLContentBlocks' ) && defined( 'WPGRAPHQL_CONTENT_BLOCKS_VERSION' ) && version_compare( WPGRAPHQL_CONTENT_BLOCKS_VERSION, '4.0.0', '>=' );
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public static function register(): void {
+		register_graphql_field(
+			'GravityformsFormAttributes', // Generated by wp-graphql-content-blocks.
+			'form',
+			[
+				'type'        => Form::$type,
+				'description' => __( 'The form object associated with the block.', 'wp-graphql-gravity-forms' ),
+				'resolve'     => static function ( $source, array $args, AppContext $context ) {
+					if ( empty( $source['attrs']['formId'] ) ) {
+						return null;
+					}
+
+					return Factory::resolve_form( (int) $source['attrs']['formId'], $context );
+				},
+			]
+		);
+	}
+}

tests/wpunit/ContentBlocksTest.php

@@ -0,0 +1,95 @@
+<?php
+/**
+ * Tests a Form block.
+ *
+ * @package WPGraphQL\GF\Tests
+ */
+
+use Tests\WPGraphQL\GF\TestCase\GFGraphQLTestCase;
+
+/** 
+ * Class - ContentBlocksTest
+ */
+class ContentBlocksTest extends GFGraphQLTestCase {
+	private $form_id;
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function setUp(): void {
+		parent::setUp();
+
+		$fields = [
+			$this->factory->field->create(
+				$this->tester->getPropertyHelper( 'TextField')->values
+			)
+		];
+
+		$this->form_id = $this->factory->form->create(
+			array_merge(
+				$this->tester->getFormDefaultArgs(),
+				[
+					'fields' => $fields
+				]
+			)
+		);
+
+		$this->clearSchema();
+	}
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public function tearDown(): void {
+		$this->factory->form->delete( $this->form_id );
+
+		parent::tearDown();
+	}
+
+	/**
+	 * Test the form field on the GravityformsFormAttributes block.
+	 */
+	public function testFormBlock(): void {
+		$post_id = $this->factory->post->create(
+			[
+				'post_content' => sprintf(
+					'<!-- wp:gravityforms/form {"formId":%d} /-->',
+					$this->form_id
+				)
+			]
+		);
+
+		$query = $this->get_query();
+		$variables = [
+			'post_id' => $post_id
+		];
+
+		$actual = $this->graphql( compact( 'query', 'variables' ) );
+
+		$this->assertArrayHasKey( 'data', $actual );
+
+		$this->assertEquals( $post_id, $actual['data']['post']['databaseId'] );
+		$this->assertEquals( 'gravityforms/form', $actual['data']['post']['editorBlocks'][0]['name'] );
+		$this->assertEquals( $this->form_id, $actual['data']['post']['editorBlocks'][0]['attributes']['form']['databaseId'] );
+	}
+
+	private function get_query(): string {
+		return '
+			query GetFormBlock($post_id: ID!) {
+				post(id: $post_id, idType: DATABASE_ID) {
+					databaseId
+					editorBlocks {
+						name
+						... on GravityformsForm {
+							attributes {
+								form {
+									databaseId
+								}
+							}
+						}
+					}
+				}
+			}
+		';
+	}
+}