Changeset 46434

Timestamp:

10/08/2019 04:43:10 AM (7 years ago)

Author:

kadamwhite

Message:

REST API: Permit embedding of the 'self' link relation in the /search endpoint.

Removes a special-case prohibition against embedding 'self' which prevented ?_embed from being used with the /wp/v2/search endpoint.

Props TimothyBlynJacobs, chrisvanpatten, kadamwhite.
Fixes #47684.

Location:

trunk

Files:

• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-search-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-server.php (modified) (2 diffs)

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

@@ -565 +565 @@
 
                 foreach ( $data['_links'] as $rel => $links ) {
-                        // Ignore links to self, for obvious reasons.
-                        if ( 'self' === $rel ) {
-                                continue;
-                        }
-
                         $embeds = array();
 

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

@@ -1364 +1364 @@
                 $this->assertEquals( rest_url( '/wp/v2/posts/' . self::$post_id ), $links['self'][0]['href'] );
                 $this->assertEquals( rest_url( '/wp/v2/posts' ), $links['collection'][0]['href'] );
+                $this->assertArrayNotHasKey( 'embeddable', $links['self'][0]['attributes'] );
 
                 $this->assertEquals( rest_url( '/wp/v2/types/' . get_post_type( self::$post_id ) ), $links['about'][0]['href'] );

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

@@ -502 +502 @@
 
         /**
+         * @ticket 47684
+         */
+        public function test_search_result_links_are_embedded() {
+                $response = $this->do_request_with_params( array( 'per_page' => 1 ) );
+                $data     = rest_get_server()->response_to_data( $response, true )[0];
+
+                $this->assertArrayHasKey( '_embedded', $data );
+                $this->assertArrayHasKey( 'self', $data['_embedded'] );
+                $this->assertCount( 1, $data['_embedded']['self'] );
+                $this->assertArrayHasKey( WP_REST_Search_Controller::PROP_ID, $data['_embedded']['self'][0] );
+                $this->assertEquals( $data[ WP_REST_Search_Controller::PROP_ID ], $data['_embedded']['self'][0][ WP_REST_Search_Controller::PROP_ID ] );
+        }
+
+        /**
          * Perform a REST request to our search endpoint with given parameters.
          */

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

@@ -570 +570 @@
         /**
          * @depends test_link_embedding
+         * @ticket 47684
          */
         public function test_link_embedding_self() {
@@ -583 +584 @@
                 $response = new WP_REST_Response();
 
-                // 'self' should be ignored.
-                $response->add_link( 'self', rest_url( '/test/notembeddable' ), array( 'embeddable' => true ) );
+                // 'self' should not be special-cased, and may be marked embeddable.
+                $response->add_link( 'self', rest_url( '/test/embeddable' ), array( 'embeddable' => true ) );
+
+                $data = rest_get_server()->response_to_data( $response, true );
+
+                $this->assertArrayHasKey( '_embedded', $data );
+        }
+
+        /**
+         * @depends test_link_embedding
+         * @ticket 47684
+         */
+        public function test_link_embedding_self_non_embeddable() {
+                // Register our testing route.
+                rest_get_server()->register_route(
+                        'test',
+                        '/test/embeddable',
+                        array(
+                                'methods'  => 'GET',
+                                'callback' => array( $this, 'embedded_response_callback' ),
+                        )
+                );
+                $response = new WP_REST_Response();
+
+                // 'self' should not be special-cased, and should be ignored if not marked embeddable.
+                $response->add_link( 'self', rest_url( '/test/notembeddable' ) );
 
                 $data = rest_get_server()->response_to_data( $response, true );