katanakit-js / IWordPressService

Interface: IWordPressService

Defined in: src/types/index.ts:1325

Contract of the WordPress adapter facade.

Methods

useWpAssignRole()

useWpAssignRole(userId, role): Promise<FetchResult<{
[key: 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: src/types/index.ts:1371

Parameters

Parameter	Type
userId	number
role	string

Returns

Promise<FetchResult<{ [key: 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()

useWpAsSubject(user): {
[key: string]: unknown;
  id: string | number;
  roles: string[];
};

Defined in: src/types/index.ts:1370

Parameters

Parameter	Type	Description
user	{ [key: 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.avatar_urls	Record<string, string>	-
user.capabilities?	Record<string, boolean>	Effective capabilities, context=edit only.
user.description	string	-
user.email	string	-
user.extra_capabilities?	Record<string, boolean>	Per-user capability overrides, context=edit only.
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

{
[key: string]: unknown;
  id: string | number;
  roles: string[];
}

id

id: string | number;

roles

roles: string[];

---

useWpAuditRole()

useWpAuditRole(slug, maxHolders?): Promise<FetchResult<{
  declared: string[];
  granted: string[];
  holders: number;
  missing: string[];
  slug: string;
  status: "verified" | "partial" | "unverifiable";
  undeclared: string[];
}>>;

Defined in: src/types/index.ts:1374

Parameters

Parameter	Type
slug	string
maxHolders?	number

Returns

Promise<FetchResult<{ declared: string[]; granted: string[]; holders: number; missing: string[]; slug: string; status: "verified" | "partial" | "unverifiable"; undeclared: string[]; }>>

---

useWpBatch()

useWpBatch(operations): Promise<FetchResult<{
[key: string]: unknown;
  responses: {
   [key: string]: unknown;
     body: unknown;
     headers: Record<string, string>;
     status: number;
  }[];
}>>;

Defined in: src/types/index.ts:1395

Parameters

Parameter	Type
operations	{ body?: Record<string, unknown>; method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH"; path: string; }[]

Returns

Promise<FetchResult<{ [key: string]: unknown; responses: { [key: string]: unknown; body: unknown; headers: Record<string, string>; status: number; }[]; }>>

---

useWpCreateCategory()

useWpCreateCategory(data): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  parent: number;
  slug: string;
}>>;

Defined in: src/types/index.ts:1345

Parameters

Parameter	Type
data	{ description?: string; meta?: Record<string, unknown>; name: string; parent?: number; slug?: string; }
data.description?	string
data.meta?	Record<string, unknown>
data.name	string
data.parent?	number
data.slug?	string

Returns

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; }>>

---

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: src/types/index.ts:1355

Parameters

Parameter	Type
data	{ author?: number; author_email?: string; author_name?: string; author_url?: string; content: string; meta?: Record<string, unknown>; parent?: number; post: number; status?: string; }
data.author?	number
data.author_email?	string
data.author_name?	string
data.author_url?	string
data.content	string
data.meta?	Record<string, unknown>
data.parent?	number
data.post	number
data.status?	string

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()

useWpCreateCustomPost(postType, data): Promise<FetchResult<unknown>>;

Defined in: src/types/index.ts:1381

Parameters

Parameter	Type
postType	string
data	Record<string, unknown>

Returns

Promise<FetchResult<unknown>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}>>;

Defined in: src/types/index.ts:1335

Parameters

Parameter	Type
data	{ author?: number; comment_status?: "open" | "closed"; content?: string; date?: string; excerpt?: string; featured_media?: number; menu_order?: number; meta?: Record<string, unknown>; parent?: number; ping_status?: "open" | "closed"; slug?: string; status?: "publish" | "future" | "draft" | "pending" | "private"; template?: string; title: string; }
data.author?	number
data.comment_status?	"open" | "closed"
data.content?	string
data.date?	string
data.excerpt?	string
data.featured_media?	number
data.menu_order?	number
data.meta?	Record<string, unknown>
data.parent?	number
data.ping_status?	"open" | "closed"
data.slug?	string
data.status?	"publish" | "future" | "draft" | "pending" | "private"
data.template?	string
data.title	string

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; 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; }; }>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}>>;

Defined in: src/types/index.ts:1330

Parameters

Parameter	Type
data	{ author?: number; categories?: number[]; comment_status?: "open" | "closed"; content?: string; date?: string; excerpt?: string; featured_media?: number; format?: string; meta?: Record<string, unknown>; ping_status?: "open" | "closed"; slug?: string; status?: "publish" | "future" | "draft" | "pending" | "private"; sticky?: boolean; tags?: number[]; template?: string; title: string; }
data.author?	number
data.categories?	number[]
data.comment_status?	"open" | "closed"
data.content?	string
data.date?	string
data.excerpt?	string
data.featured_media?	number
data.format?	string
data.meta?	Record<string, unknown>
data.ping_status?	"open" | "closed"
data.slug?	string
data.status?	"publish" | "future" | "draft" | "pending" | "private"
data.sticky?	boolean
data.tags?	number[]
data.template?	string
data.title	string

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; 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; }; }>>

