Merge pull request #156 from wp-graphql/fix/acf-fields-not-resolving-with-preview

fix: acf fields not resolving with preview

Author: jasonbahl

src/Registry.php

@@ -28,6 +28,7 @@ class Registry {
 	 */
 	protected $type_registry;
 
+
 	/**
 	 * @param \WPGraphQL\Registry\TypeRegistry|null $type_registry
 	 *
@@ -46,6 +47,13 @@ public function __construct( TypeRegistry $type_registry = null ) {
 		do_action( 'wpgraphql/acf/type_registry/init', $this );
 	}
 
+	/**
+	 * @return array<mixed>
+	 */
+	public function get_registered_fields() {
+		return $this->registered_fields;
+	}
+
 	/**
 	 * Get the TypeRegistry instance
 	 */
@@ -467,7 +475,18 @@ public function get_fields_for_field_group( array $acf_field_group ): array {
 	 * @throws \Exception
 	 */
 	public function map_acf_field_to_graphql( array $acf_field, array $acf_field_group ): ?array {
-		return ( new FieldConfig( $acf_field, $acf_field_group, $this ) )->get_graphql_field_config();
+		$field_config = ( new FieldConfig( $acf_field, $acf_field_group, $this ) )->get_graphql_field_config();
+
+		if ( ! empty( $field_config['acf_field'] ) ) {
+			if ( isset( $field_config['acf_field']['key'] ) && ! in_array( $field_config['acf_field']['key'], $this->registered_fields, true ) ) {
+				$this->registered_fields[] = $field_config['acf_field']['key'];
+			}
+			if ( isset( $field_config['acf_field']['name'] ) && ! in_array( $field_config['acf_field']['name'], $this->registered_fields, true ) ) {
+				$this->registered_fields[] = $field_config['acf_field']['name'];
+			}
+		}
+
+		return $field_config;
 	}
 
 

src/Utils.php

@@ -274,7 +274,7 @@ public static function should_field_group_show_in_graphql( array $acf_field_grou
 		if (
 			( isset( $acf_field_group['is_options_page'] ) && false === $acf_field_group['is_options_page'] ) &&
 			! isset( $acf_field_group['show_in_graphql'] ) ) {
-			$acf_field_group['show_in_graphql'] = $show_in_rest ?? false;
+			$acf_field_group['show_in_graphql'] = $show_in_rest;
 		}
 
 		if ( isset( $acf_field_group['show_in_graphql'] ) && false === $acf_field_group['show_in_graphql'] ) {

src/WPGraphQLAcf.php

@@ -21,6 +21,12 @@ class WPGraphQLAcf {
 	protected $plugin_load_error_messages = [];
 
 	/**
+	 * @var \WPGraphQL\Acf\Registry|null
+	 */
+	protected $registry;
+
+	/**
+	 * @return void
 	 * Initialize the plugin
 	 */
 	public function init(): void {
@@ -38,6 +44,8 @@ public function init(): void {
 		add_action( 'after_setup_theme', [ $this, 'acf_internal_post_type_support' ] );
 		add_action( 'graphql_register_types', [ $this, 'init_registry' ] );
 
+		add_filter( 'graphql_resolve_revision_meta_from_parent', [ $this, 'preview_support' ], 10, 4 );
+
 		add_filter( 'graphql_data_loaders', [ $this, 'register_loaders' ], 10, 2 );
 		add_filter( 'graphql_resolve_node_type', [ $this, 'resolve_acf_options_page_node' ], 10, 2 );
 		/**
@@ -89,19 +97,99 @@ public function init_registry( TypeRegistry $type_registry ): void {
 
 		// Register general types that should be available to the Schema regardless
 		// of the specific fields and field groups registered by ACF
-		$registry = new Registry( $type_registry );
-		$registry->register_initial_graphql_types();
-		$registry->register_options_pages();
+		$this->registry = new Registry( $type_registry );
+		$this->registry->register_initial_graphql_types();
+		$this->registry->register_options_pages();
 
 		// Get the field groups that should be mapped to the Schema
-		$acf_field_groups = $registry->get_acf_field_groups();
+		$acf_field_groups = $this->registry->get_acf_field_groups();
 
 		// If there are no acf field groups to show in GraphQL, do nothing
 		if ( empty( $acf_field_groups ) ) {
 			return;
 		}
 
-		$registry->register_acf_field_groups_to_graphql( $acf_field_groups );
+		$this->registry->register_acf_field_groups_to_graphql( $acf_field_groups );
+	}
+
+	/**
+	 * @param int $post_id The ID of the post to check if it's a preview of another post
+	 *
+	 * @return bool|\WP_Post
+	 */
+	protected function is_preview_post( int $post_id ) {
+		$post = get_post( $post_id );
+
+		if ( ! $post ) {
+			return false; // Post does not exist
+		}
+
+		// Check if it's a revision (autosave)
+		if ( 'revision' === $post->post_type && 'inherit' === $post->post_status ) {
+			$parent_post = get_post( $post->post_parent );
+
+			// Check if parent post is either a draft or published
+			if ( $parent_post && in_array( $parent_post->post_status, [ 'draft', 'publish' ], true ) ) {
+				return $parent_post; // It's a preview of a draft or published post
+			}
+		}
+
+		return false; // Not a preview post
+	}
+
+
+	/**
+	 * Add support for resolving ACF Fields when queried for asPreview
+	 *
+	 * NOTE: this currently only works if classic editor is not being used
+	 *
+	 * @param bool   $should Whether to resolve using the parent object. Default true.
+	 * @param int    $object_id The ID of the object to resolve meta for
+	 * @param string $meta_key The key for the meta to resolve
+	 * @param bool   $single Whether a single value should be returned
+	 */
+	public function preview_support( bool $should, int $object_id, string $meta_key, bool $single ): bool {
+		if ( ! $this->registry instanceof Registry ) {
+			return (bool) $should;
+		}
+
+		$preview_post = $this->is_preview_post( $object_id );
+		if ( ! $preview_post instanceof WP_Post ) {
+			return (bool) $should;
+		}
+
+		// If the block editor is being used for the post, bail early as the Block Editor doesn't
+		// properly support revisions of post meta
+		// see: https://github.com/WordPress/gutenberg/issues/16006#issuecomment-657965028
+		if ( use_block_editor_for_post( $preview_post ) ) {
+			graphql_debug( __( 'The post you are querying as a preview uses the Block Editor and saving & previewing meta is not fully supported by the block editor. This is a WordPress block editor bug. See: https://github.com/WordPress/gutenberg/issues/16006#issuecomment-657965028', 'wpgraphql-acf' ) );
+			return (bool) $should;
+		}
+
+		$registered_fields = $this->registry->get_registered_fields();
+
+		if ( in_array( $meta_key, $registered_fields, true ) ) {
+			return false;
+		}
+
+		foreach ( $registered_fields as $field_name ) {
+			// For flex fields/repeaters, the meta keys are structured a bit funky.
+			// This checks to see if the $meta_key starts with the same string as one of the
+			// acf fields (a flex/repeater field) and then checks if it's preceeded by an underscore and a number.
+			if ( strpos( $meta_key, $field_name ) === 0 ) {
+				// match any string that starts with the field name, followed by an underscore, followed by a number, followed by another string
+				// ex my_flex_field_0_text_field or some_repeater_field_12_25MostPopularDogToys
+				$pattern = '/' . $field_name . '_\d+_\w+/m';
+				preg_match( $pattern, $meta_key, $matches );
+
+				// If the meta key matches the pattern, treat it as a sub-field of an ACF Field Group
+				if ( null !== $matches ) {
+					return false;
+				}
+			}
+		}
+
+		return $should;
 	}
 
 	/**

tests/wpunit/FieldTypes/TaxonomyFieldTest.php

@@ -104,7 +104,7 @@ public function testQueryTaxononomyFieldOnBlock() {
 		if ( ! defined( 'WPGRAPHQL_CONTENT_BLOCKS_DIR' ) ) {
 			$this->markTestSkipped( 'This test is skipped when WPGraphQL Content Blocks is not active' );
 		}
-		
+
 		acf_register_block_type([
 			'name' => 'block_with_category_field',
 			'title' => 'Block with Category Field',
@@ -282,10 +282,11 @@ interfaces {
 					'__typename' => 'Category',
 					'databaseId' => $category_id,
 				], 0 ),
-				$this->expectedNode( 'blockTaxonomyTest.category.nodes', [
-					'__typename' => 'Category',
-					'databaseId' => $category_2_id,
-				], 0 ),
+//              Only the first node will be returned because the taxonomy field is set to "multiple: 0" so ACF will only return a single value
+//				$this->expectedNode( 'blockTaxonomyTest.category.nodes', [
+//					'__typename' => 'Category',
+//					'databaseId' => $category_2_id,
+//				], 1 ),
 			], 0 ),
 		]);