Saltar al contenido principal

Interface: IWordPressService

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

Contract of the WordPress adapter facade.

Methods​

useInitWordPress()​

useInitWordPress(config): void

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

Parameters​

config​

WordPressConfig

Returns​

void

useWpBatch()​

useWpBatch(operations): Promise<FetchResult<WpBatchResult>>

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

Parameters​

operations​

WpBatchOperation[]

Returns​

Promise<FetchResult<WpBatchResult>>

useWpCreateCategory()​

useWpCreateCategory(data): Promise<FetchResult<WpCategory>>

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

Parameters​

data​

WpCategoryCreate

Returns​

Promise<FetchResult<WpCategory>>

useWpCreateComment()​

useWpCreateComment(data): Promise<FetchResult<WpComment>>

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

Parameters​

data​

WpCommentCreate

Returns​

Promise<FetchResult<WpComment>>

useWpCreateCustomPost()​

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

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

Parameters​

postType​

string

data​

Record<string, unknown>

Returns​

Promise<FetchResult<unknown>>

useWpCreatePage()​

useWpCreatePage(data): Promise<FetchResult<WpPage>>

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

Parameters​

data​

WpPageCreate

Returns​

Promise<FetchResult<WpPage>>

useWpCreatePost()​

useWpCreatePost(data): Promise<FetchResult<WpPost>>

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

Parameters​

data​

WpPostCreate

Returns​

Promise<FetchResult<WpPost>>

useWpCreateTag()​

useWpCreateTag(data): Promise<FetchResult<WpTag>>

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

Parameters​

data​

WpTagCreate

Returns​

Promise<FetchResult<WpTag>>

useWpCreateUser()​

useWpCreateUser(data): Promise<FetchResult<WpUser>>

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

Parameters​

data​

WpUserCreate

Returns​

Promise<FetchResult<WpUser>>

useWpDeleteCategory()​

useWpDeleteCategory(id, force?): Promise<FetchResult<WpCategory>>

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

Parameters​

id​

number

force?​

boolean

Returns​

Promise<FetchResult<WpCategory>>

useWpDeleteComment()​

useWpDeleteComment(id, force?): Promise<FetchResult<WpComment>>

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

Parameters​

id​

number

force?​

boolean

Returns​

Promise<FetchResult<WpComment>>

useWpDeleteCustomPost()​

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

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

Parameters​

postType​

string

id​

number

force?​

boolean

Returns​

Promise<FetchResult<unknown>>

useWpDeleteMedia()​

useWpDeleteMedia(id, force?): Promise<FetchResult<WpMedia>>

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

Parameters​

id​

number

force?​

boolean

Returns​

Promise<FetchResult<WpMedia>>

useWpDeletePage()​

useWpDeletePage(id, force?): Promise<FetchResult<WpPage>>

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

Parameters​

id​

number

force?​

boolean

Returns​

Promise<FetchResult<WpPage>>

useWpDeletePost()​

useWpDeletePost(id, force?): Promise<FetchResult<WpPost>>

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

Parameters​

id​

number

force?​

boolean

Returns​

Promise<FetchResult<WpPost>>

useWpDeleteTag()​

useWpDeleteTag(id, force?): Promise<FetchResult<WpTag>>

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

Parameters​

id​

number

force?​

boolean

Returns​

Promise<FetchResult<WpTag>>

useWpDeleteUser()​

useWpDeleteUser(id, reassign?): Promise<FetchResult<WpUser>>

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

Parameters​

id​

number

reassign?​

number

Returns​

Promise<FetchResult<WpUser>>

useWpFindPostBySlug()​

useWpFindPostBySlug(slug): Promise<FetchResult<WpPost | null>>

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

Parameters​

slug​

string

Returns​

Promise<FetchResult<WpPost | null>>

useWpGetCategories()​

useWpGetCategories(options?): Promise<FetchResult<WpCategory[]>>

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

Parameters​

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpCategory[]>>

useWpGetCategory()​

useWpGetCategory(id): Promise<FetchResult<WpCategory>>

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

Parameters​

id​

number

Returns​

Promise<FetchResult<WpCategory>>

useWpGetComment()​

useWpGetComment(id): Promise<FetchResult<WpComment>>

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

Parameters​

id​

number

Returns​

Promise<FetchResult<WpComment>>

useWpGetComments()​

useWpGetComments(options?): Promise<FetchResult<WpComment[]>>

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

Parameters​

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpComment[]>>

useWpGetCurrentUser()​

useWpGetCurrentUser(): Promise<FetchResult<WpUser>>

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

