Core class implementing the WordPress REST API server. Handles route registration, request dispatch, and response formatting.

Source: wp-includes/rest-api/class-wp-rest-server.php
Since: 4.4.0

Constants

Properties

Methods

__construct()

Instantiates the REST server with default routes.

public function __construct()

Registers default / (index) and /batch/v1 endpoints.

check_authentication()

Checks authentication headers.

public function check_authentication(): WP_Error|null|true

Returns:

• WP_Error if authentication error
• null if no authentication method used
• true if authentication succeeded

Triggers rest_authentication_errors filter.

serve_request()

Handles serving a REST API request.

public function serve_request( string $path = null ): null|false

Returns: null if served (or HEAD request), false on error.

Flow:

1. Sets up request from $_SERVER, $_GET, $_POST, $_FILES
2. Handles method override via _method param or X-HTTP-Method-Override header
3. Calls check_authentication()
4. Dispatches request
5. Applies rest_post_dispatch filter
6. Handles envelope (_envelope param)
7. Sends headers and JSON response

response_to_data()

Converts a response to data for sending.

public function response_to_data( WP_REST_Response $response, bool|string[] $embed ): array

Returns: Array with _links and optionally _embedded.

get_response_links() (static)

Extracts links from a response.

public static function get_response_links( WP_REST_Response $response ): array

Returns: Map of link relation to list of link hashes.

get_compact_response_links() (static)

Gets links with CURIE-shortened relations.

public static function get_compact_response_links( WP_REST_Response $response ): array

Returns: Links with wp: prefixes for WordPress relations.

envelope_response()

Wraps response in an envelope.

public function envelope_response( WP_REST_Response $response, bool|string[] $embed ): WP_REST_Response

Returns: Response with body, status, and headers data.

register_route()

Registers a route to the server.

public function register_route( string $route_namespace, string $route, array $route_args, bool $override = false ): void

Note: Use register_rest_route() wrapper function instead.

get_routes()

Retrieves the route map.

public function get_routes( string $route_namespace = '' ): array

Returns: Map of route regex to handlers.

get_namespaces()

Retrieves registered namespaces.

public function get_namespaces(): string[]

Returns: Array of namespace strings.

get_route_options()

Retrieves options for a route.

public function get_route_options( string $route ): array|null

Returns: Route options or null if not found.

dispatch()

Matches request to handler and calls it.

public function dispatch( WP_REST_Request $request ): WP_REST_Response

Returns: Response from the matched callback.

Flow:

1. Applies rest_pre_dispatch filter
2. Matches request to route
3. Validates and sanitizes parameters
4. Calls respond_to_request()

is_dispatching()

Checks if server is currently handling a request.

public function is_dispatching(): bool

Returns: true during dispatch, false otherwise.

Since: 6.5.0

match_request_to_handler() (protected)

Matches a request to its handler.

protected function match_request_to_handler( WP_REST_Request $request ): array|WP_Error

Returns: array( $route, $handler ) or WP_Error.

Error Codes:

• rest_no_route — No matching route found (404)

respond_to_request() (protected)

Dispatches request to the callback handler.

protected function respond_to_request( WP_REST_Request $request, string $route, array $handler, WP_Error|null $response ): WP_REST_Response

Returns: Response from callback.

Flow:

1. rest_request_before_callbacks filter
2. Calls permission_callback
3. rest_dispatch_request filter
4. Calls callback
5. rest_request_after_callbacks filter

get_index()

Retrieves the site index (root endpoint).

public function get_index( WP_REST_Request $request ): WP_REST_Response

Returns: Response with site info, namespaces, routes, authentication.

get_namespace_index()

Retrieves index for a namespace.

public function get_namespace_index( WP_REST_Request $request ): WP_REST_Response|WP_Error

Returns: Response with namespace routes or error if not found.

get_data_for_routes()

Retrieves publicly-visible data for routes.

public function get_data_for_routes( array $routes, string $context = 'view' ): array[]

Returns: Route data keyed by route.

get_data_for_route()

Retrieves publicly-visible data for a single route.

public function get_data_for_route( string $route, array $callbacks, string $context = 'view' ): array|null

Returns: Route data or null if hidden.

serve_batch_request_v1()

Serves batch API requests.

public function serve_batch_request_v1( WP_REST_Request $batch_request ): WP_REST_Response

Returns: Response with responses array (207 Multi-Status).

Request Format:

{
    "validation": "normal",
    "requests": [
        { "path": "/wp/v2/posts/1", "method": "PUT", "body": {}, "headers": {} }
    ]
}

Validation Modes:

• normal — Execute all, return individual results
• require-all-validate — Abort if any request fails validation

send_header()

Sends an HTTP header.

public function send_header( string $key, string $value ): void

send_headers()

Sends multiple HTTP headers.

public function send_headers( array $headers ): void

remove_header()

Removes an HTTP header.

public function remove_header( string $key ): void

Since: 4.8.0

get_raw_data() (static)

Retrieves raw request body.

public static function get_raw_data(): string

Returns: Raw php://input contents.

get_headers()

Extracts headers from $_SERVER array.

public function get_headers( array $server ): array

Returns: Extracted headers.

Handles:

• HTTP_* prefixed headers
• CONTENT_TYPE, CONTENT_LENGTH, CONTENT_MD5
• REDIRECT_HTTP_AUTHORIZATION fallback

Protected Methods

error_to_response()

Converts WP_Error to response object.

protected function error_to_response( WP_Error $error ): WP_REST_Response

json_error()

Gets JSON error representation.

protected function json_error( string $code, string $message, int|null $status = null ): string

get_json_encode_options()

Gets JSON encoding options.

protected function get_json_encode_options( WP_REST_Request $request ): int

Respects _pretty param for pretty printing.

embed_links()

Embeds links into response data.

protected function embed_links( array $data, bool|string[] $embed = true ): array

get_json_last_error()

Gets last JSON encoding error message.

protected function get_json_last_error(): false|string

set_status()

Sends HTTP status code.

protected function set_status( int $code ): void

get_max_batch_size()

Gets maximum batch request size.

protected function get_max_batch_size(): int

Returns: Default 25, filterable via rest_get_max_batch_size.

add_active_theme_link_to_index()

Adds active theme link to index response.

protected function add_active_theme_link_to_index( WP_REST_Response $response ): void

Since: 5.7.0

add_site_logo_to_index()

Adds site logo to index response.

protected function add_site_logo_to_index( WP_REST_Response $response ): void

Since: 5.8.0

add_site_icon_to_index()

Adds site icon to index response.

protected function add_site_icon_to_index( WP_REST_Response $response ): void

Since: 5.9.0

add_image_to_index()

Adds image data to index response.

protected function add_image_to_index( WP_REST_Response $response, int $image_id, string $type ): void

Since: 5.9.0

get_target_hints_for_link() (static)

Gets target hints for a link.

protected static function get_target_hints_for_link( array $link ): array|null

Since: 6.7.0