Deprecating wp-admin settings-related methods + classes #445

joshcanhelp · 2018-04-23T17:36:16Z

WP_Auth0_Admin::cant_connect_to_auth0()
WP_Auth0_Admin_Advanced::ADVANCED_DESCRIPTION
WP_Auth0_Admin_Advanced::render_passwordless_enabled()
WP_Auth0_Admin_Advanced::render_passwordless_method()
WP_Auth0_Admin_Advanced::connections_validation()
WP_Auth0_Admin_Appearance::APPEARANCE_DESCRIPTION
WP_Auth0_Admin_Appearance::render_appearance_description()
WP_Auth0_Admin_Basic::BASIC_DESCRIPTION
WP_Auth0_Admin_Basic::render_allow_signup_regular_multisite()
WP_Auth0_Admin_Basic::render_allow_signup_regular()
WP_Auth0_Admin_Basic::render_basic_description()
WP_Auth0_Admin_Dashboard class
WP_Auth0_Admin_Features::FEATURES_DESCRIPTION
WP_Auth0_Admin_Features::render_features_description()
WP_Auth0_Admin_Generic::render_a0_switch()
WP_Auth0_Dashboard_Plugins_Age class
WP_Auth0_Dashboard_Plugins_Gender class
WP_Auth0_Dashboard_Plugins_Generic class
WP_Auth0_Dashboard_Plugins_IdP class
WP_Auth0_Dashboard_Plugins_Income class
WP_Auth0_Dashboard_Plugins_Location class
WP_Auth0_Dashboard_Plugins_Signups class
WP_Auth0_Dashboard_Widgets class
WP_Auth0_InitialSetup::notify_setup()

lbalmaceda

I think we have different concepts over "deprecation". A deprecated method/constant should still work as expected. If it is being deprecated, it means that a better alternative should be used instead. But that doesn't mean that the method will have it's logic removed or its value changed to an empty string. Let's discuss this internally Josh.

lbalmaceda · 2018-04-24T20:42:01Z

lib/admin/WP_Auth0_Admin.php

@@ -248,9 +248,12 @@ public function admin_enqueue() {
 		wp_enqueue_style( 'media' );
 	}

