feat: Add Admin Notice for WPGraphQL for ACF by josephfusco · Pull Request #3027 · wp-graphql/wp-graphql

josephfusco · 2024-01-29T19:49:19Z

What does this implement/fix? Explain your changes.

This introduces a new register_graphql_admin_notice() API that can be used to display an admin notice on the Plugins page, or on the WPGraphQL Settings or GraphiQL IDE page.

This can be used by core WPGraphQL or for extensions to provide notices scoped to WPGraphQL pages.

It allows for notices to be permanent or dismissable and handles nonces for dismissing, storing a flag of dismissed notices in user_meta so that users won't be bugged again by the same notice after they've dismissed it.

Does this close any currently open issues?

no

Any other comments?

Documentation: https://www.wpgraphql.com/functions/register_graphql_admin_notice

example usage:

add_action( 'plugins_loaded', function() {

  if ( function_exists( 'register_graphql_admin_notice' ) ) {
    $config = [
      
      // required. string. The message to display in the notice. If no message, the notice won't display.
      'message' => __( 'Your notice message', 'your-textdomain' ), 
      
      // optional. boolean. whether the notice should be dismissable. False to be non-dismissable.
      'is_dismissable' => true, 
     
      // optional. string. The type of message. warning, success, error, info
      'type' => 'info', 
      
      // optional. callback. return true to display the notice (i.e. only display if another plugin is active)
      'conditions' => function() { 
         // if xx == true, return true
         // if xx == false, return false  
       }
    ];
    
    register_graphql_admin_notice( 'my-notice-slug', $config );
  }

} );

Signed-off-by: Joe Fusco <[email protected]>

coveralls · 2024-01-29T20:04:44Z

coverage: 84.275% (-0.5%) from 84.765%
when pulling e6cd74a on acf-deprecation-notice
into 121a691 on develop.

…ecation-notice

qlty-cloud-legacy · 2024-01-30T22:58:04Z

src/Admin/AdminNotices.php

