wp-types v3.65.0

WordPress TypeScript Definitions

This package provides well-documented TypeScript definitions that describe the shape of:

• WordPress PHP objects such as WP_Post, WP_Term, and WP_User
• WordPress REST API responses such as from /wp/v2/posts and /wp/v2/users
• Various property types and allowed values of both

The definitions were last updated for WordPress 6.5.

What's included?

Interfaces for PHP objects

• 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

Interfaces for REST API response objects

Properties

Interfaces are used for the structure of several 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

String enums are used for values of several properties:

• WP_Comment_Status_Name
• WP_Comment_Type_Name
• WP_Post_Comment_Status_Name
• WP_Post_Format_Name
• WP_Post_Status_Name
• WP_Post_Type_Name
• WP_Taxonomy_Name
• WP_User_Role_Name
• WP_HTTP_Status_Code

Installation

npm install wp-types --save-dev

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 3
• The minor version number (y) indicates the WordPress branch version number without its decimal place, eg. 65 for WordPress 6.5
• The patch version number (z) indicates the schema patch version number

Examples:

• ~3.65.0 - Schema version 3 for WordPress 6.5
• ~3.60.0 - Schema version 3 for WordPress 6.0
• ~3.57.0 - Schema version 3 for WordPress 5.7
• ^3.0.0 - Schema version 3 for the latest WordPress version

Usage

Usage with objects from PHP represented as JSON:

import type { WP_Post } from 'wp-types';

function get_title( post: WP_Post ): string {
	return post.post_title;
}

Usage with the REST API, for example when using apiFetch():

import type {
	WP_REST_API_Posts,
	WP_REST_API_Users,
	WP_REST_API_Attachments,
	WP_REST_API_Tags,
	WP_REST_API_Envelope,
	WP_REST_API_Error,
} from 'wp-types';

// Posts, Pages, and custom post types:
const api: Promise<WP_REST_API_Posts> = wp.apiFetch( {
	path: '/wp/v2/posts/',
} );

// Users:
const api: Promise<WP_REST_API_Users> = wp.apiFetch( {
	path: '/wp/v2/users/',
} );

// Media attachments:
const api: Promise<WP_REST_API_Attachments> = wp.apiFetch( {
	path: '/wp/v2/media/',
} );

// Enveloped responses (with `?_envelope`):
const api: Promise<WP_REST_API_Envelope<WP_REST_API_Tags>> = wp.apiFetch( {
	path: '/wp/v2/tags/?_envelope',
} );

// Errors from any of the above:
api.catch( ( error: WP_REST_API_Error ) => {
	alert( error.message );
} );

FAQs

When do these definitions apply?

The PHP object schemas apply whenever a supported PHP object is encoded to JSON. For example:

printf(
	'let wpPost = %s;',
	wp_json_encode( get_post() )
);

The REST API object schemas apply to the response to a REST API request. For example:

const api = wp.apiFetch( {
	path: '/wp/v2/categories/'
} );

The definitions also apply outside of the browser, for example if you're saving data as JSON and reading it in a Node application.

How do I know these definitions are valid?

They're generated directly from the wp-json-schemas package, which is itself tested using output from WordPress core.

If you'd like to contribute to these definitions, please contribute upstream to the wp-json-schemas package. Thanks!

Can I use the enums as values in my code?

Yes, but:

• You might need preserveConstEnums enabled in your TypeScript config
• You should import enums as you would a regular module, not as a type
• You cannot iterate enums (this is a TypeScript restriction)

Example:

import { WP_Post_Type_Name } from 'wp-types';

console.log( WP_Post_Type_Name.auto_draft );

License

MIT