| get_label() ); ?> |
@@ -1880,32 +1945,22 @@ public static function user_two_factor_options( $user ) {
-
ID}", '_nonce_user_security_keys' );
$new_key = false;
diff --git a/providers/class-two-factor-provider.php b/providers/class-two-factor-provider.php
index 0e82dd67..b780c4a7 100644
--- a/providers/class-two-factor-provider.php
+++ b/providers/class-two-factor-provider.php
@@ -123,6 +123,19 @@ abstract public function validate_authentication( $user );
*/
abstract public function is_available_for_user( $user );
+ /**
+ * If this provider should be available for the user.
+ *
+ * @param WP_User|int $user WP_User object, user ID or null to resolve the current user.
+ *
+ * @return bool
+ */
+ public static function is_supported_for_user( $user = null ) {
+ $providers = Two_Factor_Core::get_supported_providers_for_user( $user );
+
+ return isset( $providers[ static::class ] );
+ }
+
/**
* Generate a random eight-digit string to send out as an auth code.
*
diff --git a/readme.txt b/readme.txt
index da5700e7..53957dee 100644
--- a/readme.txt
+++ b/readme.txt
@@ -25,6 +25,7 @@ For more history, see [this post](https://georgestephanis.wordpress.com/2013/08/
Here is a list of action and filter hooks provided by the plugin:
- `two_factor_providers` filter overrides the available two-factor providers such as email and time-based one-time passwords. Array values are PHP classnames of the two-factor providers.
+- `two_factor_providers_for_user` filter overrides the available two-factor providers for a specific user. Array values are instances of provider classes and the user object `WP_User` is available as the second argument.
- `two_factor_enabled_providers_for_user` filter overrides the list of two-factor providers enabled for a user. First argument is an array of enabled provider classnames as values, the second argument is the user ID.
- `two_factor_user_authenticated` action which receives the logged in `WP_User` object as the first argument for determining the logged in user right after the authentication workflow.
- `two_factor_email_token_ttl` filter overrides the time interval in seconds that an email token is considered after generation. Accepts the time in seconds as the first argument and the ID of the `WP_User` object being authenticated.
diff --git a/tests/class-two-factor-core.php b/tests/class-two-factor-core.php
index 992ddc60..0a114b26 100644
--- a/tests/class-two-factor-core.php
+++ b/tests/class-two-factor-core.php
@@ -1556,6 +1556,63 @@ public function test_all_sessions_destroyed_when_enabling_2fa_by_admin() {
$this->assertCount( 1, $admin_session_manager->get_all(), 'No admin sessions are present first' );
}
+ public function test_can_filter_registered_providers_for_user() {
+ $user = self::factory()->user->create_and_get();
+ $providers = Two_Factor_Core::get_providers();
+
+ $this->assertEquals(
+ $providers,
+ Two_Factor_Core::get_supported_providers_for_user( $user ),
+ 'All providers are available by default'
+ );
+
+ $this->assertTrue( $providers['Two_Factor_Email']::is_supported_for_user( $user ), 'Email provider is supported by default' );
+
+ add_filter(
+ 'two_factor_providers_for_user',
+ function( $providers, $user ) {
+ $this->assertInstanceOf( WP_User::class, $user, 'A user referenced is passed to the filter' );
+
+ return array_diff_key( $providers, array( 'Two_Factor_Email' => null ) );
+ },
+ 10,
+ 2
+ );
+
+ $this->assertNotContains(
+ 'Two_Factor_Email',
+ Two_Factor_Core::get_supported_providers_for_user( $user ),
+ 'Email provider can be disabled for a user'
+ );
+
+ $this->assertFalse( $providers['Two_Factor_Email']::is_supported_for_user( $user ), 'Email provider is disabled if not supported' );
+
+ remove_all_filters( 'two_factor_providers_for_user' );
+ }
+
+ public function test_can_disable_default_providers() {
+ $user = self::factory()->user->create_and_get();
+ $providers = Two_Factor_Core::get_providers();
+ $default_provider = current( $providers );
+
+ $this->assertContains( 'Two_Factor_Email', array_keys( $providers ), 'Email provider is enabled by default' );
+
+ $this->assertTrue( $default_provider::is_supported_for_user( $user ), 'Available provider is supported by default' );
+
+ add_filter(
+ 'two_factor_providers',
+ function ( $providers ) {
+ return array_diff_key( $providers, array( 'Two_Factor_Email' => null ) );
+ }
+ );
+
+ $this->assertNotContains( 'Two_Factor_Email', array_keys( Two_Factor_Core::get_providers() ), 'Default provider can be disabled via a filter' );
+
+ $this->assertFalse( $default_provider::is_supported_for_user( $user ), 'Disabled provider is not supported for user' );
+
+ remove_all_filters( 'two_factor_providers' );
+ }
+
/**
* Plugin uninstall removes all user meta.
*
@@ -1582,21 +1639,6 @@ public function test_uninstall_removes_user_meta() {
);
}
- public function test_can_disable_default_providers() {
- $this->assertContains( 'Two_Factor_Email', array_keys( Two_Factor_Core::get_providers() ), 'Email provider is enabled by default' );
-
- add_filter(
- 'two_factor_providers',
- function ( $providers ) {
- return array_diff_key( $providers, array( 'Two_Factor_Email' => null ) );
- }
- );
-
- $this->assertNotContains( 'Two_Factor_Email', array_keys( Two_Factor_Core::get_providers() ), 'Default provider can be disabled via a filter' );
-
- remove_all_filters( 'two_factor_providers' );
- }
-
/**
* Plugin uninstall removes all user meta even for disabled providers.
*
|