- update Registry.php to cache mapped ACF Field Groups and mapped ACF Field Group Location rules to reduce redundancy

- remove unneeded LocationRules
- update OptionsPageTest to clear the schema during setUp

Author: jasonbahl

src/LocationRules/LocationRules.php

@@ -267,12 +267,10 @@ public function determine_rules( string $field_group_name, string $param, string
 				$this->determine_post_template_rules( $field_group_name, $param, $operator, $value );
 				break;
 			case 'post_status':
-				$this->determine_post_status_rules( $field_group_name, $param, $operator, $value );
 				break;
 			case 'post_format':
 			case 'post_category':
 			case 'post_taxonomy':
-				$this->determine_post_taxonomy_rules( $field_group_name, $param, $operator, $value );
 				break;
 			case 'post':
 				$this->determine_post_rules( $field_group_name, $param, $operator, $value );
@@ -489,37 +487,6 @@ public function determine_post_template_rules( string $field_group_name, string
 		}
 	}
 
-	/**
-	 * Determines how the ACF Rules should apply to the WPGraphQL Schema
-	 *
-	 * @param string $field_group_name The name of the ACF Field Group the rule applies to
-	 * @param string $param            The parameter of the rule
-	 * @param string $operator         The operator of the rule
-	 * @param string $value            The value of the rule
-	 */
-	public function determine_post_status_rules( string $field_group_name, string $param, string $operator, string $value ): void {
-		// @todo: Should post status affect the GraphQL Schema at all?
-		// If a field group is set to show on "post_status == publish" as the only rule, what post type does that apply to? All? 🤔
-		// If a field group is set to show on "post_status != draft" does that mean the field group should be available on all post types in the Schema by default?
-		// This seems like a very difficult rule to translate to the Schema.
-		// Like, lets say I add a field group called: "Editor Notes" that I want to show for any status that is not "publish". In theory, if that's my only rule, that seems like it should apply to all post types across the board, and show in the Admin in any state of the post, other than publish. 🤔
-
-		// ACF Admin behavior seems to add it to the Admin on all post types, so WPGraphQL
-		// should respect this rule and also add it to all post types. The resolver should
-		// then determine whether to resolve the data or not, based on this rule.
-
-		// If Post Status is used to qualify a field group location,
-		// It will be added to the Schema for any Post Type that is set to show in GraphQL
-		$allowed_post_types = get_post_types( [ 'show_in_graphql' => true ] );
-		foreach ( $allowed_post_types as $post_type ) {
-			$post_type_object = get_post_type_object( $post_type );
-			$graphql_name     = $post_type_object->graphql_single_name ?? null;
-			if ( ! empty( $graphql_name ) ) {
-				$this->set_graphql_type( $field_group_name, $graphql_name );
-			}
-		}
-	}
-
 	/**
 	 * Determines how the ACF Rules should apply to the WPGraphQL Schema
 	 *
@@ -551,21 +518,6 @@ public function determine_post_format_rules( string $field_group_name, string $p
 		}
 	}
 
-	/**
-	 * Determines how the ACF Rules should apply to the WPGraphQL Schema
-	 *
-	 * @param string $field_group_name The name of the ACF Field Group the rule applies to
-	 * @param string $param            The parameter of the rule
-	 * @param string $operator         The operator of the rule
-	 * @param string $value            The value of the rule
-	 */
-	public function determine_post_taxonomy_rules( string $field_group_name, string $param, string $operator, string $value ): void {
-
-		// If Post Taxonomy is used to qualify a field group location,
-		// It will be added to the Schema for the Post post type
-		$this->set_graphql_type( $field_group_name, 'Post' );
-	}
-
 	/**
 	 * Determines how the ACF Rules should apply to the WPGraphQL Schema
 	 *
@@ -580,35 +532,20 @@ public function determine_post_rules( string $field_group_name, string $param, s
 		// It will be added to the Schema for the GraphQL Type for the post_type of the Post
 		// it is assigned to
 
-		if ( '==' === $operator ) {
-			if ( absint( $value ) ) {
-				$post = get_post( absint( $value ) );
-				if ( $post instanceof \WP_Post ) {
-					$post_type_object = get_post_type_object( $post->post_type );
-					if ( $post_type_object && true === $post_type_object->show_in_graphql && isset( $post_type_object->graphql_single_name ) ) {
-						$this->set_graphql_type( $field_group_name, $post_type_object->graphql_single_name );
-					}
+		if ( ( '==' === $operator ) && absint( $value ) ) {
+			$post = get_post( absint( $value ) );
+			if ( $post instanceof \WP_Post ) {
+				$post_type_object = get_post_type_object( $post->post_type );
+				if ( $post_type_object && true === $post_type_object->show_in_graphql && isset( $post_type_object->graphql_single_name ) ) {
+					$this->set_graphql_type( $field_group_name, $post_type_object->graphql_single_name );
 				}
 			}
 		}
 
 		// If a single post is used as not equal,
-		// the field group should be added to ALL post types in the Schema
+		// the field group should not be added to any type
 		if ( '!=' === $operator ) {
-			$allowed_post_types = get_post_types( [ 'show_in_graphql' => true ] );
-
-			if ( empty( $allowed_post_types ) ) {
-				return;
-			}
-
-			// loop over and set all post types
-			foreach ( $allowed_post_types as $allowed_post_type ) {
-				$post_type_object = get_post_type_object( $allowed_post_type );
-				$graphql_name     = $post_type_object->graphql_single_name ?? null;
-				if ( ! empty( $graphql_name ) ) {
-					$this->set_graphql_type( $field_group_name, $graphql_name );
-				}
-			}
+			return;
 		}
 	}
 
@@ -627,30 +564,6 @@ public function determine_page_type_rules( string $field_group_name, string $par
 		if ( in_array( $value, [ 'front_page', 'posts_page' ], true ) ) {
 			$this->set_graphql_type( $field_group_name, 'Page' );
 		}
-
-		// If top_level, parent, or child is set as equal_to or not_equal_to
-		// then the field group should be shown on all hierarchical post types
-		if ( in_array( $value, [ 'top_level', 'parent', 'child' ], true ) ) {
-			$hierarchical_post_types = get_post_types(
-				[
-					'show_in_graphql' => true,
-					'hierarchical'    => true,
-				]
-			);
-
-			if ( empty( $hierarchical_post_types ) ) {
-				return;
-			}
-
-			// loop over and set all post types
-			foreach ( $hierarchical_post_types as $allowed_post_type ) {
-				$post_type_object = get_post_type_object( $allowed_post_type );
-				$graphql_name     = $post_type_object->graphql_single_name ?? null;
-				if ( ! empty( $graphql_name ) ) {
-					$this->set_graphql_type( $field_group_name, $graphql_name );
-				}
-			}
-		}
 	}
 
 	/**

src/Registry.php

@@ -17,6 +17,18 @@ class Registry {
 	 */
 	protected $registered_fields = [];
 
