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

Timestamp:

02/09/2020 08:52:06 PM (7 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Introduce selective link embedding.

Previously the _embed flag would embed all embeddable links in a response even if only a subset of the links were necessary. Now, a list of link relations can be passed in the _embed parameter to restrict the list of embedded objects.

Props rheinardkorf, adamsilverstein, jnylen0, cklosows, chrisvanpatten, TimothyBlynJacobs.
Fixes #39696.

File:

• trunk/src/wp-includes/rest-api/class-wp-rest-server.php (modified) (6 diffs)

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

@@ -399 +399 @@
 
                         // Embed links inside the request.
-                        $result = $this->response_to_data( $result, isset( $_GET['_embed'] ) );
+                        $embed  = isset( $_GET['_embed'] ) ? rest_parse_embed_param( $_GET['_embed'] ) : false;
+                        $result = $this->response_to_data( $result, $embed );
 
                         /**
@@ -451 +452 @@
          *
          * @since 4.4.0
+         * @since 5.4.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 array {
          *     Data with sub-requests embedded.
@@ -474 +476 @@
                         // Determine if this is a numeric array.
                         if ( wp_is_numeric_array( $data ) ) {
-                                $data = array_map( array( $this, 'embed_links' ), $data );
+                                foreach ( $data as $key => $item ) {
+                                        $data[ $key ] = $this->embed_links( $item, $embed );
+                                }
                         } else {
-                                $data = $this->embed_links( $data );
+                                $data = $this->embed_links( $data, $embed );
                         }
                         $this->embed_cache = array();
@@ -572 +576 @@
          *
          * @since 4.4.0
-         *
-         * @param array $data Data from the request.
+         * @since 5.4.0 The $embed parameter can now contain a list of link relations to include.
+         *
+         * @param array         $data  Data from the request.
+         * @param bool|string[] $embed Whether to embed all links or a filtered list of link relations.
          * @return array {
          *     Data with sub-requests embedded.
@@ -581 +587 @@
          * }
          */
-        protected function embed_links( $data ) {
+        protected function embed_links( $data, $embed = true ) {
                 if ( empty( $data['_links'] ) ) {
                         return $data;
@@ -589 +595 @@
 
                 foreach ( $data['_links'] as $rel => $links ) {
+                        // If a list of relations was specified, and the link relation is not in the whitelist, don't process the link.
+                        if ( is_array( $embed ) && ! in_array( $rel, $embed, true ) ) {
+                                continue;
+                        }
+
                         $embeds = array();