Interface: TaxonomyArchiveParams
@headstartwp/core.TaxonomyArchiveParams
The endpoint params supported by TaxonomyTermsStrategy
Hierarchy
↳
TaxonomyArchiveParams
Properties
_embed
• Optional _embed: boolean
The _embed param returned associated entities in the response
It's recommended to avoid additional requests to fetch data
Inherited from
Defined in
packages/core/src/data/strategies/AbstractFetchStrategy.ts:17
_fields
• Optional _fields: string[]
The _fields parameter is used to return only the specified fields in the response
Inherited from
Defined in
packages/core/src/data/strategies/AbstractFetchStrategy.ts:22
exclude
• Optional exclude: number | number[]
Ensure result set excludes specific IDs.
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:49
hide_empty
• Optional hide_empty: string
Whether to hide terms not assigned to any posts.
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:76
include
• Optional include: number | number[]
Limit result set to specific IDs.
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:44
lang
• Optional lang: string
The polylang ?lang parameter.
This is only used if the polylang integration is enabled
Inherited from
Defined in
packages/core/src/data/strategies/AbstractFetchStrategy.ts:29
order
• Optional order: "asc" | "desc"
Order sort attribute ascending or descending.
Default
'asc'
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:56
orderby
• Optional orderby: "slug" | "id" | "description" | "name" | "count" | "include" | "include_slugs" | "term_group"
Sort collection by term attribute.
Default
'name'
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:63
page
• Optional page: string
Current page of the collection.
Default
1
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:27
parent
• Optional parent: number
Limit result set to terms assigned to a specific parent.
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:81
per_page
• Optional per_page: string
Maximum number of items to be returned in result set.
Default
10
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:34
post
• Optional post: number
Limit result set to terms assigned to a specific post.
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:86
search
• Optional search: string
Limit results to those matching a string
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:39
slug
• Optional slug: string | string[]
Limit result set to terms with one or more specific slugs.
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:91
taxonomy
• Optional taxonomy: string
The taxonomy the terms are to be fetched from.
Defined in
packages/core/src/data/strategies/TaxonomyTermsStrategy.ts:20