Changeset 34460

Timestamp:

09/23/2015 06:15:39 PM (9 years ago)

Author:

boonebgorges

Message:

Allow comment_exists() to match based on GMT date.

The comment_date_gmt field of the wp_comments table is indexed, which makes
WHERE matches against the field much faster than against the unindexed
comment_date. For bulk operations like data import, the speed difference can
be meaningful.

We continue to default to 'blog' for $timezone, to preserve compatibility
with existing uses.

Props apokalyptik.
Fixes #33871.

Location:

trunk

Files:

• src/wp-admin/includes/comment.php (modified) (1 diff)
• tests/phpunit/tests/admin/includesComment.php (modified) (1 diff)

trunk/src/wp-admin/includes/comment.php

@@ -10 +10 @@
  * Determine if a comment exists based on author and date.
  *
+ * For best performance, use `$timezone = 'gmt'`, which queries a field that is properly indexed. The default value
+ * for `$timezone` is 'blog' for legacy reasons.
+ *
  * @since 2.0.0
+ * @since 4.4.0 Added the `$timezone` parameter.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param string $comment_author Author of the comment
- * @param string $comment_date Date of the comment
+ * @param string $comment_author Author of the comment.
+ * @param string $comment_date   Date of the comment.
+ * @param string $timezone       Timezone. Accepts 'blog' or 'gmt'. Default 'blog'.
+ *
  * @return mixed Comment post ID on success.
  */
-function comment_exists($comment_author, $comment_date) {
+function comment_exists( $comment_author, $comment_date, $timezone = 'blog' ) {
     global $wpdb;
 
+    $date_field = 'comment_date';
+    if ( 'gmt' === $timezone ) {
+        $date_field = 'comment_date_gmt';
+    }
+
     return $wpdb->get_var( $wpdb->prepare("SELECT comment_post_ID FROM $wpdb->comments
-            WHERE comment_author = %s AND comment_date = %s",
+            WHERE comment_author = %s AND $date_field = %s",
             stripslashes( $comment_author ),
             stripslashes( $comment_date )

trunk/tests/phpunit/tests/admin/includesComment.php

@@ -24 +24 @@
         $this->assertEquals( $p1, comment_exists( 1, '2014-05-06 12:00:00' ) );
     }
+
+    /**
+     * @ticket 33871
+     */
+    public function test_default_value_of_timezone_should_be_blog() {
+        $p = $this->factory->post->create();
+        $c = $this->factory->comment->create( array(
+            'comment_author' => 1,
+            'comment_post_ID' => $p,
+            'comment_date' => '2014-05-06 12:00:00',
+            'comment_date_gmt' => '2014-05-06 07:00:00',
+        ) );
+
+        $this->assertEquals( $p, comment_exists( 1, '2014-05-06 12:00:00' ) );
+    }
+
+    /**
+     * @ticket 33871
+     */
+    public function test_should_respect_timezone_blog() {
+        $p = $this->factory->post->create();
+        $c = $this->factory->comment->create( array(
+            'comment_author' => 1,
+            'comment_post_ID' => $p,
+            'comment_date' => '2014-05-06 12:00:00',
+            'comment_date_gmt' => '2014-05-06 07:00:00',
+        ) );
+
+        $this->assertEquals( $p, comment_exists( 1, '2014-05-06 12:00:00', 'blog' ) );
+    }
+
+    /**
+     * @ticket 33871
+     */
+    public function test_should_respect_timezone_gmt() {
+        $p = $this->factory->post->create();
+        $c = $this->factory->comment->create( array(
+            'comment_author' => 1,
+            'comment_post_ID' => $p,
+            'comment_date' => '2014-05-06 12:00:00',
+            'comment_date_gmt' => '2014-05-06 07:00:00',
+        ) );
+
+        $this->assertEquals( $p, comment_exists( 1, '2014-05-06 07:00:00', 'gmt' ) );
+    }
+
+    /**
+     * @ticket 33871
+     */
+    public function test_invalid_timezone_should_fall_back_on_blog() {
+        $p = $this->factory->post->create();
+        $c = $this->factory->comment->create( array(
+            'comment_author' => 1,
+            'comment_post_ID' => $p,
+            'comment_date' => '2014-05-06 12:00:00',
+            'comment_date_gmt' => '2014-05-06 07:00:00',
+        ) );
+
+        $this->assertEquals( $p, comment_exists( 1, '2014-05-06 12:00:00', 'not_a_valid_value' ) );
+    }
 }