Update historical notices to use the new `render_notice` method. #2409

anaemnesis · 2023-04-21T10:40:14Z

Changes proposed in this Pull Request

This PR updates historical licenses to use the new WP_Job_Manager_Admin_Notices::render_notice method.

This change changes the render_notice notice method from a private static function to a public static function and then updates the notice display per the renders at #2382.

One item I have chosen to forgo for this change is the grouped update notification. I've decided this as the immediate request is to update historical notices to use the render_notice method, whereas the grouped update notifications would require the creation of new, non-historical notices.

One additional item I noticed is that the update notices don't inherit styling on non-WPJM pages:

To address this I could either move the relevant wp_enqueue_style and wp_register_style outside of the if ( in_array( $screen->id, apply_filters(.... conditional, or, add more screen IDs to the check. I've opted to move the style as it's not possible to anticipate all of the potential screens the notices might display on, or even if it was, the check would be so long as to be pointless.

To prevent a conflict with WC styling, I've also made use of a ! important declaration. I don't know if, instead, we want to copy into WPJM the relevant notice styles and have our own wpjm-notice class instead. I'm not keen on ! important so if we want to go to in that direction, I'm all for it. The declaration does seem the most straightforward though, and it's specific to our notices.

Without this change, notices lose their padding on certain WC pages (like WooCommerce --> Orders). For example:

Testing instructions

Checkout branch
Install a couple of paid WPJM plugins, but don't input a license key
Notices should display with the updated formatting as shown below
If you've tested this prior and an update notice isn't showing, use wp option delete wp_job_manager_dismissed_notices through WP CLI (or otherwise delete this option) to force the notice to display.

To show an error notice, comment out the code to show the missing license notice

WP-Job-Manager/includes/helper/class-wp-job-manager-helper.php

Lines 569 to 576 in 15393a2

    
           if ( empty( $licence['licence_key'] ) ) { 
        
           	add_filter( 
        
           		'wpjm_admin_notices', 
        
           		function ( $notices ) use ( $product_slug, $plugin_data ) { 
        
           			return $this->add_missing_licence_notice( $notices, $product_slug, $plugin_data ); 
        
           		} 
        
           	); 
        
           } elseif ( ! empty( $licence['errors'] ) ) {

change the elseif into an if, and then the check to show an error notice from ! empty to empty

WP-Job-Manager/includes/helper/class-wp-job-manager-helper.php

Lines 576 to 583 in 15393a2

    
           } elseif ( ! empty( $licence['errors'] ) ) { 
        
           	add_filter( 
        
           		'wpjm_admin_notices', 
        
           		function ( $notices ) use ( $product_slug, $plugin_data ) { 
        
           			return $this->add_error_licence_notice( $notices, $product_slug, $plugin_data ); 
        
           		} 
        
           	); 
        
           }

- Makes the `render_notice` method public so that it's callable from `html-license-key-error.php and `html-license-key-notice.php` - HTML removed from both files as this is provided as part of the `render_notice` method. - Notices are now sent in the format of the API request the `render_notice` method expects.

This change loads notice styling throughout WP Admin, rather than restrict it to certain pages. This is because historical notices display throughout WP Admin and not just on WPJM pages. WC styling was also interferring with WPJMs notice display. This has been addressed with a well-considered `! important` declaration.

anaemnesis · 2023-05-04T10:56:10Z

assets/css/admin-notices.scss

@@ -11,7 +11,7 @@ $notice-success: #43af99;

 	// Spacing.
 	gap: 10px;
-	padding: 10px 12px;
+	padding: 10px 12px !important;


I'm not totally cool with this, but after testing a few other options, it's the most straightforward option and limited to WPJM notice styling.

Another option is to rename notice to wpjm-notice and copy the relevant styling over to admin-notices.scss.

I realized an issue that we're also overriding an style that increases the padding in order to not have the dismiss button over the text.

Maybe a solution could be to add the !important only on the padding-top and padding-bottom?

Ah, I see what's happening there, yeah. I've gone with the separated padding route and I'm not seeing any issues with that.

Committed here b63ae05

includes/admin/class-wp-job-manager-admin.php

anaemnesis · 2023-05-05T09:02:56Z

Noting that since the feature branch has been closed by @aaronfc, approval of this PR will result in a merge directly to trunk, triggering a deployment !!

renatho

Hey! In general, it's looking very good!
I just left comments about 2 things I noticed.

Noting that since the feature branch has been closed by @aaronfc, approval of this PR will result in a merge directly to trunk, triggering a deployment !!

About this, I think it's not the case for the Job Manager plugin. :)

renatho · 2023-05-05T19:38:25Z

assets/css/admin-notices.scss

@@ -11,7 +11,7 @@ $notice-success: #43af99;

 	// Spacing.
 	gap: 10px;
-	padding: 10px 12px;
+	padding: 10px 12px !important;


I realized an issue that we're also overriding an style that increases the padding in order to not have the dismiss button over the text.

Maybe a solution could be to add the !important only on the padding-top and padding-bottom?

includes/admin/class-wp-job-manager-admin.php

renatho · 2023-05-05T19:50:39Z

includes/helper/views/html-licence-key-error.php

+
+$notice = [
+	'level'       => 'error',
+	'dismissible' => true,


I noticed that with this change, the dismissal is not being persisted anymore.

It seems we have a method checking the wpjm_hide_notice query string, but in this case, it's dismissing the notice without adding the query string or running any request.

Do you know if it's working in any other place to see what is different?

This was addressed in the refactor 15393a2

This sets the padding on the wpjm-admin-notice class to use the explicit top/right/bottom/left values. This way, the top and bottom styling can be overriden while the left/right are left alone.

…tice-styling

- Revert `render_notice` to a `private` method - Remove `html-licence-key-error.php` and `html-licence-key-notice.php` - Add two new methods, `add_missing_licence_notice` and `add_error_licence_notice` - Hook these two methods into the `wpjm_admin_notice` filter - These can both be used as examples for adding notice to WPJM in the future

- Make sure 'License' follows not the UK standard

anaemnesis · 2023-05-17T19:02:01Z

includes/helper/class-wp-job-manager-helper.php

-	public function licence_error_notices() {
-		$screen = get_current_screen();
-		if (
-			null === $screen ||
-			in_array( $screen->id, [ 'job_listing_page_job-manager-addons' ], true ) ||
-			! current_user_can( 'update_plugins' )
-		) {
-			return;
-		}


After speaking with @aaronfc we realised that null was being encountered when it ought not have been. This was removed as we decided that (1) error notices and (2) missing license notices should be displayed on the add-ons page.

anaemnesis · 2023-05-17T19:03:01Z

includes/helper/class-wp-job-manager-helper.php

-					include 'views/html-licence-key-error.php';
+					add_filter(
+						'wpjm_admin_notices',
+						function ( $notices ) use ( $product_slug, $plugin_data ) {


I tried to avoid the anonymous functions here, but I'm not aware of another way to pass $product_slug and $plugin_data to the methods called.

Mmm good call!

I am fine with using an anonymous function here. The idea to not use an anonymous function is to be able to "unhook" it programatically. But in this case we can always "hook" later and remove the notice_id that we want to remove.

I can think of alternative ways like storing in a private attribute the data needed or something like that, but I don't like it. Good to go with the anonymous function 🚀

anaemnesis · 2023-05-17T19:06:33Z

@aaronfc @renatho After speaking with Aaron, I completely refactored the notice displays to use the new wpjm_admin_notice filter. Testing instructions have been updated, and I worked through a couple of hangups with Aaron's help. But we're good for another round of testing.

15393a2

Edit: oh hang on, apparently we have unit tests now 👀
Edit: Fixed up. Failing tests now pertain to PHP version conflicts in the test suite itself

…' into add/update-legacy-notice-styling

I should have just reverted the commit that updated the spelling of licence, but this also fixes it. Lesson learned.

renatho

Hi Katja!

Thank you for working on that!

In my new test, it didn't show the notices. Maybe it's related to the order of hooks where we're using the wpjm_admin_notices now? Let me know if you need any help with that. ;)

Also, as we talked, if we replace the "license" with "licence" in this PR, we could try to avoid the apply_filters and the log_event functions to avoid breaking filters and losing metrics. Does it make sense? I'd advocate to not rename the strings too to not lose translations of what is already translated. But it's less critical if we really want this change.

renatho · 2023-05-18T14:19:29Z

includes/helper/class-wp-job-manager-helper.php

 	 */
-	public function licence_error_notices() {


In the plugins open for the users we should take care to not remove the public functions to avoid errors with any type of integration.

It seems just a rename right? So in this case, we could deprecate this method, and inside it, call the maybe_add_licence_error_notices. So if someone is using it, they will see the deprecation warning instead of an error, and the function will continue working.

@aaronfc and I had discussed renaming, so it's just a rename that's right.

I've not deprecated a method before, but that sounds like a plan to me. I'll get to looking at that.

Deprecated here ed89a13

Looking nice to me. Good catch, @renatho !

Thank you for changing that, Katja! And sorry for the late delay on reviewing it!

Just instead of maybe_add_license_error_notices() we should use WP_Job_Manager_Helper::maybe_add_license_error_notices to reference the correct method. Not something critical and urgent though. 😉

This commit hard-resets to `trunk`, and then selectively applies the changes we want. Too much had crept in with the wording errancy.

…' into add/update-legacy-notice-styling # Conflicts: # includes/helper/class-wp-job-manager-helper.php

anaemnesis · 2023-05-18T17:03:39Z

Also, as we talked, if we replace the "license" with "licence" in this PR, we could try to avoid the apply_filters and the log_event functions to avoid breaking filters and losing metrics. Does it make sense? I'd advocate to not rename the strings too to not lose translations of what is already translated. But it's less critical if we really want this change.

We did, and completely agree. I've gone ahead and hard-reset and reapplied changes:

The notices are showing for me though, so let me run through them again and see if I can replicate.

- This change deprecates the `licence_error_notices()` method and calls inside it, the `maybe_add_licens_error_notices()` method. Added for compatibility in case anyone was using the method as it was.

anaemnesis · 2023-05-20T20:09:29Z

In my new test, it didn't show the notices. Maybe it's related to the order of hooks where we're using the wpjm_admin_notices now? Let me know if you need any help with that. ;)

I think this is due to previous testing. Can you delete the wp_job_manager_dismissed_notices option and see if that forces the notice to display anew for you? In WP CLI that would be wp option delete wp_job_manager_dismissed_notices.

This change adds the $product_slug to the `data-dismiss-notice` property to ensure different addons use different properties names.

aaronfc

Works great! 🚀

I left some comments but are mostly about naming. Once that's fixed I am happy with this being merged.

Thanks for working on this! <3

aaronfc · 2023-05-22T09:52:42Z

includes/helper/class-wp-job-manager-helper.php

+ * Helper functions used in WP Job Manager regarding addons and licences.
 *
 * @package wp-job-manager
 * @since   1.29.0
 */
 class WP_Job_Manager_Helper {
 	/**
-	 * License messages to display to the user.
+	 * Licence messages to display to the user.


I would leave this as they were (with s).

Committed d9e812b

aaronfc · 2023-05-22T09:52:58Z

includes/helper/class-wp-job-manager-helper.php

 	 */
-	public function licence_error_notices() {


Looking nice to me. Good catch, @renatho !

aaronfc · 2023-05-22T09:53:42Z

includes/helper/class-wp-job-manager-helper.php

-		) {
-			return;
-		}
+		_deprecated_function( __METHOD__, '1.33.0', 'maybe_add_license_error_notices()' );


Here you call the method 'license' but the real name you set is 'licence'.

I would go with 's' everywhere (except from the deprecated method, which obviously has to be kept like it was before).

Committed d9e812b

aaronfc · 2023-05-22T09:54:21Z

includes/helper/class-wp-job-manager-helper.php

-			return;
-		}
+		_deprecated_function( __METHOD__, '1.33.0', 'maybe_add_license_error_notices()' );
+		$this->maybe_add_license_error_notices();


I think there is a typo here. The method is actually called "licence" (but I think you should rename it to "license").

aaronfc · 2023-05-22T09:58:35Z

includes/helper/class-wp-job-manager-helper.php

-					include 'views/html-licence-key-error.php';
+					add_filter(
+						'wpjm_admin_notices',
+						function ( $notices ) use ( $product_slug, $plugin_data ) {


Mmm good call!

I am fine with using an anonymous function here. The idea to not use an anonymous function is to be able to "unhook" it programatically. But in this case we can always "hook" later and remove the notice_id that we want to remove.

I can think of alternative ways like storing in a private attribute the data needed or something like that, but I don't like it. Good to go with the anonymous function 🚀

aaronfc · 2023-05-22T09:59:08Z

includes/helper/class-wp-job-manager-helper.php

+	 * @param array  $plugin_data The plugin data.
+	 * @return array
+	 */
+	public function add_missing_licence_notice( $notices, $product_slug, $plugin_data ) {


this can be private, right?

aaronfc · 2023-05-22T09:59:19Z

includes/helper/class-wp-job-manager-helper.php

+	 * @param array  $plugin_data The plugin data.
+	 * @return array
+	 */
+	public function add_error_licence_notice( $notices, $product_slug, $plugin_data ) {


same here, can be private :)

aaronfc · 2023-05-22T10:04:02Z

includes/helper/class-wp-job-manager-helper.php

+				esc_html( $plugin_data['Name'] )
+			),
+		];
+		$notices[ 'wpjm_licence_notice_' . $product_slug ] = $notice;


I would add here "missing" to the license notice ID. Also, since the dismissing mechanism is different I think we can rename it freely (and also name it "license" with an S).

Final name: 'wpjm_missing_license_notice_' . $product_slug

Committed (for here and above) ea758b0

Updates the new methods, and a string, to use the preferred `s` spelling, rathern than the `c` spelling

- Make our two new helper methods private rather than public - Change the missing-license notice attribute to `wpjm_missing_license_notice_`

aaronfc

Looks good, works well! 🚀

anaemnesis self-assigned this Apr 21, 2023

anaemnesis added 2 commits May 2, 2023 15:13

anaemnesis commented May 4, 2023

View reviewed changes

anaemnesis marked this pull request as ready for review May 4, 2023 11:00

anaemnesis requested review from aaronfc and a team May 4, 2023 11:00

Base automatically changed from feature/reengaging-customers to trunk May 5, 2023 05:52

anaemnesis linked an issue May 5, 2023 that may be closed by this pull request

Revamp unlicensed notices design. #2378

Closed

renatho reviewed May 5, 2023

View reviewed changes

anaemnesis added 4 commits May 11, 2023 11:48

Alter notice padding to prevent conflicts

b63ae05

This sets the padding on the wpjm-admin-notice class to use the explicit top/right/bottom/left values. This way, the top and bottom styling can be overriden while the left/right are left alone.

Merge remote-tracking branch 'origin/trunk' into add/update-legacy-no…

9156091

…tice-styling

Licence and license

2240756

- Make sure 'License' follows not the UK standard

anaemnesis commented May 17, 2023

View reviewed changes

anaemnesis requested a review from renatho May 17, 2023 19:06

anaemnesis added 4 commits May 17, 2023 20:08

Merge branch 'trunk' into add/update-legacy-notice-styling

7fabac5

Fix 'licenced' leftover that was causing fatal

8548810

Merge remote-tracking branch 'origin/add/update-legacy-notice-styling…

5c44b89

…' into add/update-legacy-notice-styling

Fix spelling again

f66f610

I should have just reverted the commit that updated the spelling of licence, but this also fixes it. Lesson learned.

renatho reviewed May 18, 2023

View reviewed changes

anaemnesis added 3 commits May 18, 2023 17:40

Hard reset and re-apply

450d0c5

This commit hard-resets to `trunk`, and then selectively applies the changes we want. Too much had crept in with the wording errancy.

Merge remote-tracking branch 'origin/add/update-legacy-notice-styling…

8755fa3

…' into add/update-legacy-notice-styling # Conflicts: # includes/helper/class-wp-job-manager-helper.php

Fix test spelling

aeba146

Deprecate license_error_notices()

ed89a13

- This change deprecates the `licence_error_notices()` method and calls inside it, the `maybe_add_licens_error_notices()` method. Added for compatibility in case anyone was using the method as it was.

anaemnesis requested a review from renatho May 20, 2023 20:09

Prefix notice with addon slug

c6362b6

This change adds the $product_slug to the `data-dismiss-notice` property to ensure different addons use different properties names.

aaronfc approved these changes May 22, 2023

View reviewed changes

anaemnesis added 3 commits May 22, 2023 11:15

Settle on s spelling

d9e812b

Updates the new methods, and a string, to use the preferred `s` spelling, rathern than the `c` spelling

Private rather than public class

ea758b0

- Make our two new helper methods private rather than public - Change the missing-license notice attribute to `wpjm_missing_license_notice_`

Andother 'c' to 's' update

1e830e4

aaronfc approved these changes May 22, 2023

View reviewed changes

anaemnesis merged commit 80642b3 into trunk May 22, 2023

anaemnesis deleted the add/update-legacy-notice-styling branch May 22, 2023 11:10

anaemnesis mentioned this pull request May 23, 2023

Update notice string from 'c' to 's' license spelling #2429

Merged

yscik added this to the 1.41.0 milestone Jun 14, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update historical notices to use the new `render_notice` method. #2409

Update historical notices to use the new `render_notice` method. #2409

anaemnesis commented Apr 21, 2023 •

edited

Loading

anaemnesis May 4, 2023

renatho May 5, 2023

anaemnesis May 11, 2023

anaemnesis commented May 5, 2023

renatho left a comment •

edited

Loading

renatho May 5, 2023

renatho May 5, 2023

anaemnesis May 19, 2023

anaemnesis May 17, 2023

anaemnesis May 17, 2023

aaronfc May 22, 2023

anaemnesis commented May 17, 2023 •

edited

Loading

renatho left a comment

renatho May 18, 2023

anaemnesis May 18, 2023

anaemnesis May 20, 2023

aaronfc May 22, 2023

renatho May 22, 2023

anaemnesis commented May 18, 2023

anaemnesis commented May 20, 2023

aaronfc left a comment

aaronfc May 22, 2023

anaemnesis May 22, 2023

aaronfc May 22, 2023

aaronfc May 22, 2023

anaemnesis May 22, 2023

aaronfc May 22, 2023

aaronfc May 22, 2023

aaronfc May 22, 2023

aaronfc May 22, 2023

aaronfc May 22, 2023

anaemnesis May 22, 2023

aaronfc left a comment

	if ( empty( $licence['licence_key'] ) ) {
	add_filter(
	'wpjm_admin_notices',
	function ( $notices ) use ( $product_slug, $plugin_data ) {
	return $this->add_missing_licence_notice( $notices, $product_slug, $plugin_data );
	}
	);
	} elseif ( ! empty( $licence['errors'] ) ) {

Update historical notices to use the new render_notice method. #2409

Update historical notices to use the new render_notice method. #2409

Conversation

anaemnesis commented Apr 21, 2023 • edited Loading

Changes proposed in this Pull Request

Testing instructions

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anaemnesis commented May 5, 2023

renatho left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anaemnesis commented May 17, 2023 • edited Loading

renatho left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anaemnesis commented May 18, 2023

anaemnesis commented May 20, 2023

aaronfc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aaronfc left a comment

Choose a reason for hiding this comment

Update historical notices to use the new `render_notice` method. #2409

Update historical notices to use the new `render_notice` method. #2409

anaemnesis commented Apr 21, 2023 •

edited

Loading

renatho left a comment •

edited

Loading

anaemnesis commented May 17, 2023 •

edited

Loading