Changeset 57603 for trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php

Timestamp:

02/12/2024 10:15:45 PM (2 years ago)

Author:

swissspidy

Message:

REST API: Add featured_media field to attachments endpoint.

Audio and video attachments can have a featured image, also known as a poster image. This functionality is now properly exposed by the wp/v2/media endpoint.

Props swissspidy, timothyblynjacobs, wonderboymusic, dlh, spacedmonkey.
Fixes #41692.

File:

• trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php (modified) (3 diffs)

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

@@ -1066 +1066 @@
         $term = wp_get_post_terms( $attachment['id'], 'category' );
         $this->assertSame( $category['term_id'], $term[0]->term_id );
+    }
+
+    /**
+     * @ticket 41692
+     */
+    public function test_create_update_post_with_featured_media() {
+        // Add support for thumbnails on all attachment types to avoid incorrect-usage notice.
+        add_post_type_support( 'attachment', 'thumbnail' );
+
+        wp_set_current_user( self::$editor_id );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/media' );
+        $request->set_file_params(
+            array(
+                'file' => array(
+                    'file'     => file_get_contents( self::$test_file ),
+                    'name'     => 'canola.jpg',
+                    'size'     => filesize( self::$test_file ),
+                    'tmp_name' => self::$test_file,
+                ),
+            )
+        );
+        $request->set_header( 'Content-MD5', md5_file( self::$test_file ) );
+
+        $file          = DIR_TESTDATA . '/images/canola.jpg';
+        $attachment_id = self::factory()->attachment->create_object(
+            $file,
+            0,
+            array(
+                'post_mime_type' => 'image/jpeg',
+                'menu_order'     => rand( 1, 100 ),
+            )
+        );
+
+        $request->set_param( 'featured_media', $attachment_id );
+
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+
+        $this->assertEquals( 201, $response->get_status() );
+
+        $new_attachment = get_post( $data['id'] );
+
+        $this->assertEquals( $attachment_id, (int) get_post_thumbnail_id( $new_attachment->ID ) );
+        $this->assertEquals( $attachment_id, $data['featured_media'] );
+
+        $request = new WP_REST_Request( 'PUT', '/wp/v2/media/' . $new_attachment->ID );
+        $params  = $this->set_post_data(
+            array(
+                'featured_media' => 0,
+            )
+        );
+        $request->set_body_params( $params );
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+        $data = $response->get_data();
+        $this->assertEquals( 0, $data['featured_media'] );
+        $this->assertEquals( 0, (int) get_post_thumbnail_id( $new_attachment->ID ) );
+
+        $request = new WP_REST_Request( 'PUT', '/wp/v2/media/' . $new_attachment->ID );
+        $params  = $this->set_post_data(
+            array(
+                'featured_media' => $attachment_id,
+            )
+        );
+        $request->set_body_params( $params );
+        $response = rest_get_server()->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+        $data = $response->get_data();
+        $this->assertEquals( $attachment_id, $data['featured_media'] );
+        $this->assertEquals( $attachment_id, (int) get_post_thumbnail_id( $new_attachment->ID ) );
     }
 
@@ -1577 +1648 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertCount( 27, $properties );
+        $this->assertCount( 28, $properties );
         $this->assertArrayHasKey( 'author', $properties );
         $this->assertArrayHasKey( 'alt_text', $properties );
@@ -1611 +1682 @@
         $this->assertArrayHasKey( 'type', $properties );
         $this->assertArrayHasKey( 'missing_image_sizes', $properties );
+        $this->assertArrayHasKey( 'featured_media', $properties );
     }