Changeset 43763

Timestamp:

10/19/2018 08:56:58 AM (6 years ago)

Author:

pento

Message:

REST API: Introduce the rest_preload_api_request() function.

This function helps perform multiple REST API requests, for the purpose of preloading data into a page.

See #45110.

Location:

branches/5.0

Files:

• src/wp-includes/rest-api.php (modified) (1 diff)
• tests/phpunit/tests/rest-api.php (modified) (1 diff)

branches/5.0/src/wp-includes/rest-api.php

@@ -1312 +1312 @@
     return $value;
 }
+
+/**
+ * Append result of internal request to REST API for purpose of preloading data to be attached to a page.
+ * Expected to be called in the context of `array_reduce`.
+ *
+ * @since 5.0.0
+ *
+ * @param  array  $memo Reduce accumulator.
+ * @param  string $path REST API path to preload.
+ * @return array        Modified reduce accumulator.
+ */
+function rest_preload_api_request( $memo, $path ) {
+    // array_reduce() doesn't support passing an array in PHP 5.2, so we need to make sure we start with one.
+    if ( ! is_array( $memo ) ) {
+        $memo = array();
+    }
+
+    if ( empty( $path ) ) {
+        return $memo;
+    }
+
+    $path_parts = parse_url( $path );
+    if ( false === $path_parts ) {
+        return $memo;
+    }
+
+    $request = new WP_REST_Request( 'GET', $path_parts['path'] );
+    if ( ! empty( $path_parts['query'] ) ) {
+        parse_str( $path_parts['query'], $query_params );
+        $request->set_query_params( $query_params );
+    }
+
+    $response = rest_do_request( $request );
+    if ( 200 === $response->status ) {
+        $server = rest_get_server();
+        $data   = (array) $response->get_data();
+        if ( method_exists( $server, 'get_compact_response_links' ) ) {
+            $links = call_user_func( array( $server, 'get_compact_response_links' ), $response );
+        } else {
+            $links = call_user_func( array( $server, 'get_response_links' ), $response );
+        }
+        if ( ! empty( $links ) ) {
+            $data['_links'] = $links;
+        }
+
+        $memo[ $path ] = array(
+            'body'    => $data,
+            'headers' => $response->headers,
+        );
+    }
+
+    return $memo;
+}

branches/5.0/tests/phpunit/tests/rest-api.php

@@ -594 +594 @@
         $this->assertEquals( $routes['/test-ns/test'][0]['methods'], array( 'GET' => true ) );
     }
+
+    /**
+     * Ensure rest_preload_api_request() works without notices in PHP 5.2.
+     *
+     * The array_reduce() function only accepts mixed variables starting with PHP 5.3.
+     */
+    function test_rest_preload_api_request_no_notices_php_52() {
+        $this->assertTrue( is_array( rest_preload_api_request( 0, '/' ) ) );
+    }
 }