Changeset 36311

Timestamp:

01/15/2016 10:15:21 AM (9 years ago)

Author:

swissspidy

Message:

Users: Deprecate the get_currentuserinfo() pluggable function.

It encourages an ugly pattern like global $userdata; get_currentuserinfo(); in plugins/themes. wp_get_current_user() should be used instead, e.g. $current_user = wp_get_current_user();.

Props scribu for initial patch.
Fixes #19615.

Location:

trunk

Files:

• src/wp-includes/pluggable-deprecated.php (modified) (1 diff)
• src/wp-includes/pluggable.php (modified) (3 diffs)
• tests/phpunit/tests/pluggable.php (modified) (1 diff)

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

@@ -33 +33 @@
     _deprecated_function( __FUNCTION__, '3.0', 'wp_set_current_user()' );
     return wp_set_current_user($id, $name);
+}
+endif;
+
+if ( !function_exists('get_currentuserinfo') ) :
+/**
+ * Populate global variables with information about the currently logged in user.
+ *
+ * @since 0.71
+ * @deprecated 4.5.0 Use wp_get_current_user()
+ * @see wp_get_current_user()
+ *
+ * @return bool|WP_User False on XMLRPC Request and invalid auth cookie, WP_User instance otherwise.
+ */
+function get_currentuserinfo() {
+    _deprecated_function( __FUNCTION__, '4.5', 'wp_get_current_user()' );
+
+    return wp_get_current_user();
 }
 endif;

trunk/src/wp-includes/pluggable.php

@@ -55 +55 @@
  * Retrieve the current user object.
  *
- * @since 2.0.3
- *
- * @global WP_User $current_user
- *
- * @return WP_User Current user WP_User object
- */
-function wp_get_current_user() {
-    global $current_user;
-
-    get_currentuserinfo();
-
-    return $current_user;
-}
-endif;
-
-if ( !function_exists('get_currentuserinfo') ) :
-/**
- * Populate global variables with information about the currently logged in user.
- *
  * Will set the current user, if the current user is not set. The current user
  * will be set to the logged-in person. If no user is logged-in, then it will
  * set the current user to 0, which is invalid and won't have any permissions.
  *
- * @since 0.71
- *
- * @global WP_User $current_user Checks if the current user is set
- *
- * @return false|void False on XML-RPC Request and invalid auth cookie.
- */
-function get_currentuserinfo() {
+ * @since 2.0.3
+ *
+ * @global WP_User $current_user Checks if the current user is set.
+ *
+ * @return bool|WP_User WP_User instance on success, false on XMLRPC Request and invalid auth cookie.
+ */
+function wp_get_current_user() {
     global $current_user;
 
     if ( ! empty( $current_user ) ) {
-        if ( $current_user instanceof WP_User )
-            return;
+        if ( $current_user instanceof WP_User ) {
+            return $current_user;
+        }
 
         // Upgrade stdClass to WP_User
@@ -96 +78 @@
             $current_user = null;
             wp_set_current_user( $cur_id );
-            return;
+            return $current_user;
         }
 
@@ -130 +112 @@
 
     wp_set_current_user( $user_id );
+
+    return $current_user;
 }
 endif;

trunk/tests/phpunit/tests/pluggable.php

@@ -128 +128 @@
             'wp_set_current_user'             => array( 'id', 'name' => '' ),
             'wp_get_current_user'             => array(),
-            'get_currentuserinfo'             => array(),
             'get_userdata'                    => array( 'user_id' ),
             'get_user_by'                     => array( 'field', 'value' ),