---

useWpCreateTag()

useWpCreateTag(data): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  slug: string;
}>>;

Defined in: src/types/index.ts:1350

Parameters

Parameter	Type
data	{ description?: string; meta?: Record<string, unknown>; name: string; slug?: string; }
data.description?	string
data.meta?	Record<string, unknown>
data.name	string
data.slug?	string

Returns

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; }>>

---

useWpCreateUser()

useWpCreateUser(data): Promise<FetchResult<{
[key: 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: src/types/index.ts:1361

Parameters

Parameter	Type
data	{ description?: string; email: string; first_name?: string; last_name?: string; locale?: string; meta?: Record<string, unknown>; name?: string; nickname?: string; password?: string; roles?: string[]; slug?: string; url?: string; username: string; }
data.description?	string
data.email	string
data.first_name?	string
data.last_name?	string
data.locale?	string
data.meta?	Record<string, unknown>
data.name?	string
data.nickname?	string
data.password?	string
data.roles?	string[]
data.slug?	string
data.url?	string
data.username	string

Returns

Promise<FetchResult<{ [key: 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()

useWpDefineRoles(definitions): void;

Defined in: src/types/index.ts:1364

Parameters

Parameter	Type
definitions	{ capabilities: string[]; label: string; rank: number; slug: string; wpCapabilities: string[]; }[]

Returns

void

---

useWpDeleteCategory()

useWpDeleteCategory(id, force?): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  parent: number;
  slug: string;
}>>;

Defined in: src/types/index.ts:1347

Parameters

Parameter	Type
id	number
force?	boolean

Returns

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; }>>

---

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: src/types/index.ts:1357

Parameters

Parameter	Type
id	number
force?	boolean

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()

useWpDeleteCustomPost(
   postType, 
   id, 
   force?
): Promise<FetchResult<unknown>>;

Defined in: src/types/index.ts:1390

Parameters

Parameter	Type
postType	string
id	number
force?	boolean

Returns

Promise<FetchResult<unknown>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  };
  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;
  };
}>>;

Defined in: src/types/index.ts:1342

Parameters

Parameter	Type
id	number
force?	boolean

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; }; 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; }; }>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}>>;

Defined in: src/types/index.ts:1337

Parameters

Parameter	Type
id	number
force?	boolean

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; 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; }; }>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}>>;

Defined in: src/types/index.ts:1332

Parameters

Parameter	Type
id	number
force?	boolean

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; 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; }; }>>

---

useWpDeleteTag()

useWpDeleteTag(id, force?): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  slug: string;
}>>;

Defined in: src/types/index.ts:1352

Parameters

Parameter	Type
id	number
force?	boolean

Returns

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; }>>

---

useWpDeleteUser()

