Rename the whitelisted to allowlisted.

Author: hCaptcha GHA

.tests/php/integration/AAAMainTest.php

@@ -153,15 +153,14 @@ public function test_init_on_cron(): void {
 	 *
 	 * @param boolean        $logged_in                   User is logged in.
 	 * @param string         $hcaptcha_off_when_logged_in Option 'hcaptcha_off_when_logged_in' is set.
-	 * @param boolean|string $whitelisted                 Whether IP is whitelisted.
+	 * @param boolean|string $allowlisted                 Whether IP is allowlisted.
 	 * @param boolean        $hcaptcha_active             Plugin should be active.
 	 *
 	 * @dataProvider dp_test_init
 	 * @throws ReflectionException ReflectionException.
 	 * @noinspection PhpUnitTestsInspection
-	 * @noinspection UnusedFunctionResultInspection
 	 */
-	public function test_init_and_init_hooks( bool $logged_in, string $hcaptcha_off_when_logged_in, $whitelisted, bool $hcaptcha_active ): void {
+	public function test_init_and_init_hooks( bool $logged_in, string $hcaptcha_off_when_logged_in, $allowlisted, bool $hcaptcha_active ): void {
 		global $current_user;
 
 		$hcaptcha = hcaptcha();
@@ -180,8 +179,8 @@ public function test_init_and_init_hooks( bool $logged_in, string $hcaptcha_off_
 
 		add_filter(
 			'hcap_whitelist_ip',
-			static function () use ( $whitelisted ) {
-				return $whitelisted;
+			static function () use ( $allowlisted ) {
+				return $allowlisted;
 			}
 		);
 
@@ -223,7 +222,7 @@ static function () use ( $whitelisted ) {
 			-PHP_INT_MAX,
 			has_filter(
 				'hcap_whitelist_ip',
-				[ $subject, 'whitelist_ip' ]
+				[ $subject, 'allowlist_ip' ]
 			)
 		);
 
@@ -253,14 +252,14 @@ static function () use ( $whitelisted ) {
 	 */
 	public function dp_test_init(): array {
 		return [
-			'not logged in, not set, not whitelisted' => [ false, 'off', false, true ],
-			'not logged in, set, not whitelisted'     => [ false, 'on', false, true ],
-			'logged in, not set, not whitelisted'     => [ true, 'off', false, true ],
-			'logged in, set, not whitelisted'         => [ true, 'on', false, false ],
-			'not logged in, not set, whitelisted'     => [ false, 'off', true, false ],
-			'not logged in, set, whitelisted'         => [ false, 'on', true, false ],
-			'logged in, not set, whitelisted'         => [ true, 'off', true, false ],
-			'logged in, set, whitelisted'             => [ true, 'on', true, false ],
+			'not logged in, not set, not allowlisted' => [ false, 'off', false, true ],
+			'not logged in, set, not allowlisted'     => [ false, 'on', false, true ],
+			'logged in, not set, not allowlisted'     => [ true, 'off', false, true ],
+			'logged in, set, not allowlisted'         => [ true, 'on', false, false ],
+			'not logged in, not set, allowlisted'     => [ false, 'off', true, false ],
+			'not logged in, set, allowlisted'         => [ false, 'on', true, false ],
+			'logged in, not set, allowlisted'         => [ true, 'off', true, false ],
+			'logged in, set, allowlisted'             => [ true, 'on', true, false ],
 		];
 	}
 
@@ -320,7 +319,7 @@ static function () {
 			-PHP_INT_MAX,
 			has_filter(
 				'hcap_whitelist_ip',
-				[ $subject, 'whitelist_ip' ]
+				[ $subject, 'allowlist_ip' ]
 			)
 		);
 
@@ -1085,31 +1084,31 @@ public function dp_test_print_footer_scripts(): array {
 	}
 
 	/**
-	 * Test whitelist_ip().
+	 * Test allowlist_ip().
 	 *
-	 * @param mixed        $whitelisted_ips Settings.
+	 * @param mixed        $allowlisted_ips Settings.
 	 * @param string|false $client_ip       Client IP.
 	 * @param bool         $expected        Expected result.
 	 *
-	 * @dataProvider dp_test_whitelist_ip
+	 * @dataProvider dp_test_allowlist_ip
 	 * @return void
 	 */
-	public function test_whitelist_ip( $whitelisted_ips, $client_ip, bool $expected ): void {
-		update_option( 'hcaptcha_settings', [ 'whitelisted_ips' => $whitelisted_ips ] );
+	public function test_allowlist_ip( $allowlisted_ips, $client_ip, bool $expected ): void {
+		update_option( 'hcaptcha_settings', [ 'whitelisted_ips' => $allowlisted_ips ] );
 
 		$subject = new Main();
 
 		$subject->init_hooks();
 
-		self::assertSame( $expected, $subject->whitelist_ip( false, $client_ip ) );
+		self::assertSame( $expected, $subject->allowlist_ip( false, $client_ip ) );
 	}
 
 	/**
-	 * Data provider for test_whitelist_ip().
+	 * Data provider for test_allowlist_ip().
 	 *
 	 * @return array
 	 */
-	public function dp_test_whitelist_ip(): array {
+	public function dp_test_allowlist_ip(): array {
 		return [
 			'no settings, local ip'       => [ '', false, false ],
 			'some ips, local ip'          => [ " 4444444.777.2 \r\n 220.45.45.1 \r\n", false, false ],

.tests/php/unit/HCaptchaTestCase.php

@@ -685,7 +685,7 @@ protected function get_test_general_form_fields(): array {
 				'helper'  => 'Avoid specifying errors like "invalid username" or "invalid password" to limit information exposure to attackers.',
 			],
 			'whitelisted_ips'          => [
-				'label'   => 'Whitelisted IPs',
+				'label'   => 'Allowlisted IPs',
 				'type'    => 'textarea',
 				'section' => General::SECTION_OTHER,
 				'helper'  => 'Do not show hCaptcha for listed IP addresses. Please specify one IP address per line.',

.tests/php/unit/Settings/SystemInfoTest.php

@@ -303,7 +303,7 @@ public function test_get_system_info(): void {
 Backend:                              
 Turn Off When Logged In:              Off
 Disable reCAPTCHA Compatibility:      Off
-Whitelisted IPs:                      Not set
+Allowlisted IPs:                      Not set
 Login attempts before hCaptcha:       
 Failed login attempts interval, min:  
 Delay showing hCaptcha, ms:           

src/php/Main.php

@@ -189,7 +189,7 @@ public function init_hooks(): void {
 		$this->load( Events::class );
 
 		add_action( 'plugins_loaded', [ $this, 'load_modules' ], self::LOAD_PRIORITY + 1 );
-		add_filter( 'hcap_whitelist_ip', [ $this, 'whitelist_ip' ], -PHP_INT_MAX, 2 );
+		add_filter( 'hcap_whitelist_ip', [ $this, 'allowlist_ip' ], -PHP_INT_MAX, 2 );
 		add_action( 'before_woocommerce_init', [ $this, 'declare_wc_compatibility' ] );
 
 		$this->active = $this->activate_hcaptcha();
@@ -259,7 +259,7 @@ private function activate_hcaptcha(): bool {
 			/**
 			 * Filters the user IP to check whether it is allowlisted.
 			 *
-			 * @param bool         $whitelisted IP is allowlisted.
+			 * @param bool         $allowlisted IP is allowlisted.
 			 * @param string|false $ip          IP string or false for local addresses.
 			 */
 			apply_filters( 'hcap_whitelist_ip', false, hcap_get_user_ip() ) ||
@@ -764,12 +764,12 @@ public function declare_wc_compatibility(): void {
 	 * Filter user IP to check if it is allowlisted.
 	 * For allowlisted IPs, hCaptcha will not be shown.
 	 *
-	 * @param bool|mixed   $whitelisted Whether IP is allowlisted.
+	 * @param bool|mixed   $allowlisted Whether IP is allowlisted.
 	 * @param string|false $client_ip   Client IP.
 	 *
 	 * @return bool|mixed
 	 */
-	public function whitelist_ip( $whitelisted, $client_ip ) {
+	public function allowlist_ip( $allowlisted, $client_ip ) {
 		$ips = explode(
 			"\n",
 			$this->settings()->get( 'whitelisted_ips' )
@@ -804,7 +804,7 @@ static function ( $ip ) {
 			return true;
 		}
 
-		return $whitelisted;
+		return $allowlisted;
 	}
 
 	/**

src/php/Settings/General.php

@@ -534,7 +534,7 @@ public function init_form_fields(): void {
 				'helper'  => __( 'On multisite, use same settings for all sites of the network.', 'hcaptcha-for-forms-and-more' ),
 			],
 			'whitelisted_ips'      => [
-				'label'   => __( 'Whitelisted IPs', 'hcaptcha-for-forms-and-more' ),
+				'label'   => __( 'Allowlisted IPs', 'hcaptcha-for-forms-and-more' ),
 				'type'    => 'textarea',
 				'section' => self::SECTION_OTHER,
 				'helper'  => __( 'Do not show hCaptcha for listed IP addresses. Please specify one IP address per line.', 'hcaptcha-for-forms-and-more' ),

src/php/Settings/SystemInfo.php

@@ -186,7 +186,7 @@ private function hcaptcha_info(): string {
 		// Other section.
 		$data .= $this->data( 'Turn Off When Logged In', $this->is_on( 'off_when_logged_in' ) );
 		$data .= $this->data( 'Disable reCAPTCHA Compatibility', $this->is_on( 'recaptcha_compat_off' ) );
-		$data .= $this->data( 'Whitelisted IPs', $this->is_empty( $settings->get( 'whitelisted_ips' ) ) );
+		$data .= $this->data( 'Allowlisted IPs', $this->is_empty( $settings->get( 'whitelisted_ips' ) ) );
 		$data .= $this->data( 'Login attempts before hCaptcha', $settings->get( 'login_limit' ) );
 		$data .= $this->data( 'Failed login attempts interval, min', $settings->get( 'login_interval' ) );
 		$data .= $this->data( 'Delay showing hCaptcha, ms', $settings->get( 'delay' ) );