Changeset 59312

Timestamp:

10/28/2024 08:03:13 PM (3 months ago)

Author:

SergeyBiryukov

Message:

Users: Set correct default value for $user_login in retrieve_password().

This resolves a "passing null to non-nullable" deprecation notice on PHP 8.1+:

Deprecated: trim(): Passing null to parameter #1 ($string) of type string is deprecated

Follow-up to [50129], [54477].

Props afragen, peterwilsoncc, SergeyBiryukov.
Fixes #62298.

Location:

trunk

Files:

• src/wp-includes/user.php (modified) (1 diff)
• tests/phpunit/tests/user/retrievePassword.php (modified) (1 diff)

trunk/src/wp-includes/user.php

@@ -3107 +3107 @@
  * @return true|WP_Error True when finished, WP_Error object on error.
  */
-function retrieve_password( $user_login = null ) {
+function retrieve_password( $user_login = '' ) {
     $errors    = new WP_Error();
     $user_data = false;

trunk/tests/phpunit/tests/user/retrievePassword.php

@@ -75 +75 @@
         $this->assertTrue( retrieve_password( 'bar@example.com' ), 'Fetching user by email failed.' );
     }
+
+    /**
+     * Tests that PHP 8.1 "passing null to non-nullable" deprecation notice
+     * is not thrown when the `$user_login` parameter is empty.
+     *
+     * The notice that we should not see:
+     * `Deprecated: trim(): Passing null to parameter #1 ($string) of type string is deprecated`.
+     *
+     * @ticket 62298
+     */
+    public function test_retrieve_password_does_not_throw_deprecation_notice_with_default_parameters() {
+        $this->assertWPError( retrieve_password() );
+    }
 }