Changeset 38689

Timestamp:

09/30/2016 08:11:10 PM (8 years ago)

Author:

joehoyle

Message:

REST API: Add filters to allow creating REST API middleware plugins.

Introduce two new filters: rest_request_before_callbacks and rest_request_after_callbacks to
assist REST API middleware plugins to perform pre-callback and cleanup hooks such as switch_to_blog()
or caching implementations.

Props jnylen0.
Fixes #35590.

File:

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

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

@@ -874 +874 @@
                     }
                 }
+
+                /**
+                 * Call a filter before executing any REST API callbacks.
+                 *
+                 * Allows plugins to perform additional validation after a
+                 * request is initialized and matched to a registered route,
+                 * but before it is executed.
+                 *
+                 * Note that this filter will not be called for requests that
+                 * fail to authenticate or match to a registered route.
+                 *
+                 * @since 4.7.0
+                 *
+                 * @param WP_HTTP_Response $response Result to send to the client. Usually a WP_REST_Response.
+                 * @param WP_REST_Server   $handler  ResponseHandler instance (usually WP_REST_Server).
+                 * @param WP_REST_Request  $request  Request used to generate the response.
+                 */
+                $response = apply_filters( 'rest_request_before_callbacks', $response, $handler, $request );
 
                 if ( ! is_wp_error( $response ) ) {
@@ -911 +929 @@
                     }
                 }
+
+                /**
+                 * Call a filter immediately after executing any REST API
+                 * callbacks.
+                 *
+                 * Allows plugins to perform any needed cleanup, for example,
+                 * to undo changes made during `rest_request_before_callbacks`.
+                 *
+                 * Note that this filter will not be called for requests that
+                 * fail to authenticate or match to a registered route.
+                 *
+                 * Note that an endpoint's `permission_callback` can still be
+                 * called after this filter - see the `rest_send_allow_header`
+                 * function.
+                 *
+                 * @since 4.7.0
+                 *
+                 * @param WP_HTTP_Response $response Result to send to the client. Usually a WP_REST_Response.
+                 * @param WP_REST_Server   $handler  ResponseHandler instance (usually WP_REST_Server).
+                 * @param WP_REST_Request  $request  Request used to generate the response.
+                 */
+                $response = apply_filters( 'rest_request_after_callbacks', $response, $handler, $request );
 
                 if ( is_wp_error( $response ) ) {