IWordPressService
katanakit-js / IWordPressService
Interface: IWordPressService
Section titled “Interface: IWordPressService”Defined in: types/adapters/wordpress.ts:192
Contract of the WordPress adapter facade.
Methods
Section titled “Methods”useWpAssignRole()
Section titled “useWpAssignRole()”useWpAssignRole(userId, role): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}>>;Defined in: types/adapters/wordpress.ts:236
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
userId |
number |
role |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}>>
useWpAsSubject()
Section titled “useWpAsSubject()”useWpAsSubject(user): {[key: string]: unknown; id: string | number; roles: string[];};Defined in: types/adapters/wordpress.ts:235
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
user |
{ [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string; } |
user.acf? |
Record<string, unknown> |
user.avatar_urls? |
Record<string, string> |
user.capabilities? |
Record<string, boolean> |
user.description? |
string |
user.email? |
string |
user.extra_capabilities? |
Record<string, boolean> |
user.first_name? |
string |
user.id? |
number |
user.last_name? |
string |
user.link? |
string |
user.locale? |
string |
user.meta? |
Record<string, unknown> |
user.name? |
string |
user.nickname? |
string |
user.registered_date? |
string |
user.roles? |
string[] |
user.slug? |
string |
user.url? |
string |
user.username? |
string |
Returns
Section titled “Returns”{[key: string]: unknown; id: string | number; roles: string[];}id: string | number;roles: string[];useWpAuditRole()
Section titled “useWpAuditRole()”useWpAuditRole(slug, maxHolders?): Promise<FetchResult<{ declared: string[]; granted: string[]; holders: number; missing: string[]; slug: string; status: "verified" | "partial" | "unverifiable"; undeclared: string[];}>>;Defined in: types/adapters/wordpress.ts:239
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
slug |
string |
maxHolders? |
number |
Returns
Section titled “Returns”Promise<FetchResult<{
declared: string[];
granted: string[];
holders: number;
missing: string[];
slug: string;
status: "verified" | "partial" | "unverifiable";
undeclared: string[];
}>>
useWpBatch()
Section titled “useWpBatch()”useWpBatch(operations): Promise<FetchResult<{[key: string]: unknown; responses: { [key: string]: unknown; body: unknown; headers: Record<string, string>; status: number; }[];}>>;Defined in: types/adapters/wordpress.ts:260
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
operations |
{ body?: unknown; headers?: Record<string, string>; method: string; path: string; }[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
responses: {
[key: string]: unknown;
body: unknown;
headers: Record<string, string>;
status: number;
}[];
}>>
useWpCreateCategory()
Section titled “useWpCreateCategory()”useWpCreateCategory(data): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; taxonomy: string;}>>;Defined in: types/adapters/wordpress.ts:210
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; description?: string; name: string; parent?: number; slug: string; taxonomy: string; } |
data.acf? |
Record<string, unknown> |
data.description? |
string |
data.name? |
string |
data.parent? |
number |
data.slug? |
string |
data.taxonomy? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
parent: number;
slug: string;
taxonomy: string;
}>>
useWpCreateComment()
Section titled “useWpCreateComment()”useWpCreateComment(data): Promise<FetchResult<{[key: string]: unknown; author: number; author_avatar_urls: Record<string, string>; author_email: string; author_name: string; author_url: string; content: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; id: number; link: string; meta: Record<string, unknown>; parent: number; post: number; status: string; type: string;}>>;Defined in: types/adapters/wordpress.ts:220
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data |
{ [key: string]: unknown; author: number; author_email?: string; author_name?: string; author_url?: string; content: { [key: string]: unknown; rendered: string; }; parent?: number; post: number; } |
data.author? |
number |
data.author_email? |
string |
data.author_name? |
string |
data.author_url? |
string |
data.content? |
{ [key: string]: unknown; rendered: string; } |
data.content.rendered? |
string |
data.parent? |
number |
data.post? |
number |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
author: number;
author_avatar_urls: Record<string, string>;
author_email: string;
author_name: string;
author_url: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
id: number;
link: string;
meta: Record<string, unknown>;
parent: number;
post: number;
status: string;
type: string;
}>>
useWpCreateCustomPost()
Section titled “useWpCreateCustomPost()”useWpCreateCustomPost(postType, data): Promise<FetchResult<unknown>>;Defined in: types/adapters/wordpress.ts:246
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
postType |
string |
data |
Record<string, unknown> |
Returns
Section titled “Returns”Promise<FetchResult<unknown>>
useWpCreatePage()
Section titled “useWpCreatePage()”useWpCreatePage(data): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; menu_order: number; meta: Record<string, unknown>; modified: string; modified_gmt: string; parent: number; ping_status: string; slug: string; status: string; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:200
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; author: number; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; guid?: { [key: string]: unknown; rendered: string; }; menu_order?: number; meta?: Record<string, unknown>; parent?: number; ping_status: string; slug?: string; status?: string; template?: string; title: { [key: string]: unknown; rendered: string; }; type?: string; } |
data.acf? |
Record<string, unknown> |
data.author? |
number |
data.comment_status? |
string |
data.content? |
{ [key: string]: unknown; protected: boolean; rendered: string; } |
data.content.protected? |
boolean |
data.content.rendered? |
string |
data.excerpt? |
{ [key: string]: unknown; protected: boolean; rendered: string; } |
data.excerpt.protected? |
boolean |
data.excerpt.rendered? |
string |
data.featured_media? |
number |
data.guid? |
{ [key: string]: unknown; rendered: string; } |
data.guid.rendered? |
string |
data.menu_order? |
number |
data.meta? |
Record<string, unknown> |
data.parent? |
number |
data.ping_status? |
string |
data.slug? |
string |
data.status? |
string |
data.template? |
string |
data.title? |
{ [key: string]: unknown; rendered: string; } |
data.title.rendered? |
string |
data.type? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
menu_order: number;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
parent: number;
ping_status: string;
slug: string;
status: string;
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpCreatePost()
Section titled “useWpCreatePost()”useWpCreatePost(data): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; categories: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; meta: Record<string, unknown>; modified: string; modified_gmt: string; ping_status: string; slug: string; status: string; sticky: boolean; tags: number[]; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:195
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; author: number; categories?: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format?: string; guid?: { [key: string]: unknown; rendered: string; }; meta?: Record<string, unknown>; ping_status: string; slug?: string; status?: string; sticky: boolean; tags?: number[]; template?: string; title: { [key: string]: unknown; rendered: string; }; type?: string; } |
data.acf? |
Record<string, unknown> |
data.author? |
number |
data.categories? |
number[] |
data.comment_status? |
string |
data.content? |
{ [key: string]: unknown; protected: boolean; rendered: string; } |
data.content.protected? |
boolean |
data.content.rendered? |
string |
data.excerpt? |
{ [key: string]: unknown; protected: boolean; rendered: string; } |
data.excerpt.protected? |
boolean |
data.excerpt.rendered? |
string |
data.featured_media? |
number |
data.format? |
string |
data.guid? |
{ [key: string]: unknown; rendered: string; } |
data.guid.rendered? |
string |
data.meta? |
Record<string, unknown> |
data.ping_status? |
string |
data.slug? |
string |
data.status? |
string |
data.sticky? |
boolean |
data.tags? |
number[] |
data.template? |
string |
data.title? |
{ [key: string]: unknown; rendered: string; } |
data.title.rendered? |
string |
data.type? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
categories: number[];
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
format: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
ping_status: string;
slug: string;
status: string;
sticky: boolean;
tags: number[];
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpCreateTag()
Section titled “useWpCreateTag()”useWpCreateTag(data): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; taxonomy: string;}>>;Defined in: types/adapters/wordpress.ts:215
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; description?: string; name: string; slug: string; taxonomy: string; } |
data.acf? |
Record<string, unknown> |
data.description? |
string |
data.name? |
string |
data.slug? |
string |
data.taxonomy? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
slug: string;
taxonomy: string;
}>>
useWpCreateUser()
Section titled “useWpCreateUser()”useWpCreateUser(data): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}>>;Defined in: types/adapters/wordpress.ts:226
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; description?: string; email: string; first_name?: string; last_name?: string; locale?: string; name: string; nickname?: string; roles?: string[]; slug: string; url: string; username: string; } |
data.acf? |
Record<string, unknown> |
data.description? |
string |
data.email? |
string |
data.first_name? |
string |
data.last_name? |
string |
data.locale? |
string |
data.name? |
string |
data.nickname? |
string |
data.roles? |
string[] |
data.slug? |
string |
data.url? |
string |
data.username? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}>>
useWpDefineRoles()
Section titled “useWpDefineRoles()”useWpDefineRoles(definitions): void;Defined in: types/adapters/wordpress.ts:229
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
definitions |
{ capabilities: string[]; label: string; rank: number; slug: string; wpCapabilities: string[]; }[] |
Returns
Section titled “Returns”void
useWpDeleteCategory()
Section titled “useWpDeleteCategory()”useWpDeleteCategory(id, force?): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; taxonomy: string;}>>;Defined in: types/adapters/wordpress.ts:212
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
force? |
boolean |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
parent: number;
slug: string;
taxonomy: string;
}>>
useWpDeleteComment()
Section titled “useWpDeleteComment()”useWpDeleteComment(id, force?): Promise<FetchResult<{[key: string]: unknown; author: number; author_avatar_urls: Record<string, string>; author_email: string; author_name: string; author_url: string; content: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; id: number; link: string; meta: Record<string, unknown>; parent: number; post: number; status: string; type: string;}>>;Defined in: types/adapters/wordpress.ts:222
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
force? |
boolean |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
author: number;
author_avatar_urls: Record<string, string>;
author_email: string;
author_name: string;
author_url: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
id: number;
link: string;
meta: Record<string, unknown>;
parent: number;
post: number;
status: string;
type: string;
}>>
useWpDeleteCustomPost()
Section titled “useWpDeleteCustomPost()”useWpDeleteCustomPost( postType, id, force?): Promise<FetchResult<unknown>>;Defined in: types/adapters/wordpress.ts:255
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
postType |
string |
id |
number |
force? |
boolean |
Returns
Section titled “Returns”Promise<FetchResult<unknown>>
useWpDeleteMedia()
Section titled “useWpDeleteMedia()”useWpDeleteMedia(id, force?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; alt_text: string; author: number; caption: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; description: { [key: string]: unknown; rendered: string; }; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; media_details: { [key: string]: unknown; file?: string; filesize?: number; height?: number; image_meta?: { [key: string]: unknown; aperture?: string; camera?: string; caption?: string; copyright?: string; created_timestamp?: string; credit?: string; focal_length?: string; iso?: string; orientation?: string; shutter_speed?: string; title?: string; }; sizes?: Record<string, { [key: string]: unknown; file: string; filesize?: number; height: number; mime_type: string; source_url: string; width: number; }>; width?: number; }; media_type: string; meta: Record<string, unknown>; mime_type: string; modified: string; modified_gmt: string; post: number | null; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:207
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
force? |
boolean |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
alt_text: string;
author: number;
caption: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
description: {
[key: string]: unknown;
rendered: string;
};
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
media_details: {
[key: string]: unknown;
file?: string;
filesize?: number;
height?: number;
image_meta?: {
[key: string]: unknown;
aperture?: string;
camera?: string;
caption?: string;
copyright?: string;
created_timestamp?: string;
credit?: string;
focal_length?: string;
iso?: string;
orientation?: string;
shutter_speed?: string;
title?: string;
};
sizes?: Record<string, {
[key: string]: unknown;
file: string;
filesize?: number;
height: number;
mime_type: string;
source_url: string;
width: number;
}>;
width?: number;
};
media_type: string;
meta: Record<string, unknown>;
mime_type: string;
modified: string;
modified_gmt: string;
post: number | null;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpDeletePage()
Section titled “useWpDeletePage()”useWpDeletePage(id, force?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; menu_order: number; meta: Record<string, unknown>; modified: string; modified_gmt: string; parent: number; ping_status: string; slug: string; status: string; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:202
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
force? |
boolean |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
menu_order: number;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
parent: number;
ping_status: string;
slug: string;
status: string;
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpDeletePost()
Section titled “useWpDeletePost()”useWpDeletePost(id, force?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; categories: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; meta: Record<string, unknown>; modified: string; modified_gmt: string; ping_status: string; slug: string; status: string; sticky: boolean; tags: number[]; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:197
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
force? |
boolean |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
categories: number[];
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
format: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
ping_status: string;
slug: string;
status: string;
sticky: boolean;
tags: number[];
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpDeleteTag()
Section titled “useWpDeleteTag()”useWpDeleteTag(id, force?): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; taxonomy: string;}>>;Defined in: types/adapters/wordpress.ts:217
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
force? |
boolean |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
slug: string;
taxonomy: string;
}>>
useWpDeleteUser()
Section titled “useWpDeleteUser()”useWpDeleteUser(id, reassign?): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}>>;Defined in: types/adapters/wordpress.ts:228
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
reassign? |
number |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}>>
useWpFindPostBySlug()
Section titled “useWpFindPostBySlug()”useWpFindPostBySlug(slug): Promise<FetchResult< | {[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<..., ...>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: ...]: ...; rendered: ...; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: ...]: ...; rendered: ...; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: ... | ...; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; categories: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; meta: Record<string, unknown>; modified: string; modified_gmt: string; ping_status: string; slug: string; status: string; sticky: boolean; tags: number[]; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}| null>>;Defined in: types/adapters/wordpress.ts:263
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
slug |
string |
Returns
Section titled “Returns”Promise<FetchResult<
| {
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<…, …>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: …]: …;
rendered: …;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: …]: …;
rendered: …;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: … | …;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
categories: number[];
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
format: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
ping_status: string;
slug: string;
status: string;
sticky: boolean;
tags: number[];
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}
| null>>
useWpGetCategories()
Section titled “useWpGetCategories()”useWpGetCategories(options?): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; taxonomy: string;}[]>>;Defined in: types/adapters/wordpress.ts:208
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
parent: number;
slug: string;
taxonomy: string;
}[]>>
useWpGetCategory()
Section titled “useWpGetCategory()”useWpGetCategory(id): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; taxonomy: string;}>>;Defined in: types/adapters/wordpress.ts:209
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
parent: number;
slug: string;
taxonomy: string;
}>>
useWpGetComment()
Section titled “useWpGetComment()”useWpGetComment(id): Promise<FetchResult<{[key: string]: unknown; author: number; author_avatar_urls: Record<string, string>; author_email: string; author_name: string; author_url: string; content: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; id: number; link: string; meta: Record<string, unknown>; parent: number; post: number; status: string; type: string;}>>;Defined in: types/adapters/wordpress.ts:219
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
author: number;
author_avatar_urls: Record<string, string>;
author_email: string;
author_name: string;
author_url: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
id: number;
link: string;
meta: Record<string, unknown>;
parent: number;
post: number;
status: string;
type: string;
}>>
useWpGetComments()
Section titled “useWpGetComments()”useWpGetComments(options?): Promise<FetchResult<{[key: string]: unknown; author: number; author_avatar_urls: Record<string, string>; author_email: string; author_name: string; author_url: string; content: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; id: number; link: string; meta: Record<string, unknown>; parent: number; post: number; status: string; type: string;}[]>>;Defined in: types/adapters/wordpress.ts:218
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
author: number;
author_avatar_urls: Record<string, string>;
author_email: string;
author_name: string;
author_url: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
id: number;
link: string;
meta: Record<string, unknown>;
parent: number;
post: number;
status: string;
type: string;
}[]>>
useWpGetCurrentUser()
Section titled “useWpGetCurrentUser()”useWpGetCurrentUser(): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}>>;Defined in: types/adapters/wordpress.ts:225
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}>>
useWpGetCustomPost()
Section titled “useWpGetCustomPost()”useWpGetCustomPost( postType, id, options?): Promise<FetchResult<unknown>>;Defined in: types/adapters/wordpress.ts:241
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
postType |
string |
id |
number |
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<unknown>>
useWpGetCustomPosts()
Section titled “useWpGetCustomPosts()”useWpGetCustomPosts(postType, options?): Promise<FetchResult<unknown[]>>;Defined in: types/adapters/wordpress.ts:240
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
postType |
string |
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<unknown[]>>
useWpGetMedia()
Section titled “useWpGetMedia()”useWpGetMedia(options?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<..., ...>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: ...]: ...; rendered: ...; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: ...]: ...; rendered: ...; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: ... | ...; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; alt_text: string; author: number; caption: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; description: { [key: string]: unknown; rendered: string; }; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; media_details: { [key: string]: unknown; file?: string; filesize?: number; height?: number; image_meta?: { [key: string]: unknown; aperture?: string; camera?: string; caption?: string; copyright?: string; created_timestamp?: string; credit?: string; focal_length?: string; iso?: string; orientation?: string; shutter_speed?: string; title?: string; }; sizes?: Record<string, { [key: string]: unknown; file: string; filesize?: number; height: number; mime_type: string; source_url: string; width: number; }>; width?: number; }; media_type: string; meta: Record<string, unknown>; mime_type: string; modified: string; modified_gmt: string; post: number | null; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}[]>>;Defined in: types/adapters/wordpress.ts:203
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<…, …>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: …]: …;
rendered: …;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: …]: …;
rendered: …;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: … | …;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
alt_text: string;
author: number;
caption: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
description: {
[key: string]: unknown;
rendered: string;
};
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
media_details: {
[key: string]: unknown;
file?: string;
filesize?: number;
height?: number;
image_meta?: {
[key: string]: unknown;
aperture?: string;
camera?: string;
caption?: string;
copyright?: string;
created_timestamp?: string;
credit?: string;
focal_length?: string;
iso?: string;
orientation?: string;
shutter_speed?: string;
title?: string;
};
sizes?: Record<string, {
[key: string]: unknown;
file: string;
filesize?: number;
height: number;
mime_type: string;
source_url: string;
width: number;
}>;
width?: number;
};
media_type: string;
meta: Record<string, unknown>;
mime_type: string;
modified: string;
modified_gmt: string;
post: number | null;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[]>>
useWpGetMediaItem()
Section titled “useWpGetMediaItem()”useWpGetMediaItem(id): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; alt_text: string; author: number; caption: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; description: { [key: string]: unknown; rendered: string; }; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; media_details: { [key: string]: unknown; file?: string; filesize?: number; height?: number; image_meta?: { [key: string]: unknown; aperture?: string; camera?: string; caption?: string; copyright?: string; created_timestamp?: string; credit?: string; focal_length?: string; iso?: string; orientation?: string; shutter_speed?: string; title?: string; }; sizes?: Record<string, { [key: string]: unknown; file: string; filesize?: number; height: number; mime_type: string; source_url: string; width: number; }>; width?: number; }; media_type: string; meta: Record<string, unknown>; mime_type: string; modified: string; modified_gmt: string; post: number | null; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:204
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
alt_text: string;
author: number;
caption: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
description: {
[key: string]: unknown;
rendered: string;
};
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
media_details: {
[key: string]: unknown;
file?: string;
filesize?: number;
height?: number;
image_meta?: {
[key: string]: unknown;
aperture?: string;
camera?: string;
caption?: string;
copyright?: string;
created_timestamp?: string;
credit?: string;
focal_length?: string;
iso?: string;
orientation?: string;
shutter_speed?: string;
title?: string;
};
sizes?: Record<string, {
[key: string]: unknown;
file: string;
filesize?: number;
height: number;
mime_type: string;
source_url: string;
width: number;
}>;
width?: number;
};
media_type: string;
meta: Record<string, unknown>;
mime_type: string;
modified: string;
modified_gmt: string;
post: number | null;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpGetPage()
Section titled “useWpGetPage()”useWpGetPage(id, options?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; menu_order: number; meta: Record<string, unknown>; modified: string; modified_gmt: string; parent: number; ping_status: string; slug: string; status: string; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:199
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
menu_order: number;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
parent: number;
ping_status: string;
slug: string;
status: string;
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpGetPages()
Section titled “useWpGetPages()”useWpGetPages(options?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<..., ...>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: ...]: ...; rendered: ...; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: ...]: ...; rendered: ...; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: ... | ...; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; menu_order: number; meta: Record<string, unknown>; modified: string; modified_gmt: string; parent: number; ping_status: string; slug: string; status: string; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}[]>>;Defined in: types/adapters/wordpress.ts:198
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<…, …>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: …]: …;
rendered: …;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: …]: …;
rendered: …;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: … | …;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
menu_order: number;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
parent: number;
ping_status: string;
slug: string;
status: string;
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[]>>
useWpGetPost()
Section titled “useWpGetPost()”useWpGetPost(id, options?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; categories: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; meta: Record<string, unknown>; modified: string; modified_gmt: string; ping_status: string; slug: string; status: string; sticky: boolean; tags: number[]; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:194
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
categories: number[];
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
format: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
ping_status: string;
slug: string;
status: string;
sticky: boolean;
tags: number[];
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpGetPosts()
Section titled “useWpGetPosts()”useWpGetPosts(options?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<..., ...>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: ...]: ...; rendered: ...; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: ...]: ...; rendered: ...; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: ... | ...; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; categories: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; meta: Record<string, unknown>; modified: string; modified_gmt: string; ping_status: string; slug: string; status: string; sticky: boolean; tags: number[]; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}[]>>;Defined in: types/adapters/wordpress.ts:193
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<…, …>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: …]: …;
rendered: …;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: …]: …;
rendered: …;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: … | …;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
categories: number[];
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
format: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
ping_status: string;
slug: string;
status: string;
sticky: boolean;
tags: number[];
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[]>>
useWpGetRole()
Section titled “useWpGetRole()”useWpGetRole(slug): | { capabilities: string[]; label: string; rank: number; slug: string; wpCapabilities: string[];} | undefined;Defined in: types/adapters/wordpress.ts:232
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
slug |
string |
Returns
Section titled “Returns”| {
capabilities: string[];
label: string;
rank: number;
slug: string;
wpCapabilities: string[];
}
| undefined
useWpGetTag()
Section titled “useWpGetTag()”useWpGetTag(id): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; taxonomy: string;}>>;Defined in: types/adapters/wordpress.ts:214
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
slug: string;
taxonomy: string;
}>>
useWpGetTags()
Section titled “useWpGetTags()”useWpGetTags(options?): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; taxonomy: string;}[]>>;Defined in: types/adapters/wordpress.ts:213
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
slug: string;
taxonomy: string;
}[]>>
useWpGetUser()
Section titled “useWpGetUser()”useWpGetUser(id): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}>>;Defined in: types/adapters/wordpress.ts:224
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}>>
useWpGetUsers()
Section titled “useWpGetUsers()”useWpGetUsers(options?): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}[]>>;Defined in: types/adapters/wordpress.ts:223
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}[]>>
useWpGetUsersByRole()
Section titled “useWpGetUsersByRole()”useWpGetUsersByRole(role, options?): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}[]>>;Defined in: types/adapters/wordpress.ts:238
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
role |
string |
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}[]>>
useWpListAllPosts()
Section titled “useWpListAllPosts()”useWpListAllPosts(options?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<..., ...>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: ...]: ...; rendered: ...; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: ...]: ...; rendered: ...; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: ... | ...; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; categories: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; meta: Record<string, unknown>; modified: string; modified_gmt: string; ping_status: string; slug: string; status: string; sticky: boolean; tags: number[]; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}[]>>;Defined in: types/adapters/wordpress.ts:261
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<…, …>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: …]: …;
rendered: …;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: …]: …;
rendered: …;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: … | …;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
categories: number[];
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
format: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
ping_status: string;
slug: string;
status: string;
sticky: boolean;
tags: number[];
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[]>>
useWpRegisterRole()
Section titled “useWpRegisterRole()”useWpRegisterRole(definition): void;Defined in: types/adapters/wordpress.ts:230
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
definition |
{ capabilities: string[]; label: string; rank: number; slug: string; wpCapabilities: string[]; } |
definition.capabilities? |
string[] |
definition.label? |
string |
definition.rank? |
number |
definition.slug? |
string |
definition.wpCapabilities? |
string[] |
Returns
Section titled “Returns”void
useWpResetRoles()
Section titled “useWpResetRoles()”useWpResetRoles(): void;Defined in: types/adapters/wordpress.ts:233
Returns
Section titled “Returns”void
useWpRoles()
Section titled “useWpRoles()”useWpRoles(): { capabilities: string[]; label: string; rank: number; slug: string; wpCapabilities: string[];}[];Defined in: types/adapters/wordpress.ts:231
Returns
Section titled “Returns”{
capabilities: string[];
label: string;
rank: number;
slug: string;
wpCapabilities: string[];
}[]
useWpSearchAllPosts()
Section titled “useWpSearchAllPosts()”useWpSearchAllPosts(query, options?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<..., ...>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: ...]: ...; rendered: ...; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: ...]: ...; rendered: ...; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: ... | ...; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; categories: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; meta: Record<string, unknown>; modified: string; modified_gmt: string; ping_status: string; slug: string; status: string; sticky: boolean; tags: number[]; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}[]>>;Defined in: types/adapters/wordpress.ts:262
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
query |
string |
options? |
{ [key: string]: unknown; _embed?: string | boolean; _fields?: string; author?: number | number[]; categories?: number | number[]; exclude?: number[]; include?: number[]; offset?: number; order?: "desc" | "asc"; orderby?: string; page?: number; per_page?: number; search?: string; slug?: string; status?: string | string[]; tags?: number | number[]; } |
options._embed? |
string | boolean |
options._fields? |
string |
options.author? |
number | number[] |
options.categories? |
number | number[] |
options.exclude? |
number[] |
options.include? |
number[] |
options.offset? |
number |
options.order? |
"desc" | "asc" |
options.orderby? |
string |
options.page? |
number |
options.per_page? |
number |
options.search? |
string |
options.slug? |
string |
options.status? |
string | string[] |
options.tags? |
number | number[] |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<…, …>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: …]: …;
rendered: …;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: …]: …;
rendered: …;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: … | …;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
categories: number[];
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
format: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
ping_status: string;
slug: string;
status: string;
sticky: boolean;
tags: number[];
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[]>>
useWpSyncRoles()
Section titled “useWpSyncRoles()”useWpSyncRoles(): void;Defined in: types/adapters/wordpress.ts:234
Returns
Section titled “Returns”void
useWpUnassignRole()
Section titled “useWpUnassignRole()”useWpUnassignRole(userId, role): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}>>;Defined in: types/adapters/wordpress.ts:237
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
userId |
number |
role |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}>>
useWpUpdateCategory()
Section titled “useWpUpdateCategory()”useWpUpdateCategory(id, data): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; taxonomy: string;}>>;Defined in: types/adapters/wordpress.ts:211
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; description?: string; name?: string; parent?: number; slug?: string; taxonomy?: string; } |
data.acf? |
Record<string, unknown> |
data.description? |
string |
data.name? |
string |
data.parent? |
number |
data.slug? |
string |
data.taxonomy? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
parent: number;
slug: string;
taxonomy: string;
}>>
useWpUpdateComment()
Section titled “useWpUpdateComment()”useWpUpdateComment(id, data): Promise<FetchResult<{[key: string]: unknown; author: number; author_avatar_urls: Record<string, string>; author_email: string; author_name: string; author_url: string; content: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; id: number; link: string; meta: Record<string, unknown>; parent: number; post: number; status: string; type: string;}>>;Defined in: types/adapters/wordpress.ts:221
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
data |
{ [key: string]: unknown; author?: number; author_email?: string; author_name?: string; author_url?: string; content?: { [key: string]: unknown; rendered: string; }; parent?: number; status?: string; } |
data.author? |
number |
data.author_email? |
string |
data.author_name? |
string |
data.author_url? |
string |
data.content? |
{ [key: string]: unknown; rendered: string; } |
data.content.rendered? |
string |
data.parent? |
number |
data.status? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
author: number;
author_avatar_urls: Record<string, string>;
author_email: string;
author_name: string;
author_url: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
id: number;
link: string;
meta: Record<string, unknown>;
parent: number;
post: number;
status: string;
type: string;
}>>
useWpUpdateCustomPost()
Section titled “useWpUpdateCustomPost()”useWpUpdateCustomPost( postType, id, data): Promise<FetchResult<unknown>>;Defined in: types/adapters/wordpress.ts:250
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
postType |
string |
id |
number |
data |
Record<string, unknown> |
Returns
Section titled “Returns”Promise<FetchResult<unknown>>
useWpUpdateMedia()
Section titled “useWpUpdateMedia()”useWpUpdateMedia(id, data): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; alt_text: string; author: number; caption: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; description: { [key: string]: unknown; rendered: string; }; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; media_details: { [key: string]: unknown; file?: string; filesize?: number; height?: number; image_meta?: { [key: string]: unknown; aperture?: string; camera?: string; caption?: string; copyright?: string; created_timestamp?: string; credit?: string; focal_length?: string; iso?: string; orientation?: string; shutter_speed?: string; title?: string; }; sizes?: Record<string, { [key: string]: unknown; file: string; filesize?: number; height: number; mime_type: string; source_url: string; width: number; }>; width?: number; }; media_type: string; meta: Record<string, unknown>; mime_type: string; modified: string; modified_gmt: string; post: number | null; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:206
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
data |
{ alt_text?: string; caption?: string; description?: string; post?: number; slug?: string; status?: string; title?: string; } |
data.alt_text? |
string |
data.caption? |
string |
data.description? |
string |
data.post? |
number |
data.slug? |
string |
data.status? |
string |
data.title? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
alt_text: string;
author: number;
caption: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
description: {
[key: string]: unknown;
rendered: string;
};
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
media_details: {
[key: string]: unknown;
file?: string;
filesize?: number;
height?: number;
image_meta?: {
[key: string]: unknown;
aperture?: string;
camera?: string;
caption?: string;
copyright?: string;
created_timestamp?: string;
credit?: string;
focal_length?: string;
iso?: string;
orientation?: string;
shutter_speed?: string;
title?: string;
};
sizes?: Record<string, {
[key: string]: unknown;
file: string;
filesize?: number;
height: number;
mime_type: string;
source_url: string;
width: number;
}>;
width?: number;
};
media_type: string;
meta: Record<string, unknown>;
mime_type: string;
modified: string;
modified_gmt: string;
post: number | null;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpUpdatePage()
Section titled “useWpUpdatePage()”useWpUpdatePage(id, data): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; menu_order: number; meta: Record<string, unknown>; modified: string; modified_gmt: string; parent: number; ping_status: string; slug: string; status: string; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:201
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; author?: number; comment_status?: string; content?: { [key: string]: unknown; protected: boolean; rendered: string; }; excerpt?: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media?: number; guid?: { [key: string]: unknown; rendered: string; }; menu_order?: number; meta?: Record<string, unknown>; parent?: number; ping_status?: string; slug?: string; status?: string; template?: string; title?: { [key: string]: unknown; rendered: string; }; type?: string; } |
data.acf? |
Record<string, unknown> |
data.author? |
number |
data.comment_status? |
string |
data.content? |
{ [key: string]: unknown; protected: boolean; rendered: string; } |
data.content.protected? |
boolean |
data.content.rendered? |
string |
data.excerpt? |
{ [key: string]: unknown; protected: boolean; rendered: string; } |
data.excerpt.protected? |
boolean |
data.excerpt.rendered? |
string |
data.featured_media? |
number |
data.guid? |
{ [key: string]: unknown; rendered: string; } |
data.guid.rendered? |
string |
data.menu_order? |
number |
data.meta? |
Record<string, unknown> |
data.parent? |
number |
data.ping_status? |
string |
data.slug? |
string |
data.status? |
string |
data.template? |
string |
data.title? |
{ [key: string]: unknown; rendered: string; } |
data.title.rendered? |
string |
data.type? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
menu_order: number;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
parent: number;
ping_status: string;
slug: string;
status: string;
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpUpdatePost()
Section titled “useWpUpdatePost()”useWpUpdatePost(id, data): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; author: number; categories: number[]; comment_status: string; content: { [key: string]: unknown; protected: boolean; rendered: string; }; date: string; date_gmt: string; excerpt: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media: number; format: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; meta: Record<string, unknown>; modified: string; modified_gmt: string; ping_status: string; slug: string; status: string; sticky: boolean; tags: number[]; template: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:196
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; author?: number; categories?: number[]; comment_status?: string; content?: { [key: string]: unknown; protected: boolean; rendered: string; }; excerpt?: { [key: string]: unknown; protected: boolean; rendered: string; }; featured_media?: number; format?: string; guid?: { [key: string]: unknown; rendered: string; }; meta?: Record<string, unknown>; ping_status?: string; slug?: string; status?: string; sticky?: boolean; tags?: number[]; template?: string; title?: { [key: string]: unknown; rendered: string; }; type?: string; } |
data.acf? |
Record<string, unknown> |
data.author? |
number |
data.categories? |
number[] |
data.comment_status? |
string |
data.content? |
{ [key: string]: unknown; protected: boolean; rendered: string; } |
data.content.protected? |
boolean |
data.content.rendered? |
string |
data.excerpt? |
{ [key: string]: unknown; protected: boolean; rendered: string; } |
data.excerpt.protected? |
boolean |
data.excerpt.rendered? |
string |
data.featured_media? |
number |
data.format? |
string |
data.guid? |
{ [key: string]: unknown; rendered: string; } |
data.guid.rendered? |
string |
data.meta? |
Record<string, unknown> |
data.ping_status? |
string |
data.slug? |
string |
data.status? |
string |
data.sticky? |
boolean |
data.tags? |
number[] |
data.template? |
string |
data.title? |
{ [key: string]: unknown; rendered: string; } |
data.title.rendered? |
string |
data.type? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
author: number;
categories: number[];
comment_status: string;
content: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
date: string;
date_gmt: string;
excerpt: {
[key: string]: unknown;
protected: boolean;
rendered: string;
};
featured_media: number;
format: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
meta: Record<string, unknown>;
modified: string;
modified_gmt: string;
ping_status: string;
slug: string;
status: string;
sticky: boolean;
tags: number[];
template: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>
useWpUpdateTag()
Section titled “useWpUpdateTag()”useWpUpdateTag(id, data): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; taxonomy: string;}>>;Defined in: types/adapters/wordpress.ts:216
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; description?: string; name?: string; slug?: string; taxonomy?: string; } |
data.acf? |
Record<string, unknown> |
data.description? |
string |
data.name? |
string |
data.slug? |
string |
data.taxonomy? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
count: number;
description: string;
id: number;
link: string;
meta: Record<string, unknown>;
name: string;
slug: string;
taxonomy: string;
}>>
useWpUpdateUser()
Section titled “useWpUpdateUser()”useWpUpdateUser(id, data): Promise<FetchResult<{[key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; capabilities: Record<string, boolean>; description: string; email: string; extra_capabilities: Record<string, boolean>; first_name: string; id: number; last_name: string; link: string; locale: string; meta: Record<string, unknown>; name: string; nickname: string; registered_date: string; roles: string[]; slug: string; url: string; username: string;}>>;Defined in: types/adapters/wordpress.ts:227
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
data |
{ [key: string]: unknown; acf?: Record<string, unknown>; description?: string; email?: string; first_name?: string; last_name?: string; locale?: string; name?: string; nickname?: string; password?: string; roles?: string[]; slug?: string; url?: string; username?: string; } |
data.acf? |
Record<string, unknown> |
data.description? |
string |
data.email? |
string |
data.first_name? |
string |
data.last_name? |
string |
data.locale? |
string |
data.name? |
string |
data.nickname? |
string |
data.password? |
string |
data.roles? |
string[] |
data.slug? |
string |
data.url? |
string |
data.username? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
capabilities: Record<string, boolean>;
description: string;
email: string;
extra_capabilities: Record<string, boolean>;
first_name: string;
id: number;
last_name: string;
link: string;
locale: string;
meta: Record<string, unknown>;
name: string;
nickname: string;
registered_date: string;
roles: string[];
slug: string;
url: string;
username: string;
}>>
useWpUploadMedia()
Section titled “useWpUploadMedia()”useWpUploadMedia(file, meta?): Promise<FetchResult<{[key: string]: unknown; _embedded?: { [key: string]: unknown; author?: { [key: string]: unknown; acf?: Record<string, unknown>; avatar_urls: Record<string, string>; description: string; id: number; link: string; name: string; slug: string; url: string; }[]; "wp:comment"?: { [key: string]: unknown; author: number; author_name: string; content: { [key: string]: unknown; rendered: string; }; date: string; id: number; parent: number; }[][]; "wp:featuredmedia"?: { [key: string]: unknown; alt_text: string; date: string; date_gmt: string; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; modified: string; modified_gmt: string; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string; }[]; "wp:term"?: { [key: string]: unknown; acf?: Record<..., ...>; id: number; name: string; slug: string; taxonomy: string; }[][]; }; acf?: Record<string, unknown>; alt_text: string; author: number; caption: { [key: string]: unknown; rendered: string; }; date: string; date_gmt: string; description: { [key: string]: unknown; rendered: string; }; guid?: { [key: string]: unknown; rendered: string; }; id: number; link: string; media_details: { [key: string]: unknown; file?: string; filesize?: number; height?: number; image_meta?: { [key: string]: unknown; aperture?: string; camera?: string; caption?: string; copyright?: string; created_timestamp?: string; credit?: string; focal_length?: string; iso?: string; orientation?: string; shutter_speed?: string; title?: string; }; sizes?: Record<string, { [key: string]: unknown; file: string; filesize?: number; height: number; mime_type: string; source_url: string; width: number; }>; width?: number; }; media_type: string; meta: Record<string, unknown>; mime_type: string; modified: string; modified_gmt: string; post: number | null; slug: string; source_url: string; status: string; title: { [key: string]: unknown; rendered: string; }; type?: string;}>>;Defined in: types/adapters/wordpress.ts:205
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
file |
File | Blob | Buffer<ArrayBufferLike> |
meta? |
{ alt_text?: string; caption?: string; description?: string; post?: number; slug?: string; title?: string; } |
meta.alt_text? |
string |
meta.caption? |
string |
meta.description? |
string |
meta.post? |
number |
meta.slug? |
string |
meta.title? |
string |
Returns
Section titled “Returns”Promise<FetchResult<{
[key: string]: unknown;
_embedded?: {
[key: string]: unknown;
author?: {
[key: string]: unknown;
acf?: Record<string, unknown>;
avatar_urls: Record<string, string>;
description: string;
id: number;
link: string;
name: string;
slug: string;
url: string;
}[];
"wp:comment"?: {
[key: string]: unknown;
author: number;
author_name: string;
content: {
[key: string]: unknown;
rendered: string;
};
date: string;
id: number;
parent: number;
}[][];
"wp:featuredmedia"?: {
[key: string]: unknown;
alt_text: string;
date: string;
date_gmt: string;
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
modified: string;
modified_gmt: string;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}[];
"wp:term"?: {
[key: string]: unknown;
acf?: Record<…, …>;
id: number;
name: string;
slug: string;
taxonomy: string;
}[][];
};
acf?: Record<string, unknown>;
alt_text: string;
author: number;
caption: {
[key: string]: unknown;
rendered: string;
};
date: string;
date_gmt: string;
description: {
[key: string]: unknown;
rendered: string;
};
guid?: {
[key: string]: unknown;
rendered: string;
};
id: number;
link: string;
media_details: {
[key: string]: unknown;
file?: string;
filesize?: number;
height?: number;
image_meta?: {
[key: string]: unknown;
aperture?: string;
camera?: string;
caption?: string;
copyright?: string;
created_timestamp?: string;
credit?: string;
focal_length?: string;
iso?: string;
orientation?: string;
shutter_speed?: string;
title?: string;
};
sizes?: Record<string, {
[key: string]: unknown;
file: string;
filesize?: number;
height: number;
mime_type: string;
source_url: string;
width: number;
}>;
width?: number;
};
media_type: string;
meta: Record<string, unknown>;
mime_type: string;
modified: string;
modified_gmt: string;
post: number | null;
slug: string;
source_url: string;
status: string;
title: {
[key: string]: unknown;
rendered: string;
};
type?: string;
}>>