Changeset 23438

Timestamp:

02/16/2013 03:02:15 AM (12 years ago)

Author:

nacin

Message:

Deprecate get_user_id_from_string() in favor of get_user_by( $field ) where $field is 'email' or 'login'. props SergeyBiryukov. fixes #23190.

Location:

trunk/wp-includes

Files:

• ms-deprecated.php (modified) (1 diff)
• ms-functions.php (modified) (3 diffs)

trunk/wp-includes/ms-deprecated.php

@@ -271 +271 @@
     return $url;
 }
+
+/**
+ * Get a numeric user ID from either an email address or a login.
+ *
+ * A numeric string is considered to be an existing user ID
+ * and is simply returned as such.
+ *
+ * @since MU
+ * @deprecated 3.6.0
+ * @deprecated Use get_user_by()
+ * @uses get_user_by()
+ *
+ * @param string $string Either an email address or a login.
+ * @return int
+ */
+function get_user_id_from_string( $string ) {
+    _deprecated_function( __FUNCTION__, '3.6', 'get_user_by()' );
+
+    if ( is_email( $string ) )
+        $user = get_user_by( 'email', $string );
+    elseif ( is_numeric( $string ) )
+        return $string;
+    else
+        $user = get_user_by( 'login', $string );
+
+    if ( $user )
+        return $user->ID;
+    return 0;
+}

trunk/wp-includes/ms-functions.php

@@ -909 +909 @@
 
     $user = new WP_User( $user_id );
-    
+
     // Newly created users have no roles or caps until they are added to a blog.
     delete_user_option( $user_id, $user->cap_key );
@@ -1315 +1315 @@
     global $current_site;
     return $current_site;
-}
-
-/**
- * Get a numeric user ID from either an email address or a login.
- *
- * @since MU
- * @uses is_email()
- *
- * @param string $string
- * @return int
- */
-function get_user_id_from_string( $string ) {
-    $user_id = 0;
-    if ( is_email( $string ) ) {
-        $user = get_user_by('email', $string);
-        if ( $user )
-            $user_id = $user->ID;
-    } elseif ( is_numeric( $string ) ) {
-        $user_id = $string;
-    } else {
-        $user = get_user_by('login', $string);
-        if ( $user )
-            $user_id = $user->ID;
-    }
-
-    return $user_id;
 }
 
@@ -1731 +1705 @@
 
 /**
- * Check to see whether a user is marked as a spammer, based on username
+ * Check to see whether a user is marked as a spammer, based on user login.
  *
  * @since MU
  * @uses get_user_by()
  *
- * @param string $username
+ * @param string $user_login Optional. Defaults to current user.
  * @return bool
  */
-function is_user_spammy( $username = 0 ) {
-    if ( $username == 0 ) {
+function is_user_spammy( $user_login = null ) {
+    if ( $user_login )
+        $user = get_user_by( 'login', $user_login );
+    else
         $user = wp_get_current_user();
-    } else {
-        $user = get_user_by( 'login', $username );
-    }
-
-    return ( isset( $user->spam ) && $user->spam == 1 );
+
+    return $user && isset( $user->spam ) && 1 == $user->spam;
 }