Changeset 51399 for trunk

Timestamp:

07/10/2021 12:20:55 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Rename the $ID variable to $user_id in wp_insert_user() and wp_update_user().

This fixes a "Variable $ID is not in valid snake_case format" WPCS warning.

Follow-up to [2872].

See #53359.

File:

• trunk/src/wp-includes/user.php (modified) (9 diffs)

trunk/src/wp-includes/user.php

@@ -1774 +1774 @@
     // Are we updating or creating?
     if ( ! empty( $userdata['ID'] ) ) {
-        $ID            = (int) $userdata['ID'];
+        $user_id       = (int) $userdata['ID'];
         $update        = true;
-        $old_user_data = get_userdata( $ID );
+        $old_user_data = get_userdata( $user_id );
 
         if ( ! $old_user_data ) {
@@ -2032 +2032 @@
      * }
      * @param bool     $update   Whether the user is being updated rather than created.
-     * @param int|null $id       ID of the user to be updated, or NULL if the user is being created.
+     * @param int|null $user_id  ID of the user to be updated, or NULL if the user is being created.
      * @param array    $userdata The raw array of data passed to wp_insert_user().
      */
-    $data = apply_filters( 'wp_pre_insert_user_data', $data, $update, ( $update ? (int) $ID : null ), $userdata );
+    $data = apply_filters( 'wp_pre_insert_user_data', $data, $update, ( $update ? $user_id : null ), $userdata );
 
     if ( empty( $data ) || ! is_array( $data ) ) {
@@ -2045 +2045 @@
             $data['user_activation_key'] = '';
         }
-        $wpdb->update( $wpdb->users, $data, compact( 'ID' ) );
-        $user_id = (int) $ID;
+        $wpdb->update( $wpdb->users, $data, array( 'ID' => $user_id ) );
     } else {
         $wpdb->insert( $wpdb->users, $data );
@@ -2178 +2177 @@
     }
 
-    $ID = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
-    if ( ! $ID ) {
+    $user_id = isset( $userdata['ID'] ) ? (int) $userdata['ID'] : 0;
+    if ( ! $user_id ) {
         return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
     }
 
     // First, get all of the original fields.
-    $user_obj = get_userdata( $ID );
+    $user_obj = get_userdata( $user_id );
     if ( ! $user_obj ) {
         return new WP_Error( 'invalid_user_id', __( 'Invalid user ID.' ) );
@@ -2193 +2192 @@
     // Add additional custom fields.
     foreach ( _get_additional_user_keys( $user_obj ) as $key ) {
-        $user[ $key ] = get_user_meta( $ID, $key, true );
+        $user[ $key ] = get_user_meta( $user_id, $key, true );
     }
 
@@ -2374 +2373 @@
     // Update the cookies if the password changed.
     $current_user = wp_get_current_user();
-    if ( $current_user->ID == $ID ) {
+    if ( $current_user->ID == $user_id ) {
         if ( isset( $plaintext_pass ) ) {
             wp_clear_auth_cookie();
@@ -2382 +2381 @@
             $logged_in_cookie = wp_parse_auth_cookie( '', 'logged_in' );
             /** This filter is documented in wp-includes/pluggable.php */
-            $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $ID, false );
+            $default_cookie_life = apply_filters( 'auth_cookie_expiration', ( 2 * DAY_IN_SECONDS ), $user_id, false );
             $remember            = false;
             if ( false !== $logged_in_cookie && ( $logged_in_cookie['expiration'] - time() ) > $default_cookie_life ) {
@@ -2388 +2387 @@
             }
 
-            wp_set_auth_cookie( $ID, $remember );
+            wp_set_auth_cookie( $user_id, $remember );
         }
     }
@@ -2551 +2550 @@
      * @since 2.7.0
      *
-     * @param bool $allow Whether to allow the password to be reset. Default true.
-     * @param int  $ID    The ID of the user attempting to reset a password.
+     * @param bool $allow   Whether to allow the password to be reset. Default true.
+     * @param int  $user_id The ID of the user attempting to reset a password.
      */
     $allow = apply_filters( 'allow_password_reset', $allow, $user->ID );