+	/**
+	 * @return void
+	 */
+	public function maybe_display_notices(): void {


Method maybe_display_notices has 52 lines of code (exceeds 40 allowed). Consider refactoring.

src/Admin/AdminNotices.php

LondonCityMedia · 2024-01-31T10:20:44Z

I tested this by replacing the Admin.php file in our live on our system yesterday, and the deprecation warnings still persist today.

justlevine · 2024-01-31T11:35:47Z

@xbd63

I tested this by replacing the Admin.php file in our live on our system yesterday, and the deprecation warnings still persist today.

This is a draft PR, so regardless it shouldn't be expected to work in its current state.
The purpose this PR is to display an admin notice on the WordPress dashboard. It has nothing to do with PHP deprecated #2981 or any other PHP 8.3 compatibility work.

LondonCityMedia · 2024-01-31T11:49:19Z

Ok thanks for explaining that.

On the WP GraphQL I do see a notice "Check out the new WPGraphQL for ACF".

Please let me know if I need to do anything else.

src/Admin/AdminNotices.php

- replaced unset calls with $this->remove_admin_notice

Signed-off-by: Joe Fusco <[email protected]>

qlty-cloud-legacy · 2024-02-02T19:10:38Z

src/Admin/AdminNotices.php

+	/**
+	 * Render the notices.
+	 */
+	protected function render_notices(): void {


Method render_notices has 55 lines of code (exceeds 40 allowed). Consider refactoring.

Signed-off-by: Joe Fusco <[email protected]>

justlevine

Did a quick pass, will review more in depth tomorrow and also probably make those array types more specific

justlevine · 2024-02-03T02:18:08Z

access-functions.php

 }
+
+/**
+ * @param string       $slug A unique slug to identify the admin notice by


Suggested change

* @param string $slug A unique slug to identify the admin notice by

* Registers a configurable notice on the WordPress Dashboard for WPGraphQL-related notices.

*

* @param string $slug A unique slug to identify the admin notice by.

justlevine · 2024-02-03T02:18:29Z

access-functions.php

+
+/**
+ * @param string       $slug A unique slug to identify the admin notice by
+ * @param array<mixed> $config The config for the admin notice. Determines visibility, context, etc.


Suggested change

* @param array<mixed> $config The config for the admin notice. Determines visibility, context, etc.

* @param array<string,mixed> $config The config for the admin notice. Determines visibility, context, etc.

justlevine · 2024-02-03T02:23:38Z

src/Admin/Admin.php

 		$this->admin_enabled    = apply_filters( 'graphql_show_admin', true );
 		$this->graphiql_enabled = apply_filters( 'graphql_enable_graphiql', get_graphql_setting( 'graphiql_enabled', true ) );

+		$admin_notices = new AdminNotices();


This should probably be wrapped in an is_admin() check. I don't think we're doing that earlier in the lifecycle but I might be wrong (reviewing via 📱)

src/Admin/AdminNotices.php

composer.json

src/Admin/AdminNotices.php

Signed-off-by: Joe Fusco <[email protected]>

src/Admin/AdminNotices.php

Signed-off-by: Joe Fusco <[email protected]>

src/Admin/AdminNotices.php

- extend WPGraphQLTestCase instead of TestCase

qlty-cloud-legacy · 2024-02-08T19:15:21Z

Code Climate has analyzed commit e6cd74a and detected 3 issues on this pull request.

Here's the issue category breakdown:

Category	Count
Complexity	3

View more on Code Climate.

Add admin notice

abfcb6c

Signed-off-by: Joe Fusco <[email protected]>

jasonbahl added 2 commits January 30, 2024 09:46

Merge commit '39429412cf78ccaa7caa93fa1889c344585f89bf' into acf-depr…

5d15b6e

…ecation-notice

- move admin notices to a different class

8f61df9

qlty-cloud-legacy bot reviewed Jan 30, 2024

View reviewed changes

no message

77d1917

qlty-cloud-legacy bot reviewed Jan 31, 2024

View reviewed changes

src/Admin/AdminNotices.php Show resolved Hide resolved

src/Admin/AdminNotices.php Show resolved Hide resolved

jasonbahl and others added 5 commits January 31, 2024 10:40

- removed unused get_admin_notice function

a42f475

- replaced unset calls with $this->remove_admin_notice

no message

0cbebc3

Add WP_Mock dep

5880d4e

Signed-off-by: Joe Fusco <[email protected]>

Include unit tests for AdminNotices

5d495fc

Signed-off-by: Joe Fusco <[email protected]>

Resolve linting issues

dcd2cdc

Signed-off-by: Joe Fusco <[email protected]>

josephfusco changed the title ~~Add Admin Notice for WPGraphQL for ACF~~ fix: Add Admin Notice for WPGraphQL for ACF Feb 2, 2024

josephfusco added 2 commits February 2, 2024 14:06

Resolve linting issues

0045c0a

Signed-off-by: Joe Fusco <[email protected]>

Include space for dismissable icon

f6451aa

Signed-off-by: Joe Fusco <[email protected]>

qlty-cloud-legacy bot reviewed Feb 2, 2024

View reviewed changes

josephfusco and others added 2 commits February 2, 2024 14:28

Refactor to use usermeta instead of option table

69d383c

Signed-off-by: Joe Fusco <[email protected]>

- add support for the red bubble on the admin menu

f0dd099

jasonbahl changed the title ~~fix: Add Admin Notice for WPGraphQL for ACF~~ feat: Add Admin Notice for WPGraphQL for ACF Feb 2, 2024

- add basic tests for AdminNotices

6a12941

jasonbahl marked this pull request as ready for review February 2, 2024 23:59

jasonbahl self-assigned this Feb 2, 2024

jasonbahl requested a review from justlevine February 2, 2024 23:59

justlevine reviewed Feb 3, 2024

View reviewed changes

composer.json Outdated Show resolved Hide resolved

justlevine reviewed Feb 3, 2024

View reviewed changes

jasonbahl assigned josephfusco Feb 5, 2024

jasonbahl removed their assignment Feb 5, 2024

josephfusco added 2 commits February 6, 2024 14:30

Display notices in Network admin

18700e4

Signed-off-by: Joe Fusco <[email protected]>

Config validation

a84d1b0

Signed-off-by: Joe Fusco <[email protected]>

qlty-cloud-legacy bot reviewed Feb 6, 2024

View reviewed changes

src/Admin/AdminNotices.php Show resolved Hide resolved

src/Admin/AdminNotices.php Show resolved Hide resolved

src/Admin/AdminNotices.php Show resolved Hide resolved

josephfusco added 2 commits February 6, 2024 15:19

Clean up white space

8e92bb9

Signed-off-by: Joe Fusco <[email protected]>

Resolve linting issues

433179e

Signed-off-by: Joe Fusco <[email protected]>

josephfusco requested a review from jasonbahl February 6, 2024 20:22

jasonbahl reviewed Feb 6, 2024

View reviewed changes

src/Admin/AdminNotices.php Outdated Show resolved Hide resolved

Update src/Admin/AdminNotices.php

625843a

jasonbahl reviewed Feb 6, 2024

View reviewed changes

src/Admin/AdminNotices.php Outdated Show resolved Hide resolved

jasonbahl added 5 commits February 6, 2024 13:30

Update src/Admin/AdminNotices.php

022983f

- remove wp-mock

b3e6a21

- extend WPGraphQLTestCase instead of TestCase

rebuild composer.lock

8ea75ef

- merge

c90ae7e

- regenerate composer.lock

9c7a37e

jasonbahl closed this Feb 8, 2024

jasonbahl reopened this Feb 8, 2024

jasonbahl added 2 commits February 8, 2024 12:08

Merge branch 'develop' into acf-deprecation-notice

198c321

- upgrade composer

e6cd74a

jasonbahl merged commit 28f0952 into develop Feb 8, 2024

This was referenced Feb 8, 2024

release: v1.21.0 #3040

Closed

release: v1.21.0 #3041

Merged

justlevine deleted the acf-deprecation-notice branch August 3, 2024 11:57

- * @param string       $slug A unique slug to identify the admin notice by
+ * Registers a configurable notice on the WordPress Dashboard for WPGraphQL-related notices.
+ *
+ * @param string       $slug A unique slug to identify the admin notice by.

	* @param array<mixed> $config The config for the admin notice. Determines visibility, context, etc.
	* @param array<string,mixed> $config The config for the admin notice. Determines visibility, context, etc.

Conversation

josephfusco commented Jan 29, 2024 • edited by jasonbahl Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this implement/fix? Explain your changes.

Does this close any currently open issues?

Any other comments?

Uh oh!

coveralls commented Jan 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

qlty-cloud-legacy bot Jan 30, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

LondonCityMedia commented Jan 31, 2024

Uh oh!

justlevine commented Jan 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LondonCityMedia commented Jan 31, 2024

Uh oh!

Uh oh!

Uh oh!

qlty-cloud-legacy bot Feb 2, 2024

Choose a reason for hiding this comment

Uh oh!

justlevine left a comment

Choose a reason for hiding this comment

Uh oh!

justlevine Feb 3, 2024

Choose a reason for hiding this comment

Uh oh!

justlevine Feb 3, 2024

Choose a reason for hiding this comment

Uh oh!

justlevine Feb 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

qlty-cloud-legacy bot commented Feb 8, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

josephfusco commented Jan 29, 2024 •

edited by jasonbahl

Loading

coveralls commented Jan 29, 2024 •

edited

Loading

justlevine commented Jan 31, 2024 •

edited

Loading