+	/**
+	 * Stores location rules once they've been mapped
+	 *
+	 * @var array<mixed>
+	 */
+	protected $mapped_location_rules = [];
+
+	/**
+	 * @var array<mixed>
+	 */
+	protected $all_acf_field_groups = [];
+
 	/**
 	 * @todo should be protected with getter/setter?
 	 * @var array<mixed>
@@ -53,6 +65,15 @@ public function get_type_registry(): TypeRegistry {
 		return $this->type_registry;
 	}
 
+	/**
+	 * Returns the mapped location rules
+	 *
+	 * @return array<mixed>
+	 */
+	public function get_mapped_location_rules(): array {
+		return $this->mapped_location_rules;
+	}
+
 	/**
 	 * @param string $key
 	 * @param mixed  $field_group
@@ -83,6 +104,11 @@ public function should_field_group_show_in_graphql( array $acf_field_group ): bo
 	 * @return array<mixed>
 	 */
 	public function get_acf_field_groups(): array {
+
+		if ( ! empty( $this->all_acf_field_groups ) ) {
+			return $this->all_acf_field_groups;
+		}
+
 		$all_acf_field_groups = acf_get_field_groups();
 
 		$graphql_field_groups = [];
@@ -97,7 +123,8 @@ public function get_acf_field_groups(): array {
 			$graphql_field_groups[ $acf_field_group['key'] ] = $acf_field_group;
 		}
 
-		return $graphql_field_groups;
+		$this->all_acf_field_groups = $graphql_field_groups;
+		return $this->all_acf_field_groups;
 	}
 
 	/**
@@ -532,6 +559,11 @@ public function get_field_group_graphql_type_name( array $field_group ): ?string
 	 * @return array<mixed>
 	 */
 	public function get_location_rules( array $acf_field_groups = [] ): array {
+
+		if ( ! empty( $this->get_mapped_location_rules() ) ) {
+			return $this->get_mapped_location_rules();
+		}
+
 		$field_groups = $acf_field_groups;
 		$rules        = [];
 
@@ -552,7 +584,36 @@ public function get_location_rules( array $acf_field_groups = [] ): array {
 		$rules = new LocationRules();
 		$rules->determine_location_rules();
 
-		return $rules->get_rules();
+		// Set the mapped location rules for future use
+		$rules_by_group = $rules->get_rules();
+
+		$this->mapped_location_rules = $rules_by_group;
+
+		// Return them
+		return $this->mapped_location_rules;
+	}
+
+	/**
+	 * Get the location rules grouped by location instead of grouped by field group
+	 *
+	 * @return array<mixed>
+	 */
+	public function get_location_rules_grouped_by_location(): array {
+		$location_rules    = $this->get_location_rules();
+		$rules_by_location = [];
+		if ( ! empty( $location_rules ) ) {
+			foreach ( $location_rules as $group => $locations ) {
+				if ( ! empty( $locations ) ) {
+					foreach ( $locations as $location ) {
+						if ( ! array_key_exists( $location, $rules_by_location ) ) {
+							$rules_by_location[ $location ] = [];
+						}
+						$rules_by_location[ $location ][] = $group;
+					}
+				}
+			}
+		}
+		return $rules_by_location;
 	}
 
 	/**
@@ -564,34 +625,26 @@ public function get_location_rules( array $acf_field_groups = [] ): array {
 	 * @return array<mixed>
 	 */
 	public function get_graphql_locations_for_field_group( array $field_group, array $acf_field_groups ): array {
+
+		$graphql_types = [];
+
 		if ( ! $this->should_field_group_show_in_graphql( $field_group ) ) {
-			return [];
+			return $graphql_types;
 		}
 
-		// early return if the field group has graphql_types defined
 		if ( ! empty( $field_group['graphql_types'] ) && is_array( $field_group['graphql_types'] ) ) {
-			return array_unique( $field_group['graphql_types'] );
+			return $field_group['graphql_types'];
 		}
 
-		if ( empty( $field_group['locations'] ) ) {
-			return [];
+		if ( empty( $field_group['location'] ) ) {
+			return $graphql_types;
 		}
 
 		$field_group_name = \WPGraphQL\Acf\Utils::get_field_group_name( $field_group );
 
-		if ( empty( $field_group_name ) ) {
-			return [];
-		}
-
-		$field_group_name = Utils::format_field_name( $field_group_name, true );
-
-		if ( ! isset( $field_group['map_graphql_types_from_location_rules'] ) || true === (bool) $field_group['map_graphql_types_from_location_rules'] ) {
-			return [];
-		}
-
-		$location_rules = $this->get_location_rules( [ $field_group_name ] );
+		$location_rules = $this->get_location_rules( $acf_field_groups );
 		if ( isset( $location_rules[ $field_group_name ] ) ) {
-			$graphql_types = $location_rules[ $field_group_name ] ?? [];
+			$graphql_types = $location_rules[ $field_group_name ];
 		}
 
 		return ! empty( $graphql_types ) && is_array( $graphql_types ) ? array_unique( array_filter( $graphql_types ) ) : [];
@@ -658,7 +711,7 @@ public function register_acf_field_groups_to_graphql( array $acf_field_groups =
 				}
 
 				// If the field group has locations defined (Types to be added to)
-				// Add the
+				// Add the WithAcf$FieldGroup Interface to the corresponding graphql_types
 				register_graphql_interfaces_to_types( [ $with_field_group_interface_name ], $locations );
 			}
 

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'] ) {

tests/wpunit/OptionsPageTest.php

@@ -4,6 +4,8 @@ class OptionsPageTest extends \Tests\WPGraphQL\Acf\WPUnit\WPGraphQLAcfTestCase {
 
 	public function setUp():void {
 
+		WPGraphQL::clear_schema();
+
 		if ( ! function_exists( 'acf_add_options_page' ) ) {
 			$this->markTestSkipped( 'ACF Options Pages are not available in this test environment' );
 		}