Changeset 54489

Timestamp:

10/11/2022 04:30:40 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Comments: Consistently normalize user_ID to user_id in wp_new_comment().

For backward compatibility, the user_id parameter of wp_new_comment() can be spelled as user_ID, and plugins utilizing the preprocess_comment filter or the comment_post action should be able to receive both variations.

Follow-up to [12267], [12300], [28915], [36038], [53729].

Props peterwilsoncc, SergeyBiryukov.
Fixes #56244.

Location:

trunk

Files:

• src/wp-includes/comment.php (modified) (5 diffs)
• tests/phpunit/tests/comment-submission.php (modified) (1 diff)
• tests/phpunit/tests/comment.php (modified) (2 diffs)

trunk/src/wp-includes/comment.php

@@ -2209 +2209 @@
     global $wpdb;
 
+    /*
+     * Normalize `user_ID` to `user_id`, but pass the old key
+     * to the `preprocess_comment` filter for backward compatibility.
+     */
     if ( isset( $commentdata['user_ID'] ) ) {
         $commentdata['user_ID'] = (int) $commentdata['user_ID'];
         $commentdata['user_id'] = $commentdata['user_ID'];
+    } elseif ( isset( $commentdata['user_id'] ) ) {
+        $commentdata['user_id'] = (int) $commentdata['user_id'];
+        $commentdata['user_ID'] = $commentdata['user_id'];
     }
 
@@ -2236 +2243 @@
     $commentdata['comment_post_ID'] = (int) $commentdata['comment_post_ID'];
 
+    // Normalize `user_ID` to `user_id` again, after the filter.
     if ( isset( $commentdata['user_ID'] ) && $prefiltered_user_id !== (int) $commentdata['user_ID'] ) {
         $commentdata['user_ID'] = (int) $commentdata['user_ID'];
@@ -2241 +2249 @@
     } elseif ( isset( $commentdata['user_id'] ) ) {
         $commentdata['user_id'] = (int) $commentdata['user_id'];
+        $commentdata['user_ID'] = $commentdata['user_id'];
     }
 
@@ -3588 +3597 @@
     $commentdata = array(
         'comment_post_ID' => $comment_post_id,
-        'user_ID'         => $user_id,
     );
 
@@ -3597 +3605 @@
         'comment_content',
         'comment_type',
-        'comment_parent'
+        'comment_parent',
+        'user_id'
     );
 

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

@@ -846 +846 @@
      */
     public function test_comment_submission_sends_all_expected_parameters_to_preprocess_comment_filter() {
-
         $user = get_userdata( self::$author_id );
         wp_set_current_user( $user->ID );

trunk/tests/phpunit/tests/comment.php

@@ -9 +9 @@
     protected static $notify_message = '';
 
+    protected $preprocess_comment_data = array();
+
     public function set_up() {
         parent::set_up();
@@ -455 +457 @@
 
         $this->assertSame( strlen( $comment->comment_content ), 65535 );
+    }
+
+    /**
+     * @ticket 56244
+     */
+    public function test_wp_new_comment_sends_all_expected_parameters_to_preprocess_comment_filter() {
+        $user = get_userdata( self::$user_id );
+        wp_set_current_user( $user->ID );
+
+        $data = array(
+            'comment_post_ID'      => self::$post_id,
+            'comment_author'       => $user->display_name,
+            'comment_author_email' => $user->user_email,
+            'comment_author_url'   => $user->user_url,
+            'comment_content'      => 'Comment',
+            'comment_type'         => '',
+            'comment_parent'       => 0,
+            'user_id'              => $user->ID,
+        );
+
+        add_filter( 'preprocess_comment', array( $this, 'filter_preprocess_comment' ) );
+
+        $comment = wp_new_comment( $data );
+
+        $this->assertNotWPError( $comment );
+        $this->assertSameSetsWithIndex(
+            array(
+                'comment_post_ID'      => self::$post_id,
+                'comment_author'       => $user->display_name,
+                'comment_author_email' => $user->user_email,
+                'comment_author_url'   => $user->user_url,
+                'comment_content'      => $data['comment_content'],
+                'comment_type'         => '',
+                'comment_parent'       => 0,
+                'user_ID'              => $user->ID,
+                'user_id'              => $user->ID,
+                'comment_author_IP'    => '127.0.0.1',
+                'comment_agent'        => '',
+            ),
+            $this->preprocess_comment_data
+        );
+
+    }
+
+    public function filter_preprocess_comment( $commentdata ) {
+        $this->preprocess_comment_data = $commentdata;
+        return $commentdata;
     }