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
426            * Allows modification of the response before returning.
427            *
428            * @since 4.4.0
429            * @since 4.5.0 Applied to embedded responses.
430            *
431            * @param WP_HTTP_Response $result  Result to send to the client. Usually a `WP_REST_Response`.
432            * @param WP_REST_Server   $server  Server instance.
433            * @param WP_REST_Request  $request Request used to generate the response.
434            */
435           $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $request );
436
437           // Wrap the response in an envelope if asked for.
438           if ( isset( $_GET['_envelope'] ) ) {
439                $result = $this->envelope_response( $result, isset( $_GET['_embed'] ) );
440           }
441
442           // Send extra data from response objects.
443           $headers = $result->get_headers();
444           $this->send_headers( $headers );
 
Line Code
690
691                          // Embedded resources get passed context=embed.
692                          if ( empty( $request['context'] ) ) {
693                               $request['context'] = 'embed';
694                          }
695
696                          $response = $this->dispatch( $request );
697
698                          /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
699                          $response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $this, $request );
700
701                          $this->embed_cache[ $item['href'] ] = $this->response_to_data( $response, false );
702                     }
703
704                     $embeds[] = $this->embed_cache[ $item['href'] ];
705                }
706
707                // Determine if any real links were found.
708                $has_links = count( array_filter( $embeds ) );
 
Line Code
1597                                    array( 'status' => 500 )
1598                               );
1599                          }
1600
1601                          $result = $this->respond_to_request( $single_request, $route, $handler, $error );
1602                     }
1603                }
1604
1605                /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
1606                $result = apply_filters( 'rest_post_dispatch', rest_ensure_response( $result ), $this, $single_request );
1607
1608                $responses[] = $this->envelope_response( $result, false )->get_data();
1609           }
1610
1611           return new WP_REST_Response( array( 'responses' => $responses ), WP_Http::MULTI_STATUS );
1612      }
1613
1614      /**
1615       * Sends an HTTP status code.