Changeset 53729

Timestamp:

07/20/2022 02:12:02 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Standardize on user_id when passing data to comment functions.

The wp_new_comment(), wp_update_comment(), and wp_filter_comment() functions already normalize the user_ID parameter internally to user_id, which matches the database field name.

This commit aims to bring some consistency when passing the parameter in core.

The corresponding $user_ID variable is also renamed to $user_id to match the other variables when not referring to the $user_ID global, which has an exception in the WordPress coding standards.

Follow-up to [8543], [8720], [12267], [12300], [26491], [28915], [28922], [34799], [49303].

See #55647, #56244.

Location:

trunk

Files:

• src/wp-admin/includes/ajax-actions.php (modified) (2 diffs)
• src/wp-includes/class-wp-xmlrpc-server.php (modified) (2 diffs)
• src/wp-includes/comment.php (modified) (9 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (1 diff)
• tests/phpunit/tests/comment-submission.php (modified) (1 diff)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -1298 +1298 @@
 
     if ( $user->exists() ) {
-        $user_ID              = $user->ID;
+        $user_id              = $user->ID;
         $comment_author       = wp_slash( $user->display_name );
         $comment_author_email = wp_slash( $user->user_email );
@@ -1344 +1344 @@
         'comment_type',
         'comment_parent',
-        'user_ID'
+        'user_id'
     );
 

trunk/src/wp-includes/class-wp-xmlrpc-server.php

@@ -3951 +3951 @@
             $comment['comment_author_email'] = $this->escape( $user_email );
             $comment['comment_author_url']   = $this->escape( $user_url );
-            $comment['user_ID']              = $user->ID;
+            $comment['user_id']              = $user->ID;
         } else {
             $comment['comment_author'] = '';
@@ -3968 +3968 @@
             }
 
-            $comment['user_ID'] = 0;
+            $comment['user_id'] = 0;
 
             if ( get_option( 'require_name_email' ) ) {

trunk/src/wp-includes/comment.php

@@ -2090 +2090 @@
          * Filters the comment author's user ID before it is set.
          *
-         * The first time this filter is evaluated, 'user_ID' is checked
-         * (for back-compat), followed by the standard 'user_id' value.
+         * The first time this filter is evaluated, `user_ID` is checked
+         * (for back-compat), followed by the standard `user_id` value.
          *
          * @since 1.5.0
          *
-         * @param int $user_ID The comment author's user ID.
+         * @param int $user_id The comment author's user ID.
          */
         $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_ID'] );
@@ -2133 +2133 @@
     /** This filter is documented in wp-includes/comment.php */
     $commentdata['comment_author_email'] = apply_filters( 'pre_comment_author_email', $commentdata['comment_author_email'] );
-    $commentdata['filtered']             = true;
+
+    $commentdata['filtered'] = true;
+
     return $commentdata;
 }
@@ -2266 +2268 @@
 
     $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $wp_error );
+
     if ( is_wp_error( $commentdata['comment_approved'] ) ) {
         return $commentdata['comment_approved'];
@@ -2271 +2274 @@
 
     $comment_ID = wp_insert_comment( $commentdata );
+
     if ( ! $comment_ID ) {
         $fields = array( 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content' );
@@ -2469 +2473 @@
     // First, get all of the original fields.
     $comment = get_comment( $commentarr['comment_ID'], ARRAY_A );
+
     if ( empty( $comment ) ) {
         if ( $wp_error ) {
@@ -3422 +3427 @@
  */
 function wp_handle_comment_submission( $comment_data ) {
-
     $comment_post_id      = 0;
-    $comment_parent       = 0;
-    $user_ID              = 0;
     $comment_author       = null;
     $comment_author_email = null;
     $comment_author_url   = null;
     $comment_content      = null;
+    $comment_parent       = 0;
+    $user_id              = 0;
 
     if ( isset( $comment_data['comment_post_ID'] ) ) {
@@ -3554 +3558 @@
         $comment_author_email = $user->user_email;
         $comment_author_url   = $user->user_url;
-        $user_ID              = $user->ID;
+        $user_id              = $user->ID;
 
         if ( current_user_can( 'unfiltered_html' ) ) {
@@ -3584 +3588 @@
     $commentdata = array(
         'comment_post_ID' => $comment_post_id,
+        'user_ID'         => $user_id,
     );
 
@@ -3593 +3598 @@
         'comment_type',
         'comment_parent',
-        'user_ID'
     );
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -1884 +1884 @@
             array(
                 'comment_post_ID'      => 0,
-                'comment_parent'       => 0,
-                'user_ID'              => 0,
                 'comment_author'       => null,
                 'comment_author_email' => null,
                 'comment_author_url'   => null,
+                'comment_parent'       => 0,
+                'user_id'              => 0,
             )
         );

trunk/tests/phpunit/tests/comment-submission.php

@@ -812 +812 @@
 
         $this->assertNotWPError( $comment );
-        $this->assertSame(
+        $this->assertSameSets(
             array(
                 'comment_post_ID'      => self::$post->ID,