This document details changes to the WP REST API since its public release in version 4.7.0.<\/p>\n
multipleOf<\/code> JSON Schema keyword. r49063<\/a><\/li>\n- Support the
minProperties<\/code> and maxProperties<\/code> JSON Schema keywords. r49053<\/a><\/li>\n- Support the
patternProperties<\/code> JSON Schema keyword. r49082<\/a><\/li>\n- Support the
anyOf<\/code> and oneOf<\/code> JSON Schema keywords. r49246<\/a><\/li>\n- Make sure all supported JSON Schema keywords are output in the index. r49257<\/a><\/li>\n
- Add HTTP\/1.1 emulation to
wp.apiRequest<\/code>. r49133<\/a><\/li>\n- Include a JSON
Accept<\/code> header in wp.apiRequest<\/code>. r49716<\/a><\/li>\n- Don’t validate the post status if it hasn’t changed. r49302<\/a><\/li>\n
- Support generating comment up links to custom posts controllers. r49299<\/a><\/li>\n<\/ul>\n
Version 5.5<\/h2>\n\n- Introduce Block Types endpoint. r48173<\/a><\/li>\n
- Introduce Plugins and Block Directory endpoints. r48242<\/a><\/li>\n
- Introduce Image Editor endpoint. r48291<\/a><\/li>\n
- Add additional fields to the Themes endpoint. r47921<\/a><\/li>\n
- Introduce
register_theme_feature()<\/code> API for use in the Themes endpoint. r48171<\/a> <\/li>\n- Allow POST requests to the Block Renderer endpoint. r47756<\/a><\/li>\n
- Register only a single Block Renderer endpoint shared by all block types. r48069<\/a><\/li>\n
- Add support for classic embeds to the oEmbed endpoint. r48135<\/a><\/li>\n
- Link to the REST route for the currently queried resource. r48273<\/a><\/li>\n
- Introduce support for default metadata values. r48402<\/a><\/li>\n
- Add the
Link<\/code> header to the list of exposed cors headers. 48112<\/a><\/li>\n- Add
Content-Disposition<\/code>, Content-MD5<\/code> and X-WP-Nonce<\/code> as allowed cors headers. r48452<\/a><\/li>\n- Improve multi-type JSON Schema support. r48306<\/a><\/li>\n
- Only validate the
format<\/code> keyword if the type<\/code> is a string<\/code>. r48300<\/a><\/li>\n- Support the
uuid<\/code> JSON Schema format. 47753<\/a><\/li>\n- Support the
hex-color<\/code> JSON Schema format. r47450<\/a><\/li>\n- Support the
pattern<\/code> JSON Schema keyword. r47810<\/a><\/li>\n- Support the
minItems<\/code>, maxItems<\/code>, and uniqueItems<\/code> JSON Schema keywords. r47923<\/a> r48357<\/a><\/li>\n- Support the
minLength<\/code> and maxLength<\/code> JSON Schema keywords. r47627<\/a><\/li>\n- Check required properties are provided when validating an object. r47809<\/a><\/li>\n
- Support more JSON Schemas when filtering a response by context. r47758<\/a><\/li>\n
- Handle parameter types consistently within
WP_REST_Request::set_param()<\/code>. r47559<\/a><\/li>\n- Deprecate back-filling of the
HTTP_RAW_POST_DATA<\/code> global variable. r47926<\/a><\/li>\n- Issue a
_doing_it_wrong<\/code> when registering a route without a permission_callback<\/code>. r48526<\/a><\/li>\n- Issue a
_doing_it_wrong<\/code> when using the wp_send_json()<\/code> family of functions during a REST API request. r48361<\/a><\/li>\n- Ensure
rest_ensure_response()<\/code> upgrades WP_HTTP_Response<\/code> to WP_REST_Response<\/code>. r47849<\/a><\/li>\n- Only force the main query to be
is_home()<\/code> during a REST API request. r48053<\/a><\/li>\n- Ensure all keywords supported by the JSON Schema validator are permitted by
WP_REST_Controller::get_endpoint_args_for_item_schema()<\/code>. r47911<\/a><\/li>\n- Ensure deprecation notices are triggered when preloading REST API data. r48150<\/a><\/li>\n
- See REST API changes in WordPress 5.5<\/a> for further commentary.<\/li>\n<\/ul>\n
Version 5.4<\/h2>\n\n- Introduce selective link embedding. r47224<\/a><\/li>\n
- Fix PHP warning in the comments controller if the commented-upon post type does not exist. [r47036](https:\/\/core.trac.wordpress.org\/changeset\/47036]<\/li>\n
- Add
_doing_it_wrong<\/code> warning when registering an “array” setting without an items schema. r47325<\/a><\/li>\n- Correctly infer empty objects passed via query parameters. r47362<\/a><\/li>\n
- Add a “tax_relation” parameter to the posts collection. r46646<\/a><\/li>\n
- Allow meta to be set when creating a new media record via REST. r47261<\/a><\/li>\n
- Permit access to the themes controller if the user can edit any post type. r47361<\/a>.<\/li>\n
- Add support for the
REDIRECT_HTTP_AUTHORIZATION<\/code> header. r47239<\/a><\/li>\n- Add support for filtering the posts controller’s schema. r47265<\/a><\/li>\n
- Add
_doing_it_wrong<\/code> warning if a taxonomy’s specified rest_base<\/code> is already in use by a different resource. r47037<\/a><\/li>\n- Improve routing performance by matching REST API routes on namespace before performing regex checks. r47260<\/a><\/li>\n
- Don’t assume all item schemas have properties. r47328<\/a><\/li>\n
- Imrove performance by reusing previously-generated embedded objects when building collection response. r47138<\/a><\/li>\n
- List all core theme feature support details in
\/themes<\/code> endpoint response. r47258<\/a><\/li>\n- Fix links format in
OPTIONS<\/code> requests for non-variable routes. r47326<\/a><\/li>\n- Apply all relevant block rendering filters when rendering block previews. r47360<\/a><\/li>\n<\/ul>\n
Version 5.3<\/h2>\n\n- Cache results of
get_item_schema<\/code> on controller instances for performance. r45811<\/a><\/li>\n- Permit embedding of the
self<\/code> link relation in the search endpoint. r46434<\/a><\/li>\n- Pass
null<\/code> as the post date property to reset post to initial “floating” date value. r46249<\/a><\/li>\n- Prevent deletion of post revisions. r45812<\/a><\/li>\n
- Do not send response body if status is
204<\/code> or body is null<\/code>. r45809<\/a><\/li>\n- Support
object<\/code> and array<\/code> types in register_meta()<\/code> schemas. r45807<\/a><\/li>\n- Support dot.nested hierarchical properties in
_fields<\/code> query parameter. r46184<\/a><\/li>\n- Return term resources in
edit<\/code> context after PUT<\/code> or POST<\/code> request. r46098<\/a><\/li>\n- Introduce
date_floating<\/code> property on status endpoint response objects. r46252<\/a><\/li>\n<\/ul>\nVersion 5.2<\/h2>\n\n- Fix undefined property notice when setting parent term to 0. r44965<\/a><\/li>\n
- Remove unused
validate_user_can_query_private_statuses()<\/code> attachments controller method. r44934<\/a><\/li>\n- Ensure “Allow” header is returned for OPTIONS requests. r44933<\/a><\/li>\n
- Always pass query arguments through
urlencode_deep()<\/code> in get_items()<\/code> methods to ensure they are encoded correctly. r45267<\/a><\/li>\n<\/ul>\nVersion 5.1<\/h2>\n\n- Introduce
rest_post_search_query<\/code> filter to allow query arguments to be manipulated for a post search query. r44482<\/a><\/li>\n- Allow changing of letter casing in user email addresses. r44641<\/a><\/li>\n
- Trigger a
_doing_it_wrong()<\/code> warning if register_rest_route()<\/code> is called before the rest_api_init<\/code> hook. r44568<\/a><\/li>\n<\/ul>\nVersion 5.0<\/h2>\n\n- New Routes & Endpoints\n
\n- Introduce
wp\/v2\/search<\/code> route implementing a new WP_REST_Search_Controller<\/code>. Search types are handled by extending WP_REST_Search_Handler<\/code>, and the active search type may be filtered using the wp_rest_search_handlers<\/code> filter. #39965<\/a><\/li>\n- Introduce
wp\/v2\/blocks<\/code> route to retrieve individual reusable blocks. Requires authentication. #45098<\/a><\/li>\n- Introduce autosaves endpoints for all post types except
attachment<\/code>. Autosaves endpoints utilize the new WP_REST_Autosaves_Controller<\/code> class, and saves only the id<\/code>, title<\/code>, post_content<\/code> and excerpt<\/code> for a post. Autosaves are enabled even for post types which do not support revisions. Requires authentication. #43316<\/a><\/li>\n- Introduce