| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
REST API functions.
| File Size: | 3341 lines (96 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| register_rest_route( $namespace, $route, $args = array() X-Ref |
| Registers a REST API route. Note: Do not use before the {@see 'rest_api_init'} hook. return: bool True on success, false on error. param: string $namespace The first URL segment after core prefix. Should be unique to your package/plugin. param: string $route The base URL for route you are adding. param: array $args Optional. Either an array of options for the endpoint, or an array of arrays for param: bool $override Optional. If the route already exists, should we override it? True overrides, since: 4.4.0 since: 5.1.0 Added a `_doing_it_wrong()` notice when not called on or after the `rest_api_init` hook. since: 5.5.0 Added a `_doing_it_wrong()` notice when the required `permission_callback` argument is not set. |
| register_rest_field( $object_type, $attribute, $args = array() X-Ref |
| Registers a new field on an existing WordPress object type. param: string|array $object_type Object(s) the field is being registered to, param: string $attribute The attribute name. param: array $args { since: 4.7.0 |
| rest_api_init() X-Ref |
| Registers rewrite rules for the REST API. since: 4.4.0 |
| rest_api_register_rewrites() X-Ref |
| Adds REST rewrite rules. since: 4.4.0 |
| rest_api_default_filters() X-Ref |
| Registers the default REST API filters. Attached to the {@see 'rest_api_init'} action to make testing and disabling these filters easier. since: 4.4.0 |
| create_initial_rest_routes() X-Ref |
| Registers default REST API routes. since: 4.7.0 |
| rest_api_loaded() X-Ref |
| Loads the REST API. since: 4.4.0 |
| rest_get_url_prefix() X-Ref |
| Retrieves the URL prefix for any API resource. return: string Prefix. since: 4.4.0 |
| get_rest_url( $blog_id = null, $path = '/', $scheme = 'rest' ) X-Ref |
| Retrieves the URL to a REST endpoint on a site. Note: The returned URL is NOT escaped. return: string Full URL to the endpoint. param: int|null $blog_id Optional. Blog ID. Default of null returns URL for current blog. param: string $path Optional. REST route. Default '/'. param: string $scheme Optional. Sanitization scheme. Default 'rest'. since: 4.4.0 |
| rest_url( $path = '', $scheme = 'rest' ) X-Ref |
| Retrieves the URL to a REST endpoint. Note: The returned URL is NOT escaped. return: string Full URL to the endpoint. param: string $path Optional. REST route. Default empty. param: string $scheme Optional. Sanitization scheme. Default 'rest'. since: 4.4.0 |
| rest_do_request( $request ) X-Ref |
| Do a REST request. Used primarily to route internal requests through WP_REST_Server. return: WP_REST_Response REST response. param: WP_REST_Request|string $request Request. since: 4.4.0 |
| rest_get_server() X-Ref |
| Retrieves the current REST server instance. Instantiates a new instance if none exists already. return: WP_REST_Server REST server instance. since: 4.5.0 |
| rest_ensure_request( $request ) X-Ref |
| Ensures request arguments are a request object (for consistency). return: WP_REST_Request REST request instance. param: array|string|WP_REST_Request $request Request to check. since: 4.4.0 since: 5.3.0 Accept string argument for the request path. |
| rest_ensure_response( $response ) X-Ref |
| Ensures a REST response is a response object (for consistency). This implements WP_REST_Response, allowing usage of `set_status`/`header`/etc without needing to double-check the object. Will also allow WP_Error to indicate error responses, so users should immediately check for this value. return: WP_REST_Response|WP_Error If response generated an error, WP_Error, if response param: WP_REST_Response|WP_Error|WP_HTTP_Response|mixed $response Response to check. since: 4.4.0 |
| rest_handle_deprecated_function( $function, $replacement, $version ) X-Ref |
| Handles _deprecated_function() errors. param: string $function The function that was called. param: string $replacement The function that should have been called. param: string $version Version. since: 4.4.0 |
| rest_handle_deprecated_argument( $function, $message, $version ) X-Ref |
| Handles _deprecated_argument() errors. param: string $function The function that was called. param: string $message A message regarding the change. param: string $version Version. since: 4.4.0 |
| rest_handle_doing_it_wrong( $function, $message, $version ) X-Ref |
| Handles _doing_it_wrong errors. param: string $function The function that was called. param: string $message A message explaining what has been done incorrectly. param: string|null $version The version of WordPress where the message was added. since: 5.5.0 |
| rest_send_cors_headers( $value ) X-Ref |
| Sends Cross-Origin Resource Sharing headers with API requests. return: mixed Response data. param: mixed $value Response data. since: 4.4.0 |
| rest_handle_options_request( $response, $handler, $request ) X-Ref |
| Handles OPTIONS requests for the server. This is handled outside of the server code, as it doesn't obey normal route mapping. return: WP_REST_Response Modified response, either response or `null` to indicate pass-through. param: mixed $response Current response, either response or `null` to indicate pass-through. param: WP_REST_Server $handler ResponseHandler instance (usually WP_REST_Server). param: WP_REST_Request $request The request that was used to make current response. since: 4.4.0 |
| rest_send_allow_header( $response, $server, $request ) X-Ref |
| Sends the "Allow" header to state all methods that can be sent to the current route. return: WP_REST_Response Response to be served, with "Allow" header if route has allowed methods. param: WP_REST_Response $response Current response being served. param: WP_REST_Server $server ResponseHandler instance (usually WP_REST_Server). param: WP_REST_Request $request The request that was used to make current response. since: 4.4.0 |
| _rest_array_intersect_key_recursive( $array1, $array2 ) X-Ref |
| Recursively computes the intersection of arrays using keys for comparison. return: array An associative array containing all the entries of array1 which have keys param: array $array1 The array with master keys to check. param: array $array2 An array to compare keys against. since: 5.3.0 |
| rest_filter_response_fields( $response, $server, $request ) X-Ref |
| Filters the REST API response to include only a white-listed set of response object fields. return: WP_REST_Response Response to be served, trimmed down to contain a subset of fields. param: WP_REST_Response $response Current response being served. param: WP_REST_Server $server ResponseHandler instance (usually WP_REST_Server). param: WP_REST_Request $request The request that was used to make current response. since: 4.8.0 |
| rest_is_field_included( $field, $fields ) X-Ref |
| Given an array of fields to include in a response, some of which may be `nested.fields`, determine whether the provided field should be included in the response body. If a parent field is passed in, the presence of any nested field within that parent will cause the method to return `true`. For example "title" will return true if any of `title`, `title.raw` or `title.rendered` is provided. return: bool Whether to include the field or not. param: string $field A field to test for inclusion in the response body. param: array $fields An array of string fields supported by the endpoint. since: 5.3.0 |
| rest_output_rsd() X-Ref |
| Adds the REST API URL to the WP RSD endpoint. since: 4.4.0 |
| rest_output_link_wp_head() X-Ref |
| Outputs the REST API link tag into page header. since: 4.4.0 |
| rest_output_link_header() X-Ref |
| Sends a Link header for the REST API. since: 4.4.0 |
| rest_cookie_check_errors( $result ) X-Ref |
| Checks for errors when using cookie-based authentication. WordPress' built-in cookie authentication is always active for logged in users. However, the API has to check nonces for each request to ensure users are not vulnerable to CSRF. return: WP_Error|mixed|bool WP_Error if the cookie is invalid, the $result, otherwise true. param: WP_Error|mixed $result Error from another authentication handler, since: 4.4.0 |
| rest_cookie_collect_status() X-Ref |
| Collects cookie authentication status. Collects errors from wp_validate_auth_cookie for use by rest_cookie_check_errors. since: 4.4.0 |
| rest_application_password_collect_status( $user_or_error, $app_password = array() X-Ref |
| Collects the status of authenticating with an application password. param: WP_Error $user_or_error The authenticated user or error instance. param: array $app_password The Application Password used to authenticate. since: 5.6.0 since: 5.7.0 Added the `$app_password` parameter. |
| rest_get_authenticated_app_password() X-Ref |
| Gets the Application Password used for authenticating the request. return: string|null The Application Password UUID, or null if Application Passwords was not used. since: 5.7.0 |
| rest_application_password_check_errors( $result ) X-Ref |
| Checks for errors when using application password-based authentication. return: WP_Error|null|true WP_Error if the application password is invalid, the $result, otherwise true. param: WP_Error|null|true $result Error from another authentication handler, since: 5.6.0 |
| rest_add_application_passwords_to_index( $response ) X-Ref |
| Adds Application Passwords info to the REST API index. return: WP_REST_Response param: WP_REST_Response $response The index response object. since: 5.6.0 |
| rest_get_avatar_urls( $id_or_email ) X-Ref |
| Retrieves the avatar urls in various sizes. return: array Avatar URLs keyed by size. Each value can be a URL string or boolean false. param: mixed $id_or_email The Gravatar to retrieve a URL for. Accepts a user_id, gravatar md5 hash, since: 4.7.0 |
| rest_get_avatar_sizes() X-Ref |
| Retrieves the pixel sizes for avatars. return: int[] List of pixel sizes for avatars. Default `[ 24, 48, 96 ]`. since: 4.7.0 |
| rest_parse_date( $date, $force_utc = false ) X-Ref |
| Parses an RFC3339 time into a Unix timestamp. return: int Unix timestamp. param: string $date RFC3339 timestamp. param: bool $force_utc Optional. Whether to force UTC timezone instead of using since: 4.4.0 |
| rest_parse_hex_color( $color ) X-Ref |
| Parses a 3 or 6 digit hex color (with #). return: string|false param: string $color 3 or 6 digit hex color (with #). since: 5.4.0 |
| rest_get_date_with_gmt( $date, $is_utc = false ) X-Ref |
| Parses a date into both its local and UTC equivalent, in MySQL datetime format. return: array|null Local and UTC datetime strings, in MySQL datetime format (Y-m-d H:i:s), param: string $date RFC3339 timestamp. param: bool $is_utc Whether the provided date should be interpreted as UTC. Default false. since: 4.4.0 |
| rest_authorization_required_code() X-Ref |
| Returns a contextual HTTP error code for authorization failure. return: int 401 if the user is not logged in, 403 if the user is logged in. since: 4.7.0 |
| rest_validate_request_arg( $value, $request, $param ) X-Ref |
| Validate a request argument based on details registered to the route. return: true|WP_Error param: mixed $value param: WP_REST_Request $request param: string $param since: 4.7.0 |
| rest_sanitize_request_arg( $value, $request, $param ) X-Ref |
| Sanitize a request argument based on details registered to the route. return: mixed param: mixed $value param: WP_REST_Request $request param: string $param since: 4.7.0 |
| rest_parse_request_arg( $value, $request, $param ) X-Ref |
| Parse a request argument based on details registered to the route. Runs a validation check and sanitizes the value, primarily to be used via the `sanitize_callback` arguments in the endpoint args registration. return: mixed param: mixed $value param: WP_REST_Request $request param: string $param since: 4.7.0 |
| rest_is_ip_address( $ip ) X-Ref |
| Determines if an IP address is valid. Handles both IPv4 and IPv6 addresses. return: string|false The valid IP address, otherwise false. param: string $ip IP address. since: 4.7.0 |
| rest_sanitize_boolean( $value ) X-Ref |
| Changes a boolean-like value into the proper boolean value. return: bool Returns the proper associated boolean value. param: bool|string|int $value The value being evaluated. since: 4.7.0 |
| rest_is_boolean( $maybe_bool ) X-Ref |
| Determines if a given value is boolean-like. return: bool True if a boolean, otherwise false. param: bool|string $maybe_bool The value being evaluated. since: 4.7.0 |
| rest_is_integer( $maybe_integer ) X-Ref |
| Determines if a given value is integer-like. return: bool True if an integer, otherwise false. param: mixed $maybe_integer The value being evaluated. since: 5.5.0 |
| rest_is_array( $maybe_array ) X-Ref |
| Determines if a given value is array-like. return: bool param: mixed $maybe_array The value being evaluated. since: 5.5.0 |
| rest_sanitize_array( $maybe_array ) X-Ref |
| Converts an array-like value to an array. return: array Returns the array extracted from the value. param: mixed $maybe_array The value being evaluated. since: 5.5.0 |
| rest_is_object( $maybe_object ) X-Ref |
| Determines if a given value is object-like. return: bool True if object like, otherwise false. param: mixed $maybe_object The value being evaluated. since: 5.5.0 |
| rest_sanitize_object( $maybe_object ) X-Ref |
| Converts an object-like value to an object. return: array Returns the object extracted from the value. param: mixed $maybe_object The value being evaluated. since: 5.5.0 |
| rest_get_best_type_for_value( $value, $types ) X-Ref |
| Gets the best type for a value. return: string The best matching type, an empty string if no types match. param: mixed $value The value to check. param: array $types The list of possible types. since: 5.5.0 |
| rest_handle_multi_type_schema( $value, $args, $param = '' ) X-Ref |
| Handles getting the best type for a multi-type schema. This is a wrapper for {@see rest_get_best_type_for_value()} that handles backward compatibility for schemas that use invalid types. return: string param: mixed $value The value to check. param: array $args The schema array to use. param: string $param The parameter name, used in error messages. since: 5.5.0 |
| rest_validate_array_contains_unique_items( $array ) X-Ref |
| Checks if an array is made up of unique items. return: bool True if the array contains unique items, false otherwise. param: array $array The array to check. since: 5.5.0 |
| rest_stabilize_value( $value ) X-Ref |
| Stabilizes a value following JSON Schema semantics. For lists, order is preserved. For objects, properties are reordered alphabetically. return: mixed The stabilized value. param: mixed $value The value to stabilize. Must already be sanitized. Objects should have been converted to arrays. since: 5.5.0 |
| rest_validate_json_schema_pattern( $pattern, $value ) X-Ref |
| Validates if the JSON Schema pattern matches a value. return: bool True if the pattern matches the given value, false otherwise. param: string $pattern The pattern to match against. param: string $value The value to check. since: 5.6.0 |
| rest_find_matching_pattern_property_schema( $property, $args ) X-Ref |
| Finds the schema for a property using the patternProperties keyword. return: array|null The schema of matching pattern property, or null if no patterns match. param: string $property The property name to check. param: array $args The schema array to use. since: 5.6.0 |
| rest_format_combining_operation_error( $param, $error ) X-Ref |
| Formats a combining operation error into a WP_Error object. return: WP_Error param: string $param The parameter name. param: array $error The error details. since: 5.6.0 |
| rest_get_combining_operation_error( $value, $param, $errors ) X-Ref |
| Gets the error of combining operation. return: WP_Error The combining operation error. param: array $value The value to validate. param: string $param The parameter name, used in error messages. param: array $errors The errors array, to search for possible error. since: 5.6.0 |
| rest_find_any_matching_schema( $value, $args, $param ) X-Ref |
| Finds the matching schema among the "anyOf" schemas. return: array|WP_Error The matching schema or WP_Error instance if all schemas do not match. param: mixed $value The value to validate. param: array $args The schema array to use. param: string $param The parameter name, used in error messages. since: 5.6.0 |
| rest_find_one_matching_schema( $value, $args, $param, $stop_after_first_match = false ) X-Ref |
| Finds the matching schema among the "oneOf" schemas. return: array|WP_Error The matching schema or WP_Error instance if the number of matching schemas is not equal to one. param: mixed $value The value to validate. param: array $args The schema array to use. param: string $param The parameter name, used in error messages. param: bool $stop_after_first_match Optional. Whether the process should stop after the first successful match. since: 5.6.0 |
| rest_are_values_equal( $value1, $value2 ) X-Ref |
| Checks the equality of two values, following JSON Schema semantics. Property order is ignored for objects. Values must have been previously sanitized/coerced to their native types. return: bool True if the values are equal or false otherwise. param: mixed $value1 The first value to check. param: mixed $value2 The second value to check. since: 5.7.0 |
| rest_validate_enum( $value, $args, $param ) X-Ref |
| Validates that the given value is a member of the JSON Schema "enum". return: true|WP_Error True if the "enum" contains the value or a WP_Error instance otherwise. param: mixed $value The value to validate. param: array $args The schema array to use. param: string $param The parameter name, used in error messages. since: 5.7.0 |
| rest_get_allowed_schema_keywords() X-Ref |
| Get all valid JSON schema properties. return: string[] All valid JSON schema properties. since: 5.6.0 |
| rest_validate_value_from_schema( $value, $args, $param = '' ) X-Ref |
| Validate a value based on a schema. return: true|WP_Error param: mixed $value The value to validate. param: array $args Schema array to use for validation. param: string $param The parameter name, used in error messages. since: 4.7.0 since: 4.9.0 Support the "object" type. since: 5.2.0 Support validating "additionalProperties" against a schema. since: 5.3.0 Support multiple types. since: 5.4.0 Convert an empty string to an empty object. since: 5.5.0 Add the "uuid" and "hex-color" formats. since: 5.6.0 Support the "minProperties" and "maxProperties" keywords for objects. |
| rest_validate_null_value_from_schema( $value, $param ) X-Ref |
| Validates a null value based on a schema. return: true|WP_Error param: mixed $value The value to validate. param: string $param The parameter name, used in error messages. since: 5.7.0 |
| rest_validate_boolean_value_from_schema( $value, $param ) X-Ref |
| Validates a boolean value based on a schema. return: true|WP_Error param: mixed $value The value to validate. param: string $param The parameter name, used in error messages. since: 5.7.0 |
| rest_validate_object_value_from_schema( $value, $args, $param ) X-Ref |
| Validates an object value based on a schema. return: true|WP_Error param: mixed $value The value to validate. param: array $args Schema array to use for validation. param: string $param The parameter name, used in error messages. since: 5.7.0 |
| rest_validate_array_value_from_schema( $value, $args, $param ) X-Ref |
| Validates an array value based on a schema. return: true|WP_Error param: mixed $value The value to validate. param: array $args Schema array to use for validation. param: string $param The parameter name, used in error messages. since: 5.7.0 |
| rest_validate_number_value_from_schema( $value, $args, $param ) X-Ref |
| Validates a number value based on a schema. return: true|WP_Error param: mixed $value The value to validate. param: array $args Schema array to use for validation. param: string $param The parameter name, used in error messages. since: 5.7.0 |
| rest_validate_string_value_from_schema( $value, $args, $param ) X-Ref |
| Validates a string value based on a schema. return: true|WP_Error param: mixed $value The value to validate. param: array $args Schema array to use for validation. param: string $param The parameter name, used in error messages. since: 5.7.0 |
| rest_validate_integer_value_from_schema( $value, $args, $param ) X-Ref |
| Validates an integer value based on a schema. return: true|WP_Error param: mixed $value The value to validate. param: array $args Schema array to use for validation. param: string $param The parameter name, used in error messages. since: 5.7.0 |
| rest_sanitize_value_from_schema( $value, $args, $param = '' ) X-Ref |
| Sanitize a value based on a schema. return: mixed|WP_Error The sanitized value or a WP_Error instance if the value cannot be safely sanitized. param: mixed $value The value to sanitize. param: array $args Schema array to use for sanitization. param: string $param The parameter name, used in error messages. since: 4.7.0 since: 5.5.0 Added the `$param` parameter. since: 5.6.0 Support the "anyOf" and "oneOf" keywords. since: 5.9.0 Added `text-field` and `textarea-field` formats. |
| rest_preload_api_request( $memo, $path ) X-Ref |
| Append result of internal request to REST API for purpose of preloading data to be attached to a page. Expected to be called in the context of `array_reduce`. return: array Modified reduce accumulator. param: array $memo Reduce accumulator. param: string $path REST API path to preload. since: 5.0.0 |
| rest_parse_embed_param( $embed ) X-Ref |
| Parses the "_embed" parameter into the list of resources to embed. return: true|string[] Either true to embed all embeds, or a list of relations to embed. param: string|array $embed Raw "_embed" parameter value. since: 5.4.0 |
| rest_filter_response_by_context( $data, $schema, $context ) X-Ref |
| Filters the response to remove any fields not available in the given context. return: array|object The filtered response data. param: array|object $data The response data to modify. param: array $schema The schema for the endpoint used to filter the response. param: string $context The requested context. since: 5.5.0 since: 5.6.0 Support the "patternProperties" keyword for objects. |
| rest_default_additional_properties_to_false( $schema ) X-Ref |
| Sets the "additionalProperties" to false by default for all object definitions in the schema. return: array The modified schema. param: array $schema The schema to modify. since: 5.5.0 since: 5.6.0 Support the "patternProperties" keyword. |
| rest_get_route_for_post( $post ) X-Ref |
| Gets the REST API route for a post. return: string The route path with a leading slash for the given post, param: int|WP_Post $post Post ID or post object. since: 5.5.0 |
| rest_get_route_for_post_type_items( $post_type ) X-Ref |
| Gets the REST API route for a post type. return: string The route path with a leading slash for the given post type, param: string $post_type The name of a registered post type. since: 5.9.0 |
| rest_get_route_for_term( $term ) X-Ref |
| Gets the REST API route for a term. return: string The route path with a leading slash for the given term, param: int|WP_Term $term Term ID or term object. since: 5.5.0 |
| rest_get_route_for_taxonomy_items( $taxonomy ) X-Ref |
| Gets the REST API route for a taxonomy. return: string The route path with a leading slash for the given taxonomy. param: string $taxonomy Name of taxonomy. since: 5.9.0 |
| rest_get_queried_resource_route() X-Ref |
| Gets the REST route for the currently queried object. return: string The REST route of the resource, or an empty string if no resource identified. since: 5.5.0 |
| rest_get_endpoint_args_for_schema( $schema, $method = WP_REST_Server::CREATABLE ) X-Ref |
| Retrieves an array of endpoint arguments from the item schema and endpoint method. return: array The endpoint arguments. param: array $schema The full JSON schema for the endpoint. param: string $method Optional. HTTP method of the endpoint. The arguments for `CREATABLE` endpoints are since: 5.6.0 |
| rest_convert_error_to_response( $error ) X-Ref |
| Converts an error to a response object. This iterates over all error codes and messages to change it into a flat array. This enables simpler client behaviour, as it is represented as a list in JSON rather than an object/map. return: WP_REST_Response List of associative arrays with code and message keys. param: WP_Error $error WP_Error instance. since: 5.7.0 |
| Generated: Sat Apr 27 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |