Changeset 61369

Timestamp:

12/11/2025 01:53:26 AM (9 months ago)

Author:

westonruter

Message:

Export: Update export_wp() to handle get_comment() returning null due to filter.

The get_comment filter now explicitly documents returning null in addition to a WP_Comment object. This allows the filter to be used to exclude comments from an export. The get_comment() function already supported returning null.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/8383

Props abcd95, WPExplorer, desrosj, mukesh27, westonruter, SirLouen, lbones, mdibrahimk48, audrasjb, jorbin, wildworks, hellofromTonya, saurabh.dhariwal, mabfahad.
Fixes #61244.

Location:

trunk

Files:

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

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

@@ -686 +686 @@
 
                                 $_comments = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved <> 'spam'", $post->ID ) );
-                                $comments  = array_map( 'get_comment', $_comments );
+                                $comments  = array_filter(
+                                        array_map( 'get_comment', $_comments ),
+                                        static function ( $comment ) {
+                                                return $comment instanceof WP_Comment;
+                                        }
+                                );
                                 foreach ( $comments as $c ) :
                                         ?>

trunk/src/wp-includes/comment.php

@@ -241 +241 @@
          * @since 2.3.0
          *
-         * @param WP_Comment $_comment Comment data.
+         * @param WP_Comment|null $_comment Comment data.
          */
         $_comment = apply_filters( 'get_comment', $_comment );
+        if ( ! ( $_comment instanceof WP_Comment ) ) {
+                return null;
+        }
 
         if ( OBJECT === $output ) {

trunk/tests/phpunit/tests/admin/exportWp.php

@@ -291 +291 @@
                 $args['author'] = self::$post_ids[ $post_ids_key ]['post_author'];
         }
+
+        /**
+         * @ticket 61244
+         */
+        public function test_export_wp_should_not_include_empty_comments_when_filtered() {
+                $post_id = self::factory()->post->create( array( 'post_title' => 'Test Post' ) );
+                self::factory()->comment->create_post_comments( $post_id, 3 );
+
+                // Add filter to make get_comment return null.
+                add_action(
+                        'export_wp',
+                        static function () {
+                                add_filter( 'get_comment', '__return_null' );
+                        }
+                );
+
+                $xml_obj      = $this->get_the_export( array() );
+                $comment_tags = $xml_obj->xpath( '//wp:comment' );
+                $this->assertCount( 0, $comment_tags, 'No <wp:comment> tags should be present when comments are filtered out.' );
+        }
+
+        /**
+         * @ticket 61244
+         */
+        public function test_export_wp_includes_comments_when_not_filtered() {
+                $post_id       = self::factory()->post->create( array( 'post_title' => 'Test Post' ) );
+                $comment_count = 3;
+                self::factory()->comment->create_post_comments( $post_id, $comment_count );
+
+                $xml_obj      = $this->get_the_export( array() );
+                $comment_tags = $xml_obj->xpath( '//wp:comment' );
+                $this->assertCount( $comment_count, $comment_tags, 'Export should include all comments when not filtered.' );
+        }
 }

trunk/tests/phpunit/tests/comment.php

@@ -1897 +1897 @@
                 $this->assertSame( '1', get_comment( $sibling_note )->comment_approved );
         }
+
+        /**
+         * @ticket 61244
+         *
+         * @covers ::get_comment
+         */
+        public function test_get_comment_filter() {
+                $comment_id = self::factory()->comment->create( array( 'comment_post_ID' => self::$post_id ) );
+
+                $comment = get_comment( $comment_id );
+                $this->assertInstanceOf( WP_Comment::class, $comment );
+                $this->assertSame( $comment_id, (int) $comment->comment_ID, 'Expected the same comment.' );
+
+                add_filter( 'get_comment', '__return_null' );
+                $this->assertNull( get_comment( $comment_id ), 'Expected get_comment() to return null when get_comment filter returns null.' );
+        }
 }