Returns​

Promise<FetchResult<WpUser>>

useWpGetCustomPost()​

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

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

Parameters​

postType​

string

id​

number

options?​

WpQueryParams

Returns​

Promise<FetchResult<unknown>>

useWpGetCustomPosts()​

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

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

Parameters​

postType​

string

options?​

WpQueryParams

Returns​

Promise<FetchResult<unknown[]>>

useWpGetMedia()​

useWpGetMedia(options?): Promise<FetchResult<WpMedia[]>>

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

Parameters​

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpMedia[]>>

useWpGetMediaItem()​

useWpGetMediaItem(id): Promise<FetchResult<WpMedia>>

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

Parameters​

id​

number

Returns​

Promise<FetchResult<WpMedia>>

useWpGetPage()​

useWpGetPage(id, options?): Promise<FetchResult<WpPage>>

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

Parameters​

id​

number

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpPage>>

useWpGetPages()​

useWpGetPages(options?): Promise<FetchResult<WpPage[]>>

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

Parameters​

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpPage[]>>

useWpGetPost()​

useWpGetPost(id, options?): Promise<FetchResult<WpPost>>

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

Parameters​

id​

number

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpPost>>

useWpGetPosts()​

useWpGetPosts(options?): Promise<FetchResult<WpPost[]>>

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

Parameters​

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpPost[]>>

useWpGetTag()​

useWpGetTag(id): Promise<FetchResult<WpTag>>

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

Parameters​

id​

number

Returns​

Promise<FetchResult<WpTag>>

useWpGetTags()​

useWpGetTags(options?): Promise<FetchResult<WpTag[]>>

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

Parameters​

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpTag[]>>

useWpGetUser()​

useWpGetUser(id): Promise<FetchResult<WpUser>>

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

Parameters​

id​

number

Returns​

Promise<FetchResult<WpUser>>

useWpGetUsers()​

useWpGetUsers(options?): Promise<FetchResult<WpUser[]>>

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

Parameters​

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpUser[]>>

useWpListAllPosts()​

useWpListAllPosts(options?): Promise<FetchResult<WpPost[]>>

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

Parameters​

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpPost[]>>

useWpSearchAllPosts()​

useWpSearchAllPosts(query, options?): Promise<FetchResult<WpPost[]>>

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

Parameters​

query​

string

options?​

WpQueryParams

Returns​

Promise<FetchResult<WpPost[]>>

useWpUpdateCategory()​

useWpUpdateCategory(id, data): Promise<FetchResult<WpCategory>>

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

Parameters​

id​

number

data​

WpCategoryUpdate

Returns​

Promise<FetchResult<WpCategory>>

useWpUpdateComment()​

useWpUpdateComment(id, data): Promise<FetchResult<WpComment>>

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

Parameters​

id​

number

data​

WpCommentUpdate

Returns​

Promise<FetchResult<WpComment>>

useWpUpdateCustomPost()​

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

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

Parameters​

postType​

string

id​

number

data​

Record<string, unknown>

Returns​

Promise<FetchResult<unknown>>

useWpUpdateMedia()​

useWpUpdateMedia(id, data): Promise<FetchResult<WpMedia>>

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

Parameters​

id​

number

data​

WpMediaUpdate

Returns​

Promise<FetchResult<WpMedia>>

useWpUpdatePage()​

useWpUpdatePage(id, data): Promise<FetchResult<WpPage>>

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

Parameters​

id​

number

data​

WpPageUpdate

Returns​

Promise<FetchResult<WpPage>>

useWpUpdatePost()​

useWpUpdatePost(id, data): Promise<FetchResult<WpPost>>

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

Parameters​

id​

number

data​

WpPostUpdate

Returns​

Promise<FetchResult<WpPost>>

useWpUpdateTag()​

useWpUpdateTag(id, data): Promise<FetchResult<WpTag>>

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

Parameters​

id​

number

data​

WpTagUpdate

Returns​

Promise<FetchResult<WpTag>>

useWpUpdateUser()​

useWpUpdateUser(id, data): Promise<FetchResult<WpUser>>

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

Parameters​

id​

number

data​

WpUserUpdate

Returns​

Promise<FetchResult<WpUser>>

useWpUploadMedia()​

useWpUploadMedia(file, meta?): Promise<FetchResult<WpMedia>>

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

Parameters​

file​

File | Blob | Buffer<ArrayBufferLike>

meta?​

WpMediaMeta

Returns​

Promise<FetchResult<WpMedia>>