Changeset 54946 for trunk/src/wp-includes/ms-deprecated.php

Timestamp:

12/07/2022 02:30:17 PM (22 months ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/ms-deprecated.php.

While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names.

This commit renames the $string parameter to $email_or_login in get_user_id_from_string().

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

File:

• trunk/src/wp-includes/ms-deprecated.php (modified) (1 diff)

trunk/src/wp-includes/ms-deprecated.php

@@ -335 +335 @@
  * @see get_user_by()
  *
- * @param string $string Either an email address or a login.
+ * @param string $email_or_login Either an email address or a login.
  * @return int
  */
-function get_user_id_from_string( $string ) {
+function get_user_id_from_string( $email_or_login ) {
     _deprecated_function( __FUNCTION__, '3.6.0', 'get_user_by()' );
 
-    if ( is_email( $string ) )
-        $user = get_user_by( 'email', $string );
-    elseif ( is_numeric( $string ) )
-        return $string;
+    if ( is_email( $email_or_login ) )
+        $user = get_user_by( 'email', $email_or_login );
+    elseif ( is_numeric( $email_or_login ) )
+        return $email_or_login;
     else
-        $user = get_user_by( 'login', $string );
+        $user = get_user_by( 'login', $email_or_login );
 
     if ( $user )