-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- respect "graphql_type_name" as a field group field in addition to "…
…graphql_field_name" - add support for OptionsPage UI from ACF v6.2+
- Loading branch information
Showing
6 changed files
with
192 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,167 @@ | ||
| <?php | ||
| namespace WPGraphQL\Acf\Admin; | ||
|
|
||
| use WPGraphQL\Utils\Utils; | ||
|
|
||
| class OptionsPageRegistration { | ||
|
|
||
| /** | ||
| * @return void | ||
| */ | ||
| public function init(): void { | ||
|
|
||
| // Add GraphQL columns to the ACF Options Page registration columns | ||
| // NOTE: the priority must be lower (a bigger number) than 10 to not conflict | ||
| // with the default ACF columns filter | ||
| add_filter( 'manage_acf-ui-options-page_posts_columns', [ $this, 'add_graphql_type_column' ], 20, 1 ); | ||
|
|
||
| // Display the GraphQL Type in the ACF Taxonomy Registration Columns | ||
| add_action( 'manage_acf-ui-options-page_posts_custom_column', [ $this, 'render_graphql_columns' ], 10, 2 ); | ||
|
|
||
| // Add registration fields to the ACF Options Pages output for exporting / saving as PHP | ||
| add_filter( 'acf/ui_options_page/registration_args', [ $this, 'add_registration_fields' ], 10, 2 ); | ||
|
|
||
| // Add tha GraphQL Tab to the ACF Post Type registration screen | ||
| add_filter( 'acf/ui_options_page/additional_settings_tabs', [ $this, 'add_tabs' ] ); | ||
|
|
||
| // Render the graphql settings tab in the ACF post type registration screen | ||
| add_action( 'acf/ui_options_page/render_settings_tab/graphql', [ $this, 'render_settings_tab' ] ); | ||
| } | ||
|
|
||
| /** | ||
| * @param array $args | ||
| * @param array $post | ||
| * | ||
| * @return array | ||
| */ | ||
| public function add_registration_fields( array $args, array $post ) : array { | ||
| $show_in_graphql = false; | ||
|
|
||
| if ( isset( $args['show_in_graphql'] ) ) { | ||
| $show_in_graphql = $args['show_in_graphql']; | ||
| } elseif ( isset( $post['show_in_graphql'] ) ) { | ||
| $show_in_graphql = $post['show_in_graphql']; | ||
| } | ||
|
|
||
| $args['show_in_graphql'] = $show_in_graphql; | ||
|
|
||
| $graphql_type_name = ''; | ||
|
|
||
| if ( ! empty( $args['graphql_type_name'] ) ) { | ||
| $graphql_type_name = $args['graphql_type_name']; | ||
| } elseif ( ! empty( $post['graphql_type_name'] ) ) { | ||
| $graphql_type_name = $post['graphql_type_name']; | ||
| } elseif ( isset( $args['page_title'] ) ) { | ||
| $graphql_type_name = Utils::format_field_name( $args['page_title'], false ); | ||
| } | ||
|
|
||
| // if a graphql_single_name exists, use it, otherwise use the formatted version of the singular_name label | ||
| $args['graphql_type_name'] = $graphql_type_name; | ||
|
|
||
| return $args; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $tabs | ||
| * | ||
| * @return array | ||
| */ | ||
| public function add_tabs( array $tabs ): array { | ||
| $tabs['graphql'] = __( 'GraphQL', 'wp-graphql-acf' ); | ||
| return $tabs; | ||
| } | ||
|
|
||
| /** | ||
| * @param array $acf_ui_options_page | ||
| * | ||
| * @return void | ||
| */ | ||
| public function render_settings_tab( array $acf_ui_options_page ): void { | ||
| acf_render_field_wrap( | ||
| [ | ||
| 'type' => 'true_false', | ||
| 'name' => 'show_in_graphql', | ||
| 'key' => 'show_in_graphql', | ||
| 'prefix' => 'acf_ui_options_page', | ||
| 'value' => isset( $acf_ui_options_page['show_in_graphql'] ) && true === (bool) $acf_ui_options_page['show_in_graphql'] ? 1 : 0, | ||
| 'ui' => true, | ||
| 'label' => __( 'Show in GraphQL', 'wp-graphql-acf' ), | ||
| 'instructions' => __( 'Whether to show the Post Type in the WPGraphQL Schema.', 'wp-graphql-acf' ), | ||
| 'default' => false, | ||
| ] | ||
| ); | ||
|
|
||
| $graphql_type_name = $acf_ui_options_page['graphql_type_name'] ?? ''; | ||
|
|
||
| if ( empty( $graphql_type_name ) ) { | ||
| $graphql_type_name = ! empty( $acf_ui_options_page['page_title'] ) ? Utils::format_field_name( $acf_ui_options_page['page_title'], true ) : ''; | ||
| } | ||
|
|
||
| $graphql_type_name = Utils::format_field_name( $graphql_type_name, true ); | ||
|
|
||
| acf_render_field_wrap( | ||
| [ | ||
| 'type' => 'text', | ||
| 'name' => 'graphql_type_name', | ||
| 'key' => 'graphql_type_name', | ||
| 'prefix' => 'acf_ui_options_page', | ||
| 'value' => $graphql_type_name, | ||
| 'label' => __( 'GraphQL Type Name', 'wp-graphql-acf' ), | ||
| 'instructions' => __( 'How the Options Page should be referenced in the GraphQL Schema.', 'wp-graphql-acf' ), | ||
| 'default' => $graphql_type_name, | ||
| 'required' => 1, | ||
| 'conditions' => [ | ||
| 'field' => 'show_in_graphql', | ||
| 'operator' => '==', | ||
| 'value' => '1', | ||
| ], | ||
| ], | ||
| 'div', | ||
| 'field' | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * Given a list of columns, add "graphql_type" as a column. | ||
| * | ||
| * @param array $columns The columns on the post type table | ||
| * | ||
| * @return array | ||
| */ | ||
| public function add_graphql_type_column( array $columns ): array { | ||
| $columns['show_in_graphql'] = __( 'Show in GraphQL', 'wp-graphql-acf' ); | ||
| $columns['graphql_type'] = __( 'GraphQL Type', 'wp-graphql-acf' ); | ||
| return $columns; | ||
| } | ||
|
|
||
| /** | ||
| * Determine and echo the markup to show for the graphql_type column | ||
| * | ||
| * @param string $column_name The name of the column being rendered | ||
| * @param int $post_id The ID of the post the column is being displayed for | ||
| * | ||
| * @return void | ||
| */ | ||
| public function render_graphql_columns( string $column_name, int $post_id ): void { | ||
| $post_type = acf_get_internal_post_type( $post_id, 'acf-ui-options-page' ); | ||
|
|
||
| // if there's no post type, bail early | ||
| if ( empty( $post_type ) ) { | ||
| return; | ||
| } | ||
|
|
||
| // Determine the output for the column | ||
| switch ( $column_name ) { | ||
| case 'graphql_type': | ||
| $graphql_type = Utils::format_type_name( \WPGraphQL\Acf\Utils::get_field_group_name( $post_type ) ); | ||
| echo esc_html( $graphql_type ); | ||
| break; | ||
| case 'show_in_graphql': | ||
| $show = isset( $post_type['show_in_graphql'] ) && true === (bool) $post_type['show_in_graphql'] ? 'true' : 'false'; | ||
| echo esc_html( $show ); | ||
| break; | ||
| default: | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters