Changeset 61105

Timestamp:

10/31/2025 06:55:47 PM (6 weeks ago)

Author:

adamsilverstein

Message:

Editor: Notes should not appear in the context of comments.

Prevent notes from inadvertently showing up in the context of comments - including on the Dashboard recent comments widget and the “Mine” count on the Comments page. Notes are stored as a custom ‘note’ comment type and this change ensures the note type is only returned when explicitly requested, or when ‘all’ types are requested.

The query for note children is modified to return all child notes. This fixes an issue where children were no longer being returned for the ‘note’ type.

Also fixes ​https://github.com/WordPress/gutenberg/issues/72548.

Props adamsilverstein, timothyblynjacobs, shailu25, peterwilsoncc, westonruter, mamaduka, kadamwhite.
Fixes #64145.
Fixes #64152.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-comments-list-table.php (modified) (1 diff)
• src/wp-admin/includes/comment.php (modified) (1 diff)
• src/wp-includes/class-wp-comment-query.php (modified) (2 diffs)
• src/wp-includes/comment.php (modified) (1 diff)
• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (2 diffs)
• tests/phpunit/tests/comment/query.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-comments-controller.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-comments-list-table.php

@@ -152 +152 @@
             'post_type'                 => $post_type,
             'update_comment_post_cache' => true,
-            'type__not_in'              => array( 'note' ),
         );
 

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

@@ -139 +139 @@
  *
  * @since 2.3.0
+ * @since 6.9.0 Exclude the 'note' comment type from the count.
  *
  * @global wpdb $wpdb WordPress database abstraction object.

trunk/src/wp-includes/class-wp-comment-query.php

@@ -537 +537 @@
      *
      * @since 4.4.0
+     * @since 6.9.0 Excludes the 'note' comment type, unless 'all' or the 'note' types are requested.
      *
      * @global wpdb $wpdb WordPress database abstraction object.
@@ -770 +771 @@
             'NOT IN' => (array) $this->query_vars['type__not_in'],
         );
+
+        // Exclude the 'note' comment type, unless 'all' types or the 'note' type explicitly are requested.
+        if (
+            ! in_array( 'all', $raw_types['IN'], true ) &&
+            ! in_array( 'note', $raw_types['IN'], true ) &&
+            ! in_array( 'note', $raw_types['NOT IN'], true )
+        ) {
+            $raw_types['NOT IN'][] = 'note';
+        }
 
         $comment_types = array();

trunk/src/wp-includes/comment.php

@@ -418 +418 @@
         'update_comment_meta_cache' => false,
         'orderby'                   => 'none',
-        'type__not_in'              => array( 'note' ),
     );
     if ( $post_id > 0 ) {

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

@@ -1255 +1255 @@
                 'count'   => true,
                 'orderby' => 'none',
+                'type'    => 'all',
             )
         );
@@ -1261 +1262 @@
             $args = array(
                 'parent' => $comment->comment_ID,
+            );
+
+            $rest_url = add_query_arg( $args, rest_url( $this->namespace . '/' . $this->rest_base ) );
+
+            $links['children'] = array(
+                'href'       => $rest_url,
+                'embeddable' => true,
+            );
+        }
+
+        // Embedding children for notes requires `type` and `status` inheritance.
+        if ( isset( $links['children'] ) && 'note' === $comment->comment_type ) {
+            $args = array(
+                'parent' => $comment->comment_ID,
+                'type'   => $comment->comment_type,
+                'status' => 'all',
             );
 

trunk/tests/phpunit/tests/comment/query.php

@@ -5373 +5373 @@
         $this->assertSame( ltrim( $q->request ), $q->request, 'The query has leading whitespace' );
     }
+
+    /**
+     * Helper method to create standard test comments for note type exclusion tests.
+     *
+     * @since 6.9.0
+     *
+     * @return array<'comment'|'pingback'|'note', int> Array of comments created.
+     */
+    protected function create_note_type_test_comments(): array {
+        return array(
+            'comment'  => self::factory()->comment->create(
+                array(
+                    'comment_post_ID'  => self::$post_id,
+                    'comment_approved' => '1',
+                )
+            ),
+            'pingback' => self::factory()->comment->create(
+                array(
+                    'comment_post_ID'  => self::$post_id,
+                    'comment_approved' => '1',
+                    'comment_type'     => 'pingback',
+                )
+            ),
+            'note'     => self::factory()->comment->create(
+                array(
+                    'comment_post_ID'  => self::$post_id,
+                    'comment_approved' => '1',
+                    'comment_type'     => 'note',
+                )
+            ),
+        );
+    }
+
+    /**
+     * @ticket 64145
+     * @covers WP_Comment_Query::get_comment_ids
+     * @dataProvider data_note_type_exclusion
+     *
+     * @param array<string, string|array> $query_args     Query arguments for WP_Comment_Query.
+     * @param string[]                    $expected_types Expected comment types.
+     */
+    public function test_note_type_exclusion( array $query_args, array $expected_types ) {
+        $this->create_note_type_test_comments();
+
+        $query = new WP_Comment_Query();
+        $found = $query->query( array_merge( $query_args, array( 'fields' => 'ids' ) ) );
+
+        $actual_types = array_map(
+            static function ( int $comment_id ): string {
+                return get_comment( $comment_id )->comment_type;
+            },
+            $found
+        );
+
+        $this->assertSameSets( $expected_types, $actual_types, 'Expected comment query to return comments of the these types.' );
+    }
+
+    /**
+     * Data provider for note type exclusion tests.
+     *
+     * @since 6.9.0
+     *
+     * @return array<string, array{ query_args: array<string, string|array>, expected_types: string[] }>
+     */
+    public function data_note_type_exclusion(): array {
+        return array(
+            'default query excludes note'        => array(
+                'query_args'     => array(),
+                'expected_types' => array( 'comment', 'pingback' ),
+            ),
+            'empty type parameter excludes note' => array(
+                'query_args'     => array( 'type' => '' ),
+                'expected_types' => array( 'comment', 'pingback' ),
+            ),
+            'type all includes note'             => array(
+                'query_args'     => array( 'type' => 'all' ),
+                'expected_types' => array( 'comment', 'pingback', 'note' ),
+            ),
+            'explicit note type'                 => array(
+                'query_args'     => array( 'type' => 'note' ),
+                'expected_types' => array( 'note' ),
+            ),
+            'type__in with note'                 => array(
+                'query_args'     => array( 'type__in' => array( 'note' ) ),
+                'expected_types' => array( 'note' ),
+            ),
+            'type__in with note and pingback'    => array(
+                'query_args'     => array( 'type__in' => array( 'note', 'pingback' ) ),
+                'expected_types' => array( 'note', 'pingback' ),
+            ),
+            'type pings excludes note'           => array(
+                'query_args'     => array( 'type' => 'pings' ),
+                'expected_types' => array( 'pingback' ),
+            ),
+            'type__not_in with note'             => array(
+                'query_args'     => array( 'type__not_in' => array( 'note' ) ),
+                'expected_types' => array( 'comment', 'pingback' ),
+            ),
+        );
+    }
+
+    /**
+     * @ticket 64145
+     * @covers WP_Comment_Query::get_comment_ids
+     */
+    public function test_note_type_not_duplicated_in_type__not_in() {
+        global $wpdb;
+
+        $comments = $this->create_note_type_test_comments();
+
+        $query = new WP_Comment_Query();
+        $found = $query->query(
+            array(
+                'type__not_in' => array( 'note' ),
+                'fields'       => 'ids',
+            )
+        );
+
+        $this->assertSameSets( array( $comments['comment'], $comments['pingback'] ), $found );
+        $this->assertNotContains( $comments['note'], $found );
+        $note_count = substr_count( $wpdb->last_query, "'note'" );
+        $this->assertSame( 1, $note_count, 'The note type should only appear once in the query' );
+    }
+
+    /**
+     * @ticket 64145
+     * @covers ::get_comment_count
+     */
+    public function test_get_comment_count_excludes_note_type() {
+        $post_id = self::factory()->post->create();
+
+        self::factory()->comment->create(
+            array(
+                'comment_post_ID'  => $post_id,
+                'comment_approved' => '1',
+            )
+        );
+        self::factory()->comment->create(
+            array(
+                'comment_post_ID'  => $post_id,
+                'comment_approved' => '1',
+                'comment_type'     => 'note',
+            )
+        );
+        self::factory()->comment->create(
+            array(
+                'comment_post_ID'  => $post_id,
+                'comment_approved' => '0',
+                'comment_type'     => 'note',
+            )
+        );
+
+        $counts = get_comment_count( $post_id );
+
+        $this->assertSame( 1, $counts['approved'] );
+        $this->assertSame( 0, $counts['awaiting_moderation'] );
+        $this->assertSame( 0, $counts['spam'] );
+        $this->assertSame( 0, $counts['trash'] );
+        $this->assertSame( 0, $counts['post-trashed'] );
+        $this->assertSame( 1, $counts['all'] );
+        $this->assertSame( 1, $counts['total_comments'] );
+    }
 }

trunk/tests/phpunit/tests/rest-api/rest-comments-controller.php

@@ -4077 +4077 @@
         );
     }
+
+    /**
+     * Test children link for note comment type. Based on test_get_comment_with_children_link.
+     *
+     * @ticket 64152
+     */
+    public function test_get_note_with_children_link() {
+        $parent_comment_id = self::factory()->comment->create(
+            array(
+                'comment_approved' => 1,
+                'comment_post_ID'  => self::$post_id,
+                'user_id'          => self::$admin_id,
+                'comment_type'     => 'note',
+                'comment_content'  => 'Parent note comment',
+            )
+        );
+
+        self::factory()->comment->create(
+            array(
+                'comment_approved' => 1,
+                'comment_parent'   => $parent_comment_id,
+                'comment_post_ID'  => self::$post_id,
+                'user_id'          => self::$admin_id,
+                'comment_type'     => 'note',
+                'comment_content'  => 'First child note comment',
+            )
+        );
+
+        wp_set_current_user( self::$admin_id );
+        $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/comments/%s', $parent_comment_id ) );
+        $request->set_param( 'type', 'note' );
+        $request->set_param( 'context', 'edit' );
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 200, $response->get_status() );
+
+        $this->assertArrayHasKey( 'children', $response->get_links() );
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/comments' );
+        $request->set_param( 'post', self::$post_id );
+        $request->set_param( 'type', 'note' );
+        $request->set_param( 'context', 'edit' );
+        $request->set_param( 'parent', 0 );
+
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertSame( 200, $response->get_status() );
+
+        $data = $response->get_data();
+
+        $this->assertArrayHasKey( '_links', $data[0] );
+        $this->assertArrayHasKey( 'children', $data[0]['_links'] );
+
+        $children = $data[0]['_links']['children'];
+
+        // Verify the href attribute contains the expected status and type parameters.
+        $this->assertStringContainsString( 'status=all', $children[0]['href'] );
+        $this->assertStringContainsString( 'type=note', $children[0]['href'] );
+    }
 }