Merge branch 'feat/#83-show-in-graphql-options-pages' into release/v2…

….0.0-beta.5.0.0 # Conflicts: # src/LocationRules/LocationRules.php # src/ThirdParty/WPGraphQLContentBlocks/WPGraphQLContentBlocks.php
wp-graphql · Sep 12, 2023 · 4a6af43 · 4a6af43
2 parents 34ddf03 + 6bb29d7
commit 4a6af43
Show file tree

Hide file tree

Showing 6 changed files with 55 additions and 10 deletions.
diff --git a/src/LocationRules/LocationRules.php b/src/LocationRules/LocationRules.php
@@ -877,7 +877,44 @@ public function determine_nav_menu_item_item_rules( string $field_group_name, st
 	 * @return void
 	 */
 	public function determine_block_rules( string $field_group_name, string $param, string $operator, string $value ): void {
-		// @todo: ACF Blocks are not formally supported by WPGraphQL / WPGraphQL for ACF. More to come in the future!
+
+		if ( ! function_exists( 'acf_get_block_types' ) ) {
+			return;
+		}
+
+		if ( '==' === $operator ) {
+			$acf_block = acf_get_block_type( $value );
+
+			if ( empty( $acf_block ) || ! \WPGraphQL\Acf\Utils::should_field_group_show_in_graphql( $acf_block ) ) {
+				return;
+			}
+
+			$type_name = \WPGraphQL\Acf\Utils::get_field_group_name( $acf_block );
+			$this->set_graphql_type( $field_group_name, $type_name );
+		}
+
+		if ( '!=' === $operator ) {
+			$acf_blocks = acf_get_block_types();
+
+			if ( empty( $acf_blocks ) || ! is_array( $acf_blocks ) ) {
+				return;
+			}
+
+			foreach ( $acf_blocks as $acf_block ) {
+				if ( ! isset( $acf_block['show_in_graphql'] ) || false === (bool) $acf_block['show_in_graphql'] ) {
+					continue;
+				}
+				$type_name = isset( $acf_block['graphql_field_name'] ) ? Utils::format_type_name( $acf_block['graphql_field_name'] ) : Utils::format_type_name( $acf_block['name'] );
+				$this->set_graphql_type( $field_group_name, $type_name );
+			}
+
+			$acf_block = acf_get_block_type( $value );
+			if ( ! isset( $acf_block['show_in_graphql'] ) || false === $acf_block['show_in_graphql'] ) {
+				return;
+			}
+			$type_name = isset( $acf_block['graphql_field_name'] ) ? Utils::format_type_name( $acf_block['graphql_field_name'] ) : Utils::format_type_name( $acf_block['name'] );
+			$this->unset_graphql_type( $field_group_name, $type_name );
+		}
 	}
 
 	/**
@@ -930,13 +967,11 @@ public function determine_options_rules( string $field_group_name, string $param
 			if ( ! isset( $options_page['show_in_graphql'] ) || false === $options_page['show_in_graphql'] ) {
 				return;
 			}
-
 			if ( ! empty( $options_page['graphql_single_name'] ) ) {
 				$type_name = Utils::format_type_name( $options_page['graphql_single_name'] );
 			} else {
 				$type_name = isset( $options_page['graphql_type_name'] ) ? Utils::format_type_name( $options_page['graphql_type_name'] ) : Utils::format_type_name( $options_page['menu_slug'] );
 			}
-
 			$this->unset_graphql_type( $field_group_name, $type_name );
 		}
 	}

diff --git a/src/ThirdParty/WPGraphQLContentBlocks/WPGraphQLContentBlocks.php b/src/ThirdParty/WPGraphQLContentBlocks/WPGraphQLContentBlocks.php
@@ -7,11 +7,14 @@
 class WPGraphQLContentBlocks {
 
 	/**
+	 * Initialize support for WPGraphQL Content Blocks
+	 *
 	 * @return void
 	 */
 	public function init(): void {
 
-		// Bail if WPGraphQL Content Blocks is not active at 1.2.0 or later.
+		// If WPGraphQL Content Blocks is not active, or is active with a version prior to 1.2.0, don't
+		// instantiate this functionality
 		if ( ! defined( 'WPGRAPHQL_CONTENT_BLOCKS_VERSION' ) || version_compare( WPGRAPHQL_CONTENT_BLOCKS_VERSION, '1.2.0', 'lt' ) ) {
 			return;
 		}

diff --git a/src/Utils.php b/src/Utils.php
@@ -138,9 +138,11 @@ public static function get_acf_options_pages(): array {
 			return $options_pages;
 		}
 		$acf_options_pages = acf_get_options_pages();
+
 		if ( empty( $acf_options_pages ) || ! is_array( $acf_options_pages ) ) {
 			return $options_pages;
 		}
+
 		return array_filter(
 			array_map(
 				static function ( $option_page ) {
@@ -274,7 +276,6 @@ public static function should_field_show_in_graphql( array $acf_field ): bool {
 	public static function should_field_group_show_in_graphql( array $acf_field_group ): bool {
 		$should = true;
 
-
 		$show_in_rest = $acf_field_group['show_in_rest'] ?? false;
 
 
@@ -308,6 +309,8 @@ public static function get_field_group_name( array $field_group ): string {
 		if ( ! empty( $field_group['graphql_field_name'] ) ) {
 			$field_group_name = $field_group['graphql_field_name'];
 			$field_group_name = preg_replace( '/[^0-9a-zA-Z_\s]/i', '', $field_group_name );
+		} elseif ( ! empty( $field_group['graphql_type_name'] ) ) {
+			$field_group_name = \WPGraphQL\Utils\Utils::format_field_name( $field_group['graphql_type_name'], true );
 		} else {
 			if ( ! empty( $field_group['name'] ) ) {
 				$field_group_name = $field_group['name'];

diff --git a/src/WPGraphQLAcf.php b/src/WPGraphQLAcf.php
@@ -4,6 +4,7 @@
 
 use WPGraphQL\Acf\Admin\PostTypeRegistration;
 use WPGraphQL\Acf\Admin\TaxonomyRegistration;
+use WPGraphQL\Acf\Admin\OptionsPageRegistration;
 use WPGraphQL\Acf\Registry;
 use WPGraphQL\Acf\ThirdParty;
 
@@ -34,7 +35,7 @@ public function init(): void {
 
 		add_action( 'wpgraphql/acf/init', [ $this, 'init_third_party_support' ] );
 		add_action( 'admin_init', [ $this, 'init_admin_settings' ] );
-		add_action( 'after_setup_theme', [ $this, 'cpt_tax_registration' ] );
+		add_action( 'after_setup_theme', [ $this, 'acf_internal_post_type_support' ] );
 		add_action( 'graphql_register_types', [ $this, 'init_registry' ] );
 
 		add_filter( 'graphql_data_loaders', [ $this, 'register_loaders' ], 10, 2 );
@@ -65,12 +66,15 @@ public function init_admin_settings(): void {
 	 *
 	 * @return void
 	 */
-	public function cpt_tax_registration(): void {
+	public function acf_internal_post_type_support(): void {
 		$taxonomy_registration_screen = new TaxonomyRegistration();
 		$taxonomy_registration_screen->init();
 
 		$cpt_registration_screen = new PostTypeRegistration();
 		$cpt_registration_screen->init();
+
+		$options_page_registration_screen = new OptionsPageRegistration();
+		$options_page_registration_screen->init();
 	}
 
 	/**

diff --git a/tests/wpunit/LocationRulesTest.php b/tests/wpunit/LocationRulesTest.php
@@ -588,7 +588,7 @@ public function testNoErrorIfFieldGroupIsAssignedToOrphanedOptionsPage() {
 			'menu_slug'     => 'theme-general-settings',
 			'capability'    => 'edit_posts',
 			'redirect'      => false,
-			'graphql_single_name'
+			'show_in_graphql' => 1
 		));
 
 		$this->clearSchema();

diff --git a/tests/wpunit/OptionsPageTest.php b/tests/wpunit/OptionsPageTest.php
@@ -182,7 +182,7 @@ public function testOptionsPageRespectsGraphqlFieldName() {
 				'menu_slug'  => 'custom-graphql-name',
 				'capability' => 'edit_posts',
 				// options pages will show in the Schema unless set to false
-				'graphql_field_name'   => 'MyCustomOptionsName',
+				'graphql_type_name'   => 'MyCustomOptionsName',
 			]
 		);
 
@@ -255,7 +255,7 @@ public function testQueryOptionsPageAsNode() {
 				'menu_slug'  => 'options-page-node',
 				'capability' => 'edit_posts',
 				// options pages will show in the Schema unless set to false
-				'graphql_field_name'   => 'OptionsPageNode',
+				'graphql_type_name'   => 'OptionsPageNode',
 			]
 		);