Changeset 53110

Timestamp:

04/08/2022 05:27:42 PM (4 years ago)

Author:

spacedmonkey

Message:

REST API: Use rest_parse_embed_param function in WP_REST_Server class.

Ensure that the value get parameter _embed that is passed to the envelope_response method, is run through the rest_parse_embed_param function.

Props Spacedmonkey, johnbillion, TimothyBlynJacobs.
Fixes #54015.

Location:

trunk

Files:

• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-server.php (modified) (2 diffs)

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -439 +439 @@
                 // Wrap the response in an envelope if asked for.
                 if ( isset( $_GET['_envelope'] ) ) {
-                        $result = $this->envelope_response( $result, isset( $_GET['_embed'] ) );
+                        $embed  = isset( $_GET['_embed'] ) ? rest_parse_embed_param( $_GET['_embed'] ) : false;
+                        $result = $this->envelope_response( $result, $embed );
                 }
 
@@ -731 +732 @@
          *
          * @since 4.4.0
+         * @since 6.0.0 The $embed parameter can now contain a list of link relations to include
          *
          * @param WP_REST_Response $response Response object.
-         * @param bool             $embed    Whether links should be embedded.
+         * @param bool|string[]    $embed    Whether to embed all links, a filtered list of link relations, or no links.
          * @return WP_REST_Response New response with wrapped data
          */

trunk/tests/phpunit/tests/rest-api/rest-server.php

@@ -74 +74 @@
 
                 $this->assertSame( $data, $enveloped['body'] );
+                $this->assertSame( $status, $enveloped['status'] );
+                $this->assertSame( $headers, $enveloped['headers'] );
+        }
+
+        /**
+         * @dataProvider data_envelope_params
+         * @ticket 54015
+         */
+        public function test_envelope_param( $_embed ) {
+                // Register our testing route.
+                rest_get_server()->register_route(
+                        'test',
+                        '/test/embeddable',
+                        array(
+                                'methods'  => 'GET',
+                                'callback' => array( $this, 'embedded_response_callback' ),
+                        )
+                );
+                $data    = array(
+                        'amount of arbitrary data' => 'alot',
+                );
+                $status  = 987;
+                $headers = array(
+                        'Arbitrary-Header' => 'value',
+                        'Multiple'         => 'maybe, yes',
+                );
+
+                $response = new WP_REST_Response( $data, $status );
+                $response->header( 'Arbitrary-Header', 'value' );
+
+                // Check header concatenation as well.
+                $response->header( 'Multiple', 'maybe' );
+                $response->header( 'Multiple', 'yes', false );
+
+                // All others should be embedded.
+                $response->add_link( 'alternate', rest_url( '/test/embeddable' ), array( 'embeddable' => true ) );
+
+                $embed             = rest_parse_embed_param( $_embed );
+                $envelope_response = rest_get_server()->envelope_response( $response, $embed );
+
+                // The envelope should still be a response, but with defaults.
+                $this->assertInstanceOf( WP_REST_Response::class, $envelope_response );
+                $this->assertSame( 200, $envelope_response->get_status() );
+                $this->assertEmpty( $envelope_response->get_headers() );
+                $this->assertEmpty( $envelope_response->get_links() );
+
+                $enveloped = $envelope_response->get_data();
+
+                $this->assertArrayHasKey( 'body', $enveloped );
+                $this->assertArrayHasKey( '_links', $enveloped['body'] );
+                $this->assertArrayHasKey( '_embedded', $enveloped['body'] );
+                $this->assertArrayHasKey( 'alternate', $enveloped['body']['_embedded'] );
+
+                $alternate = $enveloped['body']['_embedded']['alternate'];
+                $this->assertCount( 1, $alternate );
+
                 $this->assertSame( $status, $enveloped['status'] );
                 $this->assertSame( $headers, $enveloped['headers'] );
@@ -2174 +2230 @@
                 return rest_get_server()->sent_headers;
         }
+
+        /**
+         * Data provider.
+         *
+         * @return array
+         */
+        public function data_envelope_params() {
+                return array(
+                        array( '1' ),
+                        array( 'true' ),
+                        array( false ),
+                        array( 'alternate' ),
+                        array( array( 'alternate' ) ),
+                );
+        }
 }