Changeset 55324

Timestamp:

02/13/2023 10:03:30 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Comments: Use correct orderby parameter name in personal data exporter and eraser.

This ensures that get_comments() is called with the correct parameter name in:

• wp_comments_personal_data_exporter()
• wp_comments_personal_data_eraser()

Follow-up to [42888], [42994].

Props smeunus, kapilpaul, SergeyBiryukov.
Fixes #57700.

Location:

trunk

Files:

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

trunk/src/wp-includes/comment.php

@@ -3693 +3693 @@
                         'number'                    => $number,
                         'paged'                     => $page,
-                        'order_by'                  => 'comment_ID',
+                        'orderby'                   => 'comment_ID',
                         'order'                     => 'ASC',
                         'update_comment_meta_cache' => false,
@@ -3816 +3816 @@
                         'number'             => $number,
                         'paged'              => $page,
-                        'order_by'           => 'comment_ID',
+                        'orderby'            => 'comment_ID',
                         'order'              => 'ASC',
                         'include_unapproved' => true,

trunk/tests/phpunit/tests/comment/wpCommentsPersonalDataEraser.php

@@ -230 +230 @@
                 return sprintf( 'Some custom message for comment %d.', $comment->comment_ID );
         }
+
+        /**
+         * Testing that `wp_comments_personal_data_eraser()` orders comments by ID.
+         *
+         * @ticket 57700
+         */
+        public function test_wp_comments_personal_data_eraser_orders_comments_by_id() {
+
+                $args = array(
+                        'comment_post_ID'      => self::$post_id,
+                        'comment_author'       => 'Comment Author',
+                        'comment_author_email' => 'personal@local.host',
+                        'comment_author_url'   => 'https://local.host/',
+                        'comment_author_IP'    => '192.168.0.1',
+                        'comment_date'         => '2018-04-14 17:20:00',
+                        'comment_agent'        => 'COMMENT_AGENT',
+                        'comment_content'      => 'Comment Content',
+                );
+                self::factory()->comment->create( $args );
+
+                $filter = new MockAction();
+                add_filter( 'comments_clauses', array( &$filter, 'filter' ) );
+
+                wp_comments_personal_data_eraser( $args['comment_author_email'] );
+
+                $clauses = $filter->get_args()[0][0];
+
+                $this->assertStringContainsString( 'comment_ID', $clauses['orderby'] );
+        }
 }

trunk/tests/phpunit/tests/comment/wpCommentsPersonalDataExporter.php

@@ -133 +133 @@
                 $this->assertCount( 0, $actual['data'] );
         }
+
+        /**
+         * Testing that `wp_comments_personal_data_exporter()` orders comments by ID.
+         *
+         * @ticket 57700
+         */
+        public function test_wp_comments_personal_data_exporter_orders_comments_by_id() {
+
+                $args = array(
+                        'comment_post_ID'      => self::$post_id,
+                        'comment_author'       => 'Comment Author',
+                        'comment_author_email' => 'personal@local.host',
+                        'comment_author_url'   => 'https://local.host/',
+                        'comment_author_IP'    => '192.168.0.1',
+                        'comment_date'         => '2018-03-28 20:05:00',
+                        'comment_agent'        => 'SOME_AGENT',
+                        'comment_content'      => 'Comment',
+                );
+                self::factory()->comment->create( $args );
+
+                $filter = new MockAction();
+                add_filter( 'comments_clauses', array( &$filter, 'filter' ) );
+
+                wp_comments_personal_data_exporter( $args['comment_author_email'] );
+
+                $clauses = $filter->get_args()[0][0];
+
+                $this->assertStringContainsString( 'comment_ID', $clauses['orderby'] );
+        }
 }