Saltar al contenido principal

Interface: WpQueryParams

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

Common query parameters for WordPress REST API list endpoints.

Indexable​

[key: string]: unknown

Custom query params.

Properties​

_embed?​

optional _embed?: string | boolean

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

Embed related resources in the response (author, featured media, terms, replies). Accepts true to embed all, or comma-separated resource names.

Example​

useWpGetPosts({ _embed: true }); // embed all
useWpGetPosts({ _embed: "author,wp:featuredmedia" }); // embed specific

_fields?​

optional _fields?: string

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

Limit response fields to reduce payload size. Use comma-separated field names: "id,title,link" or nested: "id,title.rendered,acf.custom_field". Reduces response size by 60-80% — essential for list views.

Example​

useWpGetPosts({ _fields: "id,title,link,slug,date" });
useWpGetPosts({ _fields: "id,title.rendered,acf.hero_image,acf.subtitle" }); // with ACF

author?​

optional author?: number | number[]

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

Filter by author.

categories?​

optional categories?: number | number[]

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

Filter by categories.

exclude?​

optional exclude?: number[]

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

Exclude specific IDs.

include?​

optional include?: number[]

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

Include specific IDs.

offset?​

optional offset?: number

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

Offset for pagination.

order?​

optional order?: "asc" | "desc"

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

Sort order.

orderby?​

optional orderby?: string

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

Order by field.

page?​

optional page?: number

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

Current page (default: 1).

per_page?​

optional per_page?: number

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

Items per page (default: 10, max: 100).

optional search?: string

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

Search term.

slug?​

optional slug?: string

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

Filter by slug.

status?​

optional status?: string | string[]

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

Filter by status.

tags?​

optional tags?: number | number[]

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

Filter by tags.