Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnbillion/wp-json-schemas
JSON schemas for WordPress PHP objects and REST API responses
https://github.com/johnbillion/wp-json-schemas
json-schema rest-api typescript typescript-definitions wordpress
Last synced: 1 day ago
JSON representation
JSON schemas for WordPress PHP objects and REST API responses
- Host: GitHub
- URL: https://github.com/johnbillion/wp-json-schemas
- Owner: johnbillion
- License: mit
- Created: 2020-05-23T10:55:45.000Z (over 4 years ago)
- Default Branch: trunk
- Last Pushed: 2024-11-14T12:10:37.000Z (about 1 month ago)
- Last Synced: 2024-12-14T22:02:57.433Z (9 days ago)
- Topics: json-schema, rest-api, typescript, typescript-definitions, wordpress
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/wp-json-schemas
- Size: 855 KB
- Stars: 150
- Watchers: 5
- Forks: 7
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/wp-json-schemas)
[](https://www.npmjs.com/package/wp-types)
[](https://github.com/johnbillion/wp-json-schemas/actions)
# WordPress JSON Schemas
This package provides well-documented JSON schemas that describe the shape of:
* WordPress core PHP objects such as `WP_Post`, `WP_Term`, and `WP_User`
* WordPress REST API responses such as those from `/wp/v2/posts`, `/wp/v2/categories`, and `/wp/v2/users`
* Various property types and values of both
The schemas in this library are used to generate [the WordPress TypeScript definitions provided by the `wp-types` package](https://www.npmjs.com/package/wp-types).
The schemas were last updated for WordPress 6.7.
## What's included?
### PHP object schemas
* `WP_Post`
* `WP_Term`
* `WP_User`
* `WP_Comment`
* `WP_Error`
* `WP_Query`
* `WP_Block`
* `WP_Block_Type`
* `WP_Block_Template`
* `WP_Site`
* `WP_Locale`
* `WP_Taxonomy`
* `WP_Post_Type`
* `WP_Role`
* `WP_Network`
* `WP_Screen`
### REST API response schemas
Route | Schema
------------------------------------------------------- | ------
/wp/v2/block-directory/search | `WP_REST_API_Block_Directory_Items`
/wp/v2/block-patterns/categories | `WP_REST_API_Block_Pattern_Categories`
/wp/v2/block-patterns/patterns | `WP_REST_API_Block_Patterns`
/wp/v2/block-renderer/{name} | `WP_REST_API_Rendered_Block`
/wp/v2/block-types | `WP_REST_API_Block_Types`
/wp/v2/block-types/{namespace} | `WP_REST_API_Block_Type`
/wp/v2/block-types/{namespace}/{name} | `WP_REST_API_Block_Type`
/wp/v2/blocks | `WP_REST_API_Blocks`
/wp/v2/blocks/{id} | `WP_REST_API_Block`
/wp/v2/blocks/{id}/autosaves | Todo
/wp/v2/blocks/{parent}/autosaves/{id} | Todo
/wp/v2/blocks/{parent}/revisions | `WP_REST_API_Revisions`
/wp/v2/blocks/{parent}/revisions/{id} | `WP_REST_API_Revision`
/wp/v2/categories | `WP_REST_API_Categories`
/wp/v2/categories/{id} | `WP_REST_API_Category`
/wp/v2/comments | `WP_REST_API_Comments`
/wp/v2/comments/{id} | `WP_REST_API_Comment`
/wp/v2/font-collections | `WP_REST_API_Font_Collections`
/wp/v2/font-collections/{slug} | `WP_REST_API_Font_Collection`
/wp/v2/font-families | `WP_REST_API_Font_Families`
/wp/v2/font-families/{id}/ | `WP_REST_API_Font_Family`
/wp/v2/font-families/{parent}/font-faces | `WP_REST_API_Font_Faces`
/wp/v2/font-families/{parent}/font-faces/{id} | `WP_REST_API_Font_Face`
/wp/v2/global-styles/{id} | `WP_REST_API_Global_Style_Variation`
/wp/v2/global-styles/{parent}/revisions | Todo
/wp/v2/global-styles/{parent}/revisions/{id} | Todo
/wp/v2/global-styles/themes/{stylesheet} | `WP_REST_API_Global_Style_Config`
/wp/v2/global-styles/themes/{stylesheet}/variations | `WP_REST_API_Global_Style_Variations`
/wp/v2/media | `WP_REST_API_Attachments`
/wp/v2/media/{id} | `WP_REST_API_Attachment`
/wp/v2/media/{id}/edit | Todo
/wp/v2/media/{id}/post-process | Todo
/wp/v2/menu-items | `WP_REST_API_Menu_Items`
/wp/v2/menu-items/{id} | `WP_REST_API_Menu_Item`
/wp/v2/menu-items/{id}/autosaves | Todo
/wp/v2/menu-items/{parent}/autosaves/{id} | Todo
/wp/v2/menu-locations | `WP_REST_API_Menu_Locations`
/wp/v2/menu-locations/{location} | `WP_REST_API_Menu_Location`
/wp/v2/menus | `WP_REST_API_Menus`
/wp/v2/menus/{id} | `WP_REST_API_Menu`
/wp/v2/navigation | `WP_REST_API_Navigation_Menus`
/wp/v2/navigation/{id} | `WP_REST_API_Navigation_Menu`
/wp/v2/navigation/{id}/autosaves | Todo
/wp/v2/navigation/{parent}/autosaves/{id} | Todo
/wp/v2/navigation/{parent}/revisions | Todo
/wp/v2/navigation/{parent}/revisions/{id} | Todo
/wp/v2/pages | `WP_REST_API_Pages`
/wp/v2/pages/{id} | `WP_REST_API_Page`
/wp/v2/pages/{id}/autosaves | Todo
/wp/v2/pages/{parent}/autosaves/{id} | Todo
/wp/v2/pages/{parent}/revisions | `WP_REST_API_Revisions`
/wp/v2/pages/{parent}/revisions/{id} | `WP_REST_API_Revision`
/wp/v2/pattern-directory/patterns | `WP_REST_API_Pattern_Directory_Patterns`
/wp/v2/plugins | `WP_REST_API_Plugins`
/wp/v2/plugins/{plugin} | `WP_REST_API_Plugin`
/wp/v2/posts | `WP_REST_API_Posts`
/wp/v2/posts/{id} | `WP_REST_API_Post`
/wp/v2/posts/{id}/autosaves | Todo
/wp/v2/posts/{parent}/autosaves/{id} | Todo
/wp/v2/posts/{parent}/revisions | `WP_REST_API_Revisions`
/wp/v2/posts/{parent}/revisions/{id} | `WP_REST_API_Revision`
/wp/v2/search | `WP_REST_API_Search_Results`
/wp/v2/settings | `WP_REST_API_Settings`
/wp/v2/sidebars | Todo
/wp/v2/sidebars/{id} | Todo
/wp/v2/statuses | `WP_REST_API_Statuses`
/wp/v2/statuses/{status} | `WP_REST_API_Status`
/wp/v2/tags | `WP_REST_API_Tags`
/wp/v2/tags/{id} | `WP_REST_API_Tag`
/wp/v2/taxonomies | `WP_REST_API_Taxonomies`
/wp/v2/taxonomies/{taxonomy} | `WP_REST_API_Taxonomy`
/wp/v2/template-parts | Todo
/wp/v2/template-parts/{id} | Todo
/wp/v2/template-parts/{id}/autosaves | Todo
/wp/v2/template-parts/{parent}/autosaves/{id} | Todo
/wp/v2/template-parts/{parent}/revisions | Todo
/wp/v2/template-parts/{parent}/revisions/{id} | Todo
/wp/v2/template-parts/lookup | Todo
/wp/v2/templates | Todo
/wp/v2/templates/{id} | Todo
/wp/v2/templates/{id}/autosaves | Todo
/wp/v2/templates/{parent}/autosaves/{id} | Todo
/wp/v2/templates/{parent}/revisions | Todo
/wp/v2/templates/{parent}/revisions/{id} | Todo
/wp/v2/templates/lookup | Todo
/wp/v2/themes | Todo
/wp/v2/themes/{stylesheet} | Todo
/wp/v2/types | `WP_REST_API_Types`
/wp/v2/types/{type} | `WP_REST_API_Type`
/wp/v2/users | `WP_REST_API_Users`
/wp/v2/users/({id}\|me) | `WP_REST_API_User`
/wp/v2/users/({id}\|me)/application-passwords | `WP_REST_API_Application_Passwords`
/wp/v2/users/({id}\|me)/application-passwords/{uuid} | `WP_REST_API_Application_Password`
/wp/v2/users/({id}\|me)/application-passwords/introspect| `WP_REST_API_Application_Password`
/wp/v2/widget-types | Todo
/wp/v2/widget-types/{id} | Todo
/wp/v2/widget-types/{id}/encode | Todo
/wp/v2/widget-types/{id}/render | Todo
/wp/v2/widgets | Todo
/wp/v2/widgets/{id} | Todo
/wp/v2/wp_pattern_category | Todo
/wp/v2/wp_pattern_category/{id} | Todo
Any REST API error | `WP_REST_API_Error`
The REST API schemas use JSON Hyper-Schema.
### Property schemas
Schemas are provided for various properties:
* `WP_Error_Data`
* `WP_Error_Messages`
* `WP_Post_Type_Caps`
* `WP_Post_Type_Labels`
* `WP_Post_Type_Rewrite`
* `WP_Taxonomy_Caps`
* `WP_Taxonomy_Labels`
* `WP_Taxonomy_Rewrite`
* `WP_User_Cap_Name`
* `WP_User_Caps`
* `WP_User_Data`
### Enums
Enums are provided for various values:
* `WP_Comment_Status_Name`
* `WP_Comment_Type_Name`
* `WP_HTTP_Status_Code`
* `WP_Post_Comment_Status_Name`
* `WP_Post_Format_Name`
* `WP_Post_Status_Name`
* `WP_Post_Type_Name`
* `WP_Taxonomy_Name`
* `WP_User_Role_Name`
## Installation
```sh
npm install wp-json-schemas
```
### Versioning
This package is versioned so that you can specify both the schema version and the WordPress branch version in a way that's compatible with semantic versioning. Given version `x.y.z`:
* The major version number (`x`) indicates the schema version number, currently `4`
* The minor version number (`y`) indicates the WordPress branch version number without its decimal place, eg. `67` for WordPress 6.7
* The patch version number (`z`) indicates the schema patch version number
Examples:
* `^4.0.0` - Schema version 4 for the latest WordPress version
* `~4.67.0` - Schema version 4 for WordPress 6.7
* `~3.57.0` - Schema version 3 for WordPress 5.7
## Breaking changes
If a breaking change is made to the schema then the major version number of this package will be incremented.
* Version 4 switched to using JSON Schema `draft/2019-09`. Prior to this, `draft-07` was used.
## Usage
Usage depends on what you're doing with the schemas. You could use them for validation or just for understanding the shape of an object.
If you're using TypeScript, check out [the TypeScript definitions provided by the `wp-types` package](https://www.npmjs.com/package/wp-types).
## FAQs
### When do these schemas apply?
The PHP object schemas apply whenever a supported PHP object is encoded to JSON. For example:
```php
printf(
'let wpPost = %s;',
wp_json_encode( get_post() )
);
```
The REST API object schemas apply to the response to a REST API request or `getEntityRecord()` call. Examples:
```js
// WP_REST_API_Categories
const api = wp.apiFetch( {
path: '/wp/v2/categories/'
} );
// WP_REST_API_Category
const category = getEntityRecord(
'taxonomy',
'category',
id,
);
// WP_REST_API_Posts
const posts = getEntityRecords(
'postType',
'post',
query
);
```
The schemas also apply outside of an HTTP request, for example if you're saving data as a JSON file and reading it in a Node application.
### Why are there different schemas for PHP objects and REST API responses?
An object in a REST API response is not the same as its corresponding object in PHP, in fact they are substantially different.
Schemas are available via an OPTIONS request to the REST API endpoints, but the schemas do not adhere strictly to the JSON Schema standard. [Here's an article by Timothy B. Jacobs with more info](https://timothybjacobs.com/2017/05/17/json-schema-and-the-wp-rest-api/).
### Are these schemas automatically generated from WordPress core?
No, but they are automatically tested against output from WordPress core to ensure their correctness. Extra documentation and schemas for properties have been added where possible, so generating them directly from WordPress core isn't desirable.
### How do I know the schemas are accurate?
They're all tested against actual output from WordPress core.
## Tests
To run the tests:
* `nvm use`
* `npm install`
* `composer install`
* `composer test`
## License
MIT