WP_REST_Server

Hooks fired · 24

Every hook that fires from inside WP_REST_Server, in the order it appears in the class, grouped by the method that fires it.

Properties · 5

$namespacesarrayprotected

Namespaces registered to the server.

$endpointsarrayprotected

Endpoints registered to the server.

$route_optionsarrayprotected

Options defined for the routes.

$embed_cachearrayprotected

Caches embedded requests.

$dispatching_requestsarrayprotected

Stores request objects that are currently being handled.

Methods · 37

• __construct()Instantiates the REST server.
• check_authentication()Checks the authentication headers if supplied.
• error_to_response()Converts an error to a response object.
• json_error()Retrieves an appropriate error representation in JSON.
• get_json_encode_options()Gets the encoding options passed to {@see wp_json_encode}.
• serve_request()Handles serving a REST API request.
• response_to_data()Converts a response to data to send.
• get_response_links()Retrieves links from a response.
• get_target_hints_for_link()Gets the target links for a REST API Link.
• get_compact_response_links()Retrieves the CURIEs (compact URIs) used for relations.
• embed_links()Embeds the links from the data into the request.
• envelope_response()Wraps the response in an envelope.
• register_route()Registers a route to the server.
• get_routes()Retrieves the route map.
• get_namespaces()Retrieves namespaces registered on the server.
• get_route_options()Retrieves specified options for a route.
• dispatch()Matches the request to a callback and call it.
• is_dispatching()Returns whether the REST server is currently dispatching / responding to a request.
• match_request_to_handler()Matches a request object to its handler.
• respond_to_request()Dispatches the request to the callback handler.
• get_json_last_error()Returns if an error occurred during most recent JSON encode/decode.
• get_index()Retrieves the site index.
• add_active_theme_link_to_index()Adds a link to the active theme for users who have proper permissions.
• add_site_logo_to_index()Exposes the site logo through the WordPress REST API.
• add_site_icon_to_index()Exposes the site icon through the WordPress REST API.
• add_image_to_index()Exposes an image through the WordPress REST API.
• get_namespace_index()Retrieves the index for a namespace.
• get_data_for_routes()Retrieves the publicly-visible data for routes.
• get_data_for_route()Retrieves publicly-visible data for the route.
• get_max_batch_size()Gets the maximum number of requests that can be included in a batch.
• serve_batch_request_v1()Serves the batch/v1 request.
• set_status()Sends an HTTP status code.
• send_header()Sends an HTTP header.
• send_headers()Sends multiple HTTP headers.
• remove_header()Removes an HTTP header from the current response.
• get_raw_data()Retrieves the raw request entity (body).
• get_headers()Extracts headers from a PHP-style $_SERVER array.

Source

View on Trac ↗View on GitHub ↗

15#[AllowDynamicProperties]16class WP_REST_Server {17 18	/**19	 * Alias for GET transport method.20	 *21	 * @since 4.4.022	 * @var string23	 */24	const READABLE = 'GET';25 26	/**27	 * Alias for POST transport method.28	 *29	 * @since 4.4.030	 * @var string31	 */32	const CREATABLE = 'POST';33 34	/**35	 * Alias for POST, PUT, PATCH transport methods together.36	 *37	 * @since 4.4.038	 * @var string39	 */40	const EDITABLE = 'POST, PUT, PATCH';41 42	/**43	 * Alias for DELETE transport method.44	 *45	 * @since 4.4.046	 * @var string47	 */48	const DELETABLE = 'DELETE';49 50	/**51	 * Alias for GET, POST, PUT, PATCH & DELETE transport methods together.52	 *53	 * @since 4.4.054	 * @var string55	 */56	const ALLMETHODS = 'GET, POST, PUT, PATCH, DELETE';57 58	/**59	 * Namespaces registered to the server.60	 *61	 * @since 4.4.062	 * @var array63	 */64	protected $namespaces = array();65 66	/**67	 * Endpoints registered to the server.68	 *69	 * @since 4.4.070	 * @var array71	 */72	protected $endpoints = array();73 74	/**75	 * Options defined for the routes.76	 *77	 * @since 4.4.078	 * @var array79	 */80	protected $route_options = array();81 82	/**83	 * Caches embedded requests.84	 *85	 * @since 5.4.086	 * @var array87	 */88	protected $embed_cache = array();89 90	/**91	 * Stores request objects that are currently being handled.92	 *93	 * @since 6.5.094	 * @var array

History

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/rest-api/class-wp-rest-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.