Merge pull request #132 from wp-graphql/fix/128-options-page-with-custom-post_id-not-resolving

fix: options page with custom post_id not resolving properly

Author: jasonbahl

src/Model/AcfOptionsPage.php

@@ -53,7 +53,7 @@ protected function init(): void {
 				'id'        => function () {
 					return Relay::toGlobalId( 'acf_options_page', $this->data['menu_slug'] );
 				},
-				'acfId'     => 'options',
+				'acfId'     => $this->data['post_id'] ?? 'options',
 			];
 		}
 	}

src/Registry.php

@@ -356,6 +356,7 @@ public function register_options_pages():void {
 		);
 
 		foreach ( $graphql_options_pages as $graphql_options_page ) {
+			$graphql_options_page['is_options_page'] = true;
 			if ( ! $this->should_field_group_show_in_graphql( $graphql_options_page ) ) {
 				continue;
 			}

src/Utils.php

@@ -56,12 +56,12 @@ public static function get_node_acf_id( $node ) {
 				// @phpstan-ignore-next-line
 				$id = 'comment_' . absint( $node->databaseId );
 				break;
-			case is_array( $node ) && isset( $node['post_id'] ) && 'options' === $node['post_id']:
-				$id = $node['post_id'];
-				break;
 			case $node instanceof AcfOptionsPage:
 				$id = $node->acfId;
 				break;
+			case is_array( $node ) && isset( $node['post_id'] ):
+				$id = $node['post_id'];
+				break;
 			default:
 				$id = 0;
 				break;
@@ -282,7 +282,7 @@ public static function should_field_group_show_in_graphql( array $acf_field_grou
 		// if the field group was configured with no "show_in_graphql" value, default to the "show_in_rest" value
 		// to determine if the group should be available in an API
 		if (
-			( isset( $acf_field_group['post_id'] ) && 'options' !== $acf_field_group['post_id'] ) &&
+			( 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;
 		}

tests/wpunit/OptionsPageTest.php

@@ -2,8 +2,8 @@
 
 class OptionsPageTest extends \Tests\WPGraphQL\Acf\WPUnit\WPGraphQLAcfTestCase {
 
-
 	public function setUp():void {
+
 		if ( ! function_exists( 'acf_add_options_page' ) ) {
 			$this->markTestSkipped( 'ACF Options Pages are not available in this test environment' );
 		}
@@ -15,13 +15,14 @@ public function tearDown(): void {
 		parent::tearDown();
 	}
 
-	public function registerOptionsPage( $title = 'My Options Page', $config = [] ) {
 
 
+	public function registerOptionsPage( $config = [] ) {
+
 		// register options page
 		acf_add_options_page(
 			array_merge( [
-				'page_title' => $title,
+				'page_title' => 'My Options Page',
 				'menu_title' => __( 'My Options Page' ),
 				'menu_slug'  => 'my-options-page',
 				'capability' => 'edit_posts',
@@ -35,15 +36,7 @@ public function testAcfOptionsPageIsQueryableInSchema() {
 
 		$this->registerOptionsPage();
 
-		$expected_value = uniqid( 'test', true );
-
-		// Save a value to the ACF Option Field
-		// see: https://www.advancedcustomfields.com/resources/update_field/#update-a-value-from-different-objects
-		if ( function_exists( 'update_field' ) ) {
-			update_field( 'text', $expected_value, 'option' );
-		}
-
-		$this->register_acf_field( [], [
+		$field_key = $this->register_acf_field( [], [
 			'graphql_field_name' => 'OptionsFields',
 			'location' => [
 				[
@@ -56,6 +49,16 @@ public function testAcfOptionsPageIsQueryableInSchema() {
 			],
 		]);
 
+		$expected_value = uniqid( 'test', true );
+
+		// Save a value to the ACF Option Field
+		// see: https://www.advancedcustomfields.com/resources/update_field/#update-a-value-from-different-objects
+		if ( function_exists( 'update_field' ) ) {
+			update_field( $field_key, $expected_value, 'options' );
+		}
+
+
+
 		$query = '
 		{
 		  myOptionsPage {
@@ -103,7 +106,7 @@ public function testAcfOptionsPageIsQueryableInSchema() {
 	 */
 	public function testOptionsPageNotInSchemaIfShowInGraphqlIsFalse() {
 
-		acf_add_options_page(
+		$this->registerOptionsPage(
 			[
 				'page_title' => 'ShowInGraphQLFalse',
 				'menu_title' => __( 'Show in GraphQL False' ),
@@ -175,26 +178,20 @@ public function testOptionsPageNotInSchemaIfShowInGraphqlIsFalse() {
 
 	// - options page shows with different name if "graphql_field_name" is set
 	public function testOptionsPageRespectsGraphqlFieldName() {
-		acf_add_options_page(
+
+		$this->registerOptionsPage(
 			[
 				'page_title' => 'CustomGraphqlName',
-				'menu_title' => __( 'Show in GraphQL False' ),
+				'menu_title' => __( 'Custom GraphQL Name' ),
 				'menu_slug'  => 'custom-graphql-name',
 				'capability' => 'edit_posts',
+				'post_id'   => 'custom-graphql-name',
 				// options pages will show in the Schema unless set to false
 				'graphql_type_name'   => 'MyCustomOptionsName',
 			]
 		);
 
-		$expected_value = uniqid( 'test', true );
-
-		// Save a value to the ACF Option Field
-		// see: https://www.advancedcustomfields.com/resources/update_field/#update-a-value-from-different-objects
-		if ( function_exists( 'update_field' ) ) {
-			update_field( 'text', $expected_value, 'option' );
-		}
-
-		$this->register_acf_field( [], [
+		$acf_field = $this->register_acf_field( [], [
 			'graphql_field_name' => 'OptionsFields',
 			'location' => [
 				[
@@ -207,10 +204,21 @@ public function testOptionsPageRespectsGraphqlFieldName() {
 			],
 		]);
 
+		$expected_value = 'test value';
+
+		// Save a value to the ACF Option Field
+		// see: https://www.advancedcustomfields.com/resources/update_field/#update-a-value-from-different-objects
+		if ( ! function_exists( 'update_field' ) ) {
+			$this->markTestSkipped( 'update_field not available...' );
+		}
+
+		// update the field using the field key of the registered field
+		update_field( $acf_field, $expected_value, 'custom-graphql-name' );
+
 		$query = '
 		{
-		  myCustomOptionsName {
-		    optionsFields {
+		  myCustomOptionsName { # this is the name of the options page based on graphql_type_name
+		    optionsFields { # this is the field name for the field group
 		      text
 		    }
 		  }
@@ -221,6 +229,12 @@ public function testOptionsPageRespectsGraphqlFieldName() {
 			'query' => $query,
 		]);
 
+		codecept_debug( [
+			'$get_field' => get_field( 'text', 'custom-graphql-name' ),
+			'options_pages' => acf_get_options_pages(),
+			'$acf_field' => $acf_field,
+		]);
+
 		self::assertQuerySuccessful( $actual, [
 			// the instructions should be used for the description
 			$this->expectedField( 'myCustomOptionsName.optionsFields.text', $expected_value ),
@@ -248,7 +262,7 @@ public function testOptionsPageRespectsGraphqlFieldName() {
 
 	public function testQueryOptionsPageAsNode() {
 
-		acf_add_options_page(
+		$this->registerOptionsPage(
 			[
 				'page_title' => 'OptionsPageNode',
 				'menu_title' => __( 'Options Page Node' ),