Changeset 61269

Timestamp:

11/19/2025 06:01:22 AM (2 months ago)

Author:

westonruter

Message:

Posts, Post Types: Ensure get_post_class() returns a list.

This avoids the REST API erroneously returning an object in the class_list property returned by WP_REST_Posts_Controller::prepare_item_for_response().

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

Props dlh, mamaduka, westonruter.
Fixes #64247.

Location:

trunk

Files:

• src/wp-includes/post-template.php (modified) (1 diff)
• tests/phpunit/tests/post/getPostClass.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)

trunk/src/wp-includes/post-template.php

@@ -607 +607 @@
     $classes = apply_filters( 'post_class', $classes, $css_class, $post->ID );
 
-    return array_unique( $classes );
+    $classes = array_unique( $classes );
+    $classes = array_values( $classes );
+
+    return $classes;
 }
 

trunk/tests/phpunit/tests/post/getPostClass.php

@@ -136 +136 @@
         $this->assertSame( $num_queries, get_num_queries() );
     }
+
+    /**
+     * @ticket 64247
+     */
+    public function test_list_return_value_when_duplicate_classes() {
+
+        // Filter 'post_class' to add a duplicate which should be removed by `array_unique()`.
+        add_filter(
+            'post_class',
+            function ( $classes ) {
+                return array_merge(
+                    array( 'duplicate-class', 'duplicate-class' ),
+                    $classes
+                );
+            }
+        );
+
+        $class_list = get_post_class( 'original', $this->post_id );
+        $this->assertTrue( array_is_list( $class_list ), 'Expected get_post_class() to return list.' );
+        $this->assertContains( 'duplicate-class', $class_list );
+        $this->assertContains( 'original', $class_list );
+    }
 }

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

@@ -2774 +2774 @@
             'Incorrect word count in the excerpt. Expected the excerpt to contain 44 words (43 words plus an ellipsis), but a different word count was found.'
         );
+    }
+
+    /**
+     * Test that the `class_list` property is a list.
+     *
+     * @ticket 64247
+     *
+     * @covers WP_REST_Posts_Controller::prepare_item_for_response
+     */
+    public function test_class_list_is_list() {
+        $post_id = self::factory()->post->create();
+
+        // Filter 'post_class' to add a duplicate which should be removed by `array_unique()`.
+        add_filter(
+            'post_class',
+            function ( $classes ) {
+                return array_merge(
+                    array( 'duplicate-class', 'duplicate-class' ),
+                    $classes
+                );
+            }
+        );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/posts/' . $post_id );
+        $response = rest_do_request( $request );
+        $data     = $response->get_data();
+
+        $this->assertArrayHasKey( 'class_list', $data );
+        $this->assertContains( 'duplicate-class', $data['class_list'] );
+        $this->assertTrue( array_is_list( $data['class_list'] ), 'Expected class_list to be a list.' );
     }