Comments: Account for custom comment types when calculating comment counts (#1073)

* Comments: Account for custom comment types when calculating comment counts

Fixes #1069.

* support paging

---------

Co-authored-by: Matthias Pfefferle <[email protected]>

Author: obenland

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * `icon` support for `Audio` and `Video` attachments
 * Send "new follower" emails
 * Send "direct message" emails
+* Account for custom comment types when calculating comment counts
 
 ### Improved
 

includes/class-comment.php

@@ -30,6 +30,7 @@ public static function init() {
 		\add_action( 'pre_get_comments', array( static::class, 'comment_query' ) );
 		\add_filter( 'pre_comment_approved', array( static::class, 'pre_comment_approved' ), 10, 2 );
 		\add_filter( 'get_avatar_comment_types', array( static::class, 'get_avatar_comment_types' ), 99 );
+		\add_filter( 'pre_wp_update_comment_count_now', array( static::class, 'pre_wp_update_comment_count_now' ), 10, 3 );
 	}
 
 	/**
@@ -670,10 +671,6 @@ public static function comment_query( $query ) {
 			return;
 		}
 
-		if ( isset( $query->query_vars['count'] ) && true === $query->query_vars['count'] ) {
-			return;
-		}
-
 		// Exclude likes and reposts by the ActivityPub plugin.
 		$query->query_vars['type__not_in'] = self::get_comment_type_names();
 	}
@@ -715,4 +712,27 @@ public static function pre_comment_approved( $approved, $commentdata ) {
 
 		return $approved;
 	}
+
+	/**
+	 * Filters the comment count to exclude ActivityPub comment types.
+	 *
+	 * @param int|null $new_count The new comment count. Default null.
+	 * @param int      $old_count The old comment count.
+	 * @param int      $post_id   Post ID.
+	 *
+	 * @return int|null The updated comment count, or null to use the default query.
+	 */
+	public static function pre_wp_update_comment_count_now( $new_count, $old_count, $post_id ) {
+		if ( null === $new_count ) {
+			global $wpdb;
+
+			$excluded_types = self::get_comment_type_names();
+
+			// phpcs:ignore WordPress.DB
+			$new_count = (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved = '1' AND comment_type NOT IN ('" . implode( "','", $excluded_types ) . "')", $post_id ) );
+
+		}
+
+		return $new_count;
+	}
 }

readme.txt

@@ -137,6 +137,7 @@ For reasons of data protection, it is not possible to see the followers of other
 * Added: `icon` support for `Audio` and `Video` attachments
 * Added: Send "new follower" emails
 * Added: Send "direct message" emails
+* Added: Account for custom comment types when calculating comment counts
 * Improved: Email templates for Likes and Reposts
 * Improved: Interactions moderation
 * Improved: Compatibility with Akismet

tests/includes/class-test-comment.php

@@ -234,6 +234,37 @@ public function test_pre_comment_approved() {
 		\add_action( 'check_comment_flood', 'check_comment_flood_db', 10, 4 );
 	}
 
+	/**
+	 * Test pre_wp_update_comment_count_now.
+	 *
+	 * @covers ::pre_wp_update_comment_count_now
+	 */
+	public function test_pre_wp_update_comment_count_now() {
+		$post_id = self::factory()->post->create();
+
+		// Case 1: $new is null, no approved comments of non-ActivityPub types.
+		$this->assertSame( 0, Comment::pre_wp_update_comment_count_now( null, 0, $post_id ) );
+
+		// Case 2: $new is null, approved comments of non-ActivityPub types exist.
+		self::factory()->comment->create_post_comments( $post_id, 2, array( 'comment_approved' => '1' ) );
+		$this->assertSame( 2, Comment::pre_wp_update_comment_count_now( null, 0, $post_id ) );
+
+		// Case 3: $new is null, mix of ActivityPub and non-ActivityPub approved comments.
+		self::factory()->comment->create_post_comments(
+			$post_id,
+			3,
+			array(
+				'comment_approved' => '1',
+				'comment_type'     => 'like',
+			)
+		);
+		self::factory()->comment->create_post_comments( $post_id, 3, array( 'comment_approved' => '1' ) );
+		$this->assertSame( 5, Comment::pre_wp_update_comment_count_now( null, 0, $post_id ) );
+
+		// Case 4: $new is not null, should return $new unmodified.
+		$this->assertSame( 10, Comment::pre_wp_update_comment_count_now( 10, 0, $post_id ) );
+	}
+
 	/**
 	 * Data provider for test_check_ability_to_federate_comment.
 	 */