useWpDeleteUser(id, reassign?): Promise<FetchResult<{
[key: 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: src/types/index.ts:1363

Parameters

Parameter	Type
id	number
reassign?	number

Returns

Promise<FetchResult<{ [key: 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()

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: ...]: ...;
           rendered: ...;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: ... | ...;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}
| null>>;

Defined in: src/types/index.ts:1398

Parameters

Parameter	Type
slug	string

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: ...]: ...; rendered: ...; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: ... | ...; id: number; link: string; name: string; slug: 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; 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; }; } | null>>

---

useWpGetCategories()

useWpGetCategories(options?): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  parent: number;
  slug: string;
}[]>>;

Defined in: src/types/index.ts:1343

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

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; }[]>>

---

useWpGetCategory()

useWpGetCategory(id): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  parent: number;
  slug: string;
}>>;

Defined in: src/types/index.ts:1344

Parameters

Parameter	Type
id	number

Returns

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; }>>

---

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: src/types/index.ts:1354

Parameters

Parameter	Type
id	number

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()

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: src/types/index.ts:1353

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

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()

useWpGetCurrentUser(): Promise<FetchResult<{
[key: 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: src/types/index.ts:1360

Returns

Promise<FetchResult<{ [key: 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()

useWpGetCustomPost(
   postType, 
   id, 
   options?
): Promise<FetchResult<unknown>>;

Defined in: src/types/index.ts:1376

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

Promise<FetchResult<unknown>>

---

useWpGetCustomPosts()

useWpGetCustomPosts(postType, options?): Promise<FetchResult<unknown[]>>;

Defined in: src/types/index.ts:1375

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

Promise<FetchResult<unknown[]>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: ...]: ...;
           rendered: ...;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: ... | ...;
        id: number;
        link: string;
        name: string;
        slug: 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;
  };
  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;
  };
}[]>>;

Defined in: src/types/index.ts:1338

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: ...]: ...; rendered: ...; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: ... | ...; id: number; link: string; name: string; slug: 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; }; 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; }; }[]>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  };
  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;
  };
}>>;

Defined in: src/types/index.ts:1339

Parameters

Parameter	Type
id	number

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; }; 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; }; }>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}>>;

Defined in: src/types/index.ts:1334

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; 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; }; }>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: ...]: ...;
           rendered: ...;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: ... | ...;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}[]>>;

Defined in: src/types/index.ts:1333

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: ...]: ...; rendered: ...; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: ... | ...; id: number; link: string; name: string; slug: 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; 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; }; }[]>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}>>;

Defined in: src/types/index.ts:1329

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; 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; }; }>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: ...]: ...;
           rendered: ...;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: ... | ...;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}[]>>;

Defined in: src/types/index.ts:1328

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: ...]: ...; rendered: ...; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: ... | ...; id: number; link: string; name: string; slug: 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; 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; }; }[]>>

---

useWpGetRole()

useWpGetRole(slug): 
  | {
  capabilities: string[];
  label: string;
  rank: number;
  slug: string;
  wpCapabilities: string[];
}
  | undefined;

Defined in: src/types/index.ts:1367

Parameters

Parameter	Type
slug	string

Returns

Type Literal

{
  capabilities: string[];
  label: string;
  rank: number;
  slug: string;
  wpCapabilities: string[];
}

capabilities

capabilities: string[];

label

label: string;

rank

rank: number;

Position in the toolkit hierarchy, lower is more privileged. Integers only, so a custom role shares a rung with a built-in rather than sitting between two: a store_customer at 5 inherits from guest and adds its own capabilities. A shared rank means equal privilege, not a conflict.

slug

slug: string = AccessRoleSchema;

wpCapabilities

wpCapabilities: string[];

---

undefined

---

useWpGetTag()

useWpGetTag(id): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  slug: string;
}>>;

Defined in: src/types/index.ts:1349

Parameters

Parameter	Type
id	number

Returns

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; }>>

---

useWpGetTags()

useWpGetTags(options?): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  slug: string;
}[]>>;

Defined in: src/types/index.ts:1348

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

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; }[]>>

---

useWpGetUser()

useWpGetUser(id): Promise<FetchResult<{
[key: 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: src/types/index.ts:1359

Parameters

Parameter	Type
id	number

Returns

Promise<FetchResult<{ [key: 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()

useWpGetUsers(options?): Promise<FetchResult<{
[key: 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: src/types/index.ts:1358

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

Promise<FetchResult<{ [key: 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()

useWpGetUsersByRole(role, options?): Promise<FetchResult<{
[key: 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: src/types/index.ts:1373

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

Promise<FetchResult<{ [key: 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()

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: ...]: ...;
           rendered: ...;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: ... | ...;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}[]>>;

Defined in: src/types/index.ts:1396

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: ...]: ...; rendered: ...; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: ... | ...; id: number; link: string; name: string; slug: 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; 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; }; }[]>>

---

useWpRegisterRole()

useWpRegisterRole(definition): void;

Defined in: src/types/index.ts:1365

Parameters

Parameter	Type	Description
definition	{ capabilities: string[]; label: string; rank: number; slug: string; wpCapabilities: string[]; }	-
definition.capabilities	string[]	-
definition.label	string	-
definition.rank	number	Position in the toolkit hierarchy, lower is more privileged. Integers only, so a custom role shares a rung with a built-in rather than sitting between two: a store_customer at 5 inherits from guest and adds its own capabilities. A shared rank means equal privilege, not a conflict.
definition.slug	string	-
definition.wpCapabilities	string[]	-

Returns

void

---

useWpResetRoles()

useWpResetRoles(): void;

Defined in: src/types/index.ts:1368

Returns

void

---

useWpRoles()

useWpRoles(): {
  capabilities: string[];
  label: string;
  rank: number;
  slug: string;
  wpCapabilities: string[];
}[];

Defined in: src/types/index.ts:1366

Returns

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: ...]: ...;
           rendered: ...;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: ... | ...;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}[]>>;

Defined in: src/types/index.ts:1397

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: ...]: ...; rendered: ...; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: ... | ...; id: number; link: string; name: string; slug: 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; 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; }; }[]>>

---

useWpSyncRoles()

useWpSyncRoles(): void;

Defined in: src/types/index.ts:1369

Returns

void

---

useWpUnassignRole()

useWpUnassignRole(userId, role): Promise<FetchResult<{
[key: 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: src/types/index.ts:1372

Parameters

Parameter	Type
userId	number
role	string

Returns

Promise<FetchResult<{ [key: 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()

useWpUpdateCategory(id, data): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  parent: number;
  slug: string;
}>>;

Defined in: src/types/index.ts:1346

Parameters

Parameter	Type
id	number
data	{ description?: string; meta?: Record<string, unknown>; name?: string; parent?: number; slug?: string; }
data.description?	string
data.meta?	Record<string, unknown>
data.name?	string
data.parent?	number
data.slug?	string

Returns

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; parent: number; slug: string; }>>

---

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: src/types/index.ts:1356

Parameters

Parameter	Type
id	number
data	{ author?: number; author_email?: string; author_name?: string; author_url?: string; content?: string; meta?: Record<string, unknown>; parent?: number; post?: number; status?: string; }
data.author?	number
data.author_email?	string
data.author_name?	string
data.author_url?	string
data.content?	string
data.meta?	Record<string, unknown>
data.parent?	number
data.post?	number
data.status?	string

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()

useWpUpdateCustomPost(
   postType, 
   id, 
   data
): Promise<FetchResult<unknown>>;

Defined in: src/types/index.ts:1385

Parameters

Parameter	Type
postType	string
id	number
data	Record<string, unknown>

Returns

Promise<FetchResult<unknown>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  };
  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;
  };
}>>;

Defined in: src/types/index.ts:1341

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; }; 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; }; }>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}>>;

Defined in: src/types/index.ts:1336

Parameters

