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 3 times in this file.

Line Code
456            * Allows modification of the response before returning.
457            *
458            * @since 4.4.0
459            * @since 4.5.0 Applied to embedded responses.
460            *
461            * @param WP_HTTP_Response $result  Result to send to the client. Usually a `WP_REST_Response`.
462            * @param WP_REST_Server   $server  Server instance.
463            * @param WP_REST_Request  $request Request used to generate the response.
464            */
465           $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $request );
466
467           // Wrap the response in an envelope if asked for.
468           if ( isset( $_GET['_envelope'] ) ) {
469                $embed  = isset( $_GET['_embed'] ) ? rest_parse_embed_param( $_GET['_embed'] ) : false;
470                $result = $this->envelope_response( $result, $embed );
471           }
472
473           // Send extra data from response objects.
474           $headers = $result->get_headers();
 
Line Code
722
723                          // Embedded resources get passed context=embed.
724                          if ( empty( $request['context'] ) ) {
725                               $request['context'] = 'embed';
726                          }
727
728                          $response = $this->dispatch( $request );
729
730                          /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
731                          $response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $this, $request );
732
733                          $this->embed_cache[ $item['href'] ] = $this->response_to_data( $response, false );
734                     }
735
736                     $embeds[] = $this->embed_cache[ $item['href'] ];
737                }
738
739                // Determine if any real links were found.
740                $has_links = count( array_filter( $embeds ) );
 
Line Code
1717                                    array( 'status' => 500 )
1718                               );
1719                          }
1720
1721                          $result = $this->respond_to_request( $single_request, $route, $handler, $error );
1722                     }
1723                }
1724
1725                /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
1726                $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $single_request );
1727
1728                $responses[] = $this->envelope_response( $result, false )->get_data();
1729           }
1730
1731           return new WP_REST_Response( array( 'responses' => $responses ), WP_Http::MULTI_STATUS );
1732      }
1733
1734      /**
1735       * Sends an HTTP status code.