-	// TODO: Deprecate, not used
+	/**
+	 * @deprecated 3.6.0 - Handled empty auth0_app_token notification, not needed


"not needed" sounds like an internal note. If this is user facing I'd use "This method is no longer required since..".

lbalmaceda · 2018-04-24T20:50:20Z

lib/admin/WP_Auth0_Admin_Advanced.php

 	}

-	// TODO: Deprecate
+	/**
+	 * @deprecated 3.6.0 - Passwordless method is determined by tenant or Connections setting


Passwordless method should be first enabled on Connections and then enabled for each Application. No tenants involved AFAIK.

Passwordless method should be first enabled on Connections

Passwordless methods are connections:

https://manage.auth0.com/#/connections/passwordless

Still, wording could be improved

lbalmaceda · 2018-04-24T20:50:43Z

lib/admin/WP_Auth0_Admin_Advanced.php

@@ -618,50 +588,12 @@ public function link_accounts_validation( $old_options, $input ) {
 		return $this->rule_validation( $old_options, $input, 'link_auth0_users', WP_Auth0_RulesLib::$link_accounts['name'] . '-' . get_auth0_curatedBlogName(), $link_script );
 	}

-	// TODO: Deprecate
+	/**
+	 * @deprecated 3.6.0 - The setting this validated, passwordless_method, has been removed


The setting this validated

typo?

@lbalmaceda -No but maybe poorly worded. This validated the passwordless_method setting but the setting is being removed so the validation is going as well.

lbalmaceda · 2018-04-24T20:52:02Z

lib/dashboard-widgets/WP_Auth0_Dashboard_Plugins_Age.php

+/**
+ * Class WP_Auth0_Dashboard_Plugins_Age
+ *
+ * @deprecated 3.6.0 - Not supporting dashboard widgets


do you mean you no longer support dashboard widgets? In that case, I'd rephrase every mention of this to:

"Since x.y.z this library no longer supports dashboard widgets"

joshcanhelp · 2018-04-25T21:02:23Z

lib/admin/WP_Auth0_Admin_Advanced.php

 	public function render_auth0_server_domain( $args = array() ) {
 		$this->render_text_field( $args['label_for'], $args['opt_name'] );
 		$this->render_field_description(
 			__( 'The Auth0 domain used by the setup wizard to fetch your account information', 'wp-auth0' )
 		);
 	}

-	public function render_metrics() {


Moved down, removed HTML, added deprecation docblock

joshcanhelp · 2018-04-25T21:02:29Z

lib/admin/WP_Auth0_Admin_Advanced.php

 	public function render_jwt_auth_integration( $args = array() ) {
 		$this->render_switch( $args['label_for'], $args['opt_name'] );
 		$this->render_field_description( __( 'This will enable the JWT Auth Users Repository override', 'wp-auth0' ) );
 	}

-	// TODO: Deprecate, moved to WP_Auth0_Admin_features
-	public function render_passwordless_enabled( $args = array() ) {


Moved down, added deprecation docblock

joshcanhelp · 2018-04-25T21:02:33Z

lib/admin/WP_Auth0_Admin_Advanced.php

-	}
-
-	// TODO: Deprecate
-	public function render_passwordless_method() {


Moved down, removed HTML, added deprecation docblock

joshcanhelp · 2018-04-25T21:02:38Z

lib/admin/WP_Auth0_Admin_Advanced.php

-	}
-
-	// TODO: Deprecate
-	public function render_advanced_description() {


Moved down, added deprecation docblock

joshcanhelp · 2018-04-25T21:03:18Z

lib/admin/WP_Auth0_Admin_Advanced.php

@@ -618,53 +774,6 @@ public function link_accounts_validation( $old_options, $input ) {
 		return $this->rule_validation( $old_options, $input, 'link_auth0_users', WP_Auth0_RulesLib::$link_accounts['name'] . '-' . get_auth0_curatedBlogName(), $link_script );
 	}

-	// TODO: Deprecate
-	public function connections_validation( $old_options, $input ) {


Moved down, removed validation, added deprecation docblock

joshcanhelp · 2018-04-25T21:04:41Z

lib/admin/WP_Auth0_Admin_Appearance.php

@@ -175,15 +267,6 @@ public function render_language_dictionary( $args = array() ) {
 		);
 	}

-	// TODO: Deprecate
-	public function render_appearance_description() {


Moved down, added deprecation docblock

joshcanhelp · 2018-04-25T21:05:08Z

lib/admin/WP_Auth0_Admin_Basic.php

@@ -179,66 +268,6 @@ public function render_allow_signup() {
 		);
 	}

-	public function render_allow_wordpress_login( $args = array() ) {


Moved down, added regular docblock

joshcanhelp · 2018-04-25T21:05:22Z

lib/admin/WP_Auth0_Admin_Basic.php

-	}
-
-	// TODO: Deprecate
-	public function render_allow_signup_regular_multisite() {


Moved down, removed output, added deprecation docblock

joshcanhelp · 2018-04-25T21:05:26Z

lib/admin/WP_Auth0_Admin_Basic.php

-	}
-
-	// TODO: Deprecate
-	public function render_allow_signup_regular() {


Moved down, removed output, added deprecation docblock

joshcanhelp · 2018-04-25T21:05:38Z

lib/admin/WP_Auth0_Admin_Features.php

 	public function render_override_wp_avatars( $args = array() ) {
 		$this->render_switch( $args['label_for'], $args['opt_name'] );
 		$this->render_field_description(
 			__( 'Overrides the WordPress avatar with the Auth0 profile avatar', 'wp-auth0' )
 		);
 	}

-	// TODO: Deprecate
-	public function render_features_description() {


Moved down, added deprecation docblock

joshcanhelp · 2018-04-25T21:05:49Z

lib/admin/WP_Auth0_Admin_Generic.php

@@ -115,18 +115,6 @@ protected function rule_validation( $old_options, $input, $key, $rule_name, $rul
 		return $input;
 	}

-	// TODO: Deprecate
-	protected function render_a0_switch( $id, $name, $value, $checked ) {


Moved down, added deprecation docblock

- WP_Auth0_Admin::cant_connect_to_auth0() - WP_Auth0_Admin_Advanced::ADVANCED_DESCRIPTION - WP_Auth0_Admin_Advanced::render_passwordless_enabled() - WP_Auth0_Admin_Advanced::render_passwordless_method() - WP_Auth0_Admin_Advanced::connections_validation() - WP_Auth0_Admin_Appearance::APPEARANCE_DESCRIPTION - WP_Auth0_Admin_Appearance::render_appearance_description() - WP_Auth0_Admin_Basic::BASIC_DESCRIPTION - WP_Auth0_Admin_Basic::render_allow_signup_regular_multisite() - WP_Auth0_Admin_Basic::render_allow_signup_regular() - WP_Auth0_Admin_Basic::render_basic_description() - WP_Auth0_Admin_Dashboard class - WP_Auth0_Admin_Features::FEATURES_DESCRIPTION - WP_Auth0_Admin_Features::render_features_description() - WP_Auth0_Admin_Generic::render_a0_switch() - WP_Auth0_Dashboard_Plugins_Age class - WP_Auth0_Dashboard_Plugins_Gender class - WP_Auth0_Dashboard_Plugins_Generic class - WP_Auth0_Dashboard_Plugins_IdP class - WP_Auth0_Dashboard_Plugins_Income class - WP_Auth0_Dashboard_Plugins_Location class - WP_Auth0_Dashboard_Plugins_Signups class - WP_Auth0_Dashboard_Widgets class - WP_Auth0_InitialSetup::notify_setup()

lbalmaceda

LGTM 🎉

joshcanhelp added CH: Deprecated labels Apr 23, 2018

joshcanhelp added this to the v3-Next milestone Apr 23, 2018

lbalmaceda reviewed Apr 24, 2018

View reviewed changes

joshcanhelp force-pushed the deprecate-settings-methods-classes branch from 877ca6a to 9efbddf Compare April 24, 2018 23:00

joshcanhelp commented Apr 25, 2018

View reviewed changes

joshcanhelp force-pushed the deprecate-settings-methods-classes branch from 8271475 to 9292f4d Compare April 25, 2018 21:34

joshcanhelp added 3 commits April 25, 2018 15:47

Better class deprecation error messages

90159ae

Docblocks and moving methods

caa2d28

joshcanhelp force-pushed the deprecate-settings-methods-classes branch from 9292f4d to caa2d28 Compare April 25, 2018 22:47

lbalmaceda self-requested a review May 2, 2018 21:47

lbalmaceda approved these changes May 2, 2018

View reviewed changes

joshcanhelp removed the Ready for Review label May 2, 2018

joshcanhelp merged commit b605b53 into dev May 2, 2018

joshcanhelp deleted the deprecate-settings-methods-classes branch May 2, 2018 22:03

joshcanhelp mentioned this pull request Jun 5, 2018

Release 3.6.0 #475

Merged

github-actions bot locked as resolved and limited conversation to collaborators Sep 19, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecating wp-admin settings-related methods + classes #445

Deprecating wp-admin settings-related methods + classes #445

joshcanhelp commented Apr 23, 2018

lbalmaceda left a comment

lbalmaceda Apr 24, 2018

lbalmaceda Apr 24, 2018

joshcanhelp Apr 24, 2018

lbalmaceda Apr 24, 2018

joshcanhelp Apr 24, 2018

lbalmaceda Apr 24, 2018

joshcanhelp Apr 25, 2018 •

edited

Loading

joshcanhelp Apr 25, 2018

joshcanhelp Apr 25, 2018 •

edited

Loading

joshcanhelp Apr 25, 2018

joshcanhelp Apr 25, 2018

joshcanhelp Apr 25, 2018

joshcanhelp Apr 25, 2018

joshcanhelp Apr 25, 2018

joshcanhelp Apr 25, 2018

joshcanhelp Apr 25, 2018

joshcanhelp Apr 25, 2018

lbalmaceda left a comment

Deprecating wp-admin settings-related methods + classes #445

Deprecating wp-admin settings-related methods + classes #445

Conversation

joshcanhelp commented Apr 23, 2018

lbalmaceda 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

joshcanhelp Apr 25, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshcanhelp Apr 25, 2018 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lbalmaceda left a comment

Choose a reason for hiding this comment

joshcanhelp Apr 25, 2018 •

edited

Loading

joshcanhelp Apr 25, 2018 •

edited

Loading