• Главная
• WP_REST_Server

PHP Класс WP_REST_Server, wordpress

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$endpoints	array	Endpoints registered to the server.
$namespaces	array	Namespaces registered to the server.
$route_options	array	Options defined for the routes.

Открытые методы

Метод	Описание
__construct ( )	Instantiates the REST server.
check_authentication ( ) : WP_Error | null	Checks the authentication headers if supplied.
dispatch ( WP_REST_Request $request ) : WP_REST_Response	Matches the request to a callback and call it.
envelope_response ( WP_REST_Response $response, boolean $embed ) : WP_REST_Response	Wraps the response in an envelope.
get_compact_response_links ( WP_REST_Response $response ) : array	Retrieves the CURIEs (compact URIs) used for relations.
get_data_for_route ( string $route, array $callbacks, string $context = 'view' ) : array | null	Retrieves publicly-visible data for the route.
get_data_for_routes ( array $routes, string $context = 'view' ) : array	Retrieves the publicly-visible data for routes.
get_headers ( array $server ) : array	Extracts headers from a PHP-style $_SERVER array.
get_index ( array $request ) : array	Retrieves the site index.
get_namespace_index ( WP_REST_Request $request ) : WP_REST_Response | WP_Error	Retrieves the index for a namespace.
get_namespaces ( ) : array	Retrieves namespaces registered on the server.
get_raw_data ( ) : string	Retrieves the raw request entity (body).
get_response_links ( WP_REST_Response $response ) : array	Retrieves links from a response.
get_route_options ( string $route ) : array | null	Retrieves specified options for a route.
get_routes ( ) : array	Retrieves the route map.
register_route ( string $namespace, string $route, array $route_args, boolean $override = false )	Registers a route to the server.
response_to_data ( WP_REST_Response $response, boolean $embed ) : array	Converts a response to data to send.
send_header ( string $key, string $value )	Sends an HTTP header.
send_headers ( array $headers )	Sends multiple HTTP headers.
serve_request ( string $path = null ) : false | null	Handles serving an API request.

Защищенные методы

Метод	Описание
embed_links ( array $data ) : array	Embeds the links from the data into the request.
error_to_response ( WP_Error $error ) : WP_REST_Response	Converts an error to a response object.
get_json_last_error ( ) : boolean | string	Returns if an error occurred during most recent JSON encode/decode.
json_error ( string $code, string $message, integer $status = null ) : string	Retrieves an appropriate error representation in JSON.
set_status ( integer $code )	Sends an HTTP status code.

Описание методов

Описание свойств