Parameter	Type
id	number
data	{ author?: number; comment_status?: "open" | "closed"; content?: string; date?: string; excerpt?: string; featured_media?: number; menu_order?: number; meta?: Record<string, unknown>; parent?: number; ping_status?: "open" | "closed"; slug?: string; status?: "publish" | "future" | "draft" | "pending" | "private"; template?: string; title?: string; }
data.author?	number
data.comment_status?	"open" | "closed"
data.content?	string
data.date?	string
data.excerpt?	string
data.featured_media?	number
data.menu_order?	number
data.meta?	Record<string, unknown>
data.parent?	number
data.ping_status?	"open" | "closed"
data.slug?	string
data.status?	"publish" | "future" | "draft" | "pending" | "private"
data.template?	string
data.title?	string

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; 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; }; }>>

---

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  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;
  };
}>>;

Defined in: src/types/index.ts:1331

Parameters

Parameter	Type
id	number
data	{ author?: number; categories?: number[]; comment_status?: "open" | "closed"; content?: string; date?: string; excerpt?: string; featured_media?: number; format?: string; meta?: Record<string, unknown>; ping_status?: "open" | "closed"; slug?: string; status?: "publish" | "future" | "draft" | "pending" | "private"; sticky?: boolean; tags?: number[]; template?: string; title?: string; }
data.author?	number
data.categories?	number[]
data.comment_status?	"open" | "closed"
data.content?	string
data.date?	string
data.excerpt?	string
data.featured_media?	number
data.format?	string
data.meta?	Record<string, unknown>
data.ping_status?	"open" | "closed"
data.slug?	string
data.status?	"publish" | "future" | "draft" | "pending" | "private"
data.sticky?	boolean
data.tags?	number[]
data.template?	string
data.title?	string

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; 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; }; }>>

---

useWpUpdateTag()

useWpUpdateTag(id, data): Promise<FetchResult<{
[key: string]: unknown;
  count: number;
  description: string;
  id: number;
  link: string;
  meta: Record<string, unknown>;
  name: string;
  slug: string;
}>>;

Defined in: src/types/index.ts:1351

Parameters

Parameter	Type
id	number
data	{ description?: string; meta?: Record<string, unknown>; name?: string; slug?: string; }
data.description?	string
data.meta?	Record<string, unknown>
data.name?	string
data.slug?	string

Returns

Promise<FetchResult<{ [key: string]: unknown; count: number; description: string; id: number; link: string; meta: Record<string, unknown>; name: string; slug: string; }>>

---

useWpUpdateUser()

useWpUpdateUser(id, data): Promise<FetchResult<{
[key: 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: src/types/index.ts:1362

Parameters

Parameter	Type
id	number
data	{ description?: string; email?: string; first_name?: string; last_name?: string; locale?: string; meta?: Record<string, unknown>; name?: string; nickname?: string; password?: string; roles?: string[]; slug?: string; url?: string; username?: string; }
data.description?	string
data.email?	string
data.first_name?	string
data.last_name?	string
data.locale?	string
data.meta?	Record<string, unknown>
data.name?	string
data.nickname?	string
data.password?	string
data.roles?	string[]
data.slug?	string
data.url?	string
data.username?	string

Returns

Promise<FetchResult<{ [key: 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()

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;
     }[];
     replies?: {
      [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;
        id?: number;
        link?: string;
        modified?: string;
        modified_gmt?: string;
        slug?: string;
        source_url?: string;
        status?: string;
        title?: {
         [key: string]: unknown;
           rendered: string;
        };
     }[];
     wp:term?: {
      [key: string]: unknown;
        _taxonomy: string;
        count?: number;
        id: number;
        link: string;
        name: string;
        slug: 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;
  };
  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;
  };
}>>;

Defined in: src/types/index.ts:1340

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

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; }[]; replies?: { [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; id?: number; link?: string; modified?: string; modified_gmt?: string; slug?: string; source_url?: string; status?: string; title?: { [key: string]: unknown; rendered: string; }; }[]; wp:term?: { [key: string]: unknown; _taxonomy: string; count?: number; id: number; link: string; name: string; slug: 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; }; 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; }; }>>