Skip to main content

Interface: TaxonomyArchiveParams

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:16

The endpoint params supported by TaxonomyTermsStrategy

Extends​

Indexable​

[k: string]: unknown

Properties​

_embed?​

optional _embed: boolean

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:17

The _embed param returned associated entities in the response

It's recommended to avoid additional requests to fetch data

Inherited from​

EndpointParams._embed

_fields?​

optional _fields: string[]

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:22

The _fields parameter is used to return only the specified fields in the response

Inherited from​

EndpointParams._fields

exclude?​

optional exclude: number | number[]

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49

Ensure result set excludes specific IDs.

hide_empty?​

optional hide_empty: string

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76

Whether to hide terms not assigned to any posts.

include?​

optional include: number | number[]

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44

Limit result set to specific IDs.

lang?​

optional lang: string

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:29

The polylang ?lang parameter.

This is only used if the polylang integration is enabled

Inherited from​

EndpointParams.lang

optimizeYoastPayload?​

optional optimizeYoastPayload: boolean

Defined in: packages/core/src/data/strategies/AbstractFetchStrategy.ts:36

The custom parameter to optimize the Yoast payload.

This is only used if the YoastSEO integration is enabled

Inherited from​

EndpointParams.optimizeYoastPayload

order?​

optional order: "desc" | "asc"

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56

Order sort attribute ascending or descending.

Default​

'asc'

orderby?​

optional orderby: "slug" | "id" | "name" | "description" | "count" | "include" | "include_slugs" | "term_group"

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63

Sort collection by term attribute.

Default​

'name'

page?​

optional page: string

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27

Current page of the collection.

Default​

1

parent?​

optional parent: number

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81

Limit result set to terms assigned to a specific parent.

per_page?​

optional per_page: string

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34

Maximum number of items to be returned in result set.

Default​

10

post?​

optional post: number

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86

Limit result set to terms assigned to a specific post.

optional search: string

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39

Limit results to those matching a string

slug?​

optional slug: string | string[]

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91

Limit result set to terms with one or more specific slugs.

taxonomy?​

optional taxonomy: string

Defined in: packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20

The taxonomy the terms are to be fetched from.