Menu Adam R Brown

WP hooks navigation: Home/browseActions indexFilters index

Source View: rest_post_dispatch

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

This hook occurs 2 times in this file.

Line Code
340            * Allows modification of the response before returning.
341            *
342            * @since 4.4.0
343            * @since 4.5.0 Applied to embedded responses.
344            *
345            * @param WP_HTTP_Response $result  Result to send to the client. Usually a WP_REST_Response.
346            * @param WP_REST_Server   $this    Server instance.
347            * @param WP_REST_Request  $request Request used to generate the response.
348            */
349           $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $request );
350
351           // Wrap the response in an envelope if asked for.
352           if ( isset( $_GET['_envelope'] ) ) {
353                $result = $this->envelope_response( $result, isset( $_GET['_embed'] ) );
354           }
355
356           // Send extra data from response objects.
357           $headers = $result->get_headers();
358           $this->send_headers( $headers );
 
Line Code
572
573                     // Embedded resources get passed context=embed.
574                     if ( empty( $request['context'] ) ) {
575                          $request['context'] = 'embed';
576                     }
577
578                     $response = $this->dispatch( $request );
579
580                     /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
581                     $response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $this, $request );
582
583                     $embeds[] = $this->response_to_data( $response, false );
584                }
585
586                // Determine if any real links were found.
587                $has_links = count( array_filter( $embeds ) );
588                if ( $has_links ) {
589                     $embedded[ $rel ] = $embeds;
590                }