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

Timestamp:

02/09/2020 08:52:06 PM (5 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.php (modified) (1 diff)

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

@@ -1572 +1572 @@
     return $memo;
 }
+
+/**
+ * Parses the "_embed" parameter into the list of resources to embed.
+ *
+ * @since 5.4.0
+ *
+ * @param string|array $embed Raw "_embed" parameter value.
+ * @return true|string[] Either true to embed all embeds, or a list of relations to embed.
+ */
+function rest_parse_embed_param( $embed ) {
+    if ( ! $embed || 'true' === $embed || '1' === $embed ) {
+        return true;
+    }
+
+    $rels = wp_parse_list( $embed );
+
+    if ( ! $rels ) {
+        return true;
+    }
+
+    return $rels;
+}