Changeset 34125

Timestamp:

09/14/2015 06:57:15 PM (11 years ago)

Author:

boonebgorges

Message:

Accept 'ID' as a valid $field in get_user_by().

We already accept 'id'. ID more closely matches the database and
WP_User schemas.

Props Shelob9.
Fixes #33869.

Location:

trunk

Files:

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

trunk/src/wp-includes/class-wp-user.php

@@ -166 +166 @@
          *
          * @since 3.3.0
+         * @since 4.4.0 Added 'ID' as an alias of 'id' for the `$field` parameter.
          *
          * @static
@@ -171 +172 @@
          * @global wpdb $wpdb
          *
-         * @param string $field The field to query against: 'id', 'slug', 'email' or 'login'
+         * @param string $field The field to query against: 'id', 'ID', 'slug', 'email' or 'login'.
          * @param string|int $value The field value
          * @return object|false Raw user object
@@ -177 +178 @@
         public static function get_data_by( $field, $value ) {
                 global $wpdb;
+
+                // 'ID' is an alias of 'id'.
+                if ( 'ID' === $field ) {
+                        $field = 'id';
+                }
 
                 if ( 'id' == $field ) {

trunk/src/wp-includes/pluggable.php

@@ -146 +146 @@
  *
  * @since 2.8.0
- *
- * @param string     $field The field to retrieve the user with. id | slug | email | login
+ * @since 4.4.0 Added 'ID' as an alias of 'id' for the `$field` parameter.
+ *
+ * @param string     $field The field to retrieve the user with. id | ID | slug | email | login.
  * @param int|string $value A value for $field. A user ID, slug, email address, or login name.
  * @return WP_User|false WP_User object on success, false on failure.

trunk/tests/phpunit/tests/user.php

@@ -444 +444 @@
                 $user = WP_User::get_data_by( 'id', 99999 );
                 $this->assertEquals( false, $user );
+        }
+
+        /**
+         * @ticket 33869
+         */
+        public function test_user_get_data_by_ID_should_alias_to_id() {
+                $u = $this->factory->user->create();
+
+                $user = WP_User::get_data_by( 'ID', $u );
+                $this->assertEquals( $u, $user->ID );
         }