Skip to main content

Interface: TermEntity

@headstartwp/core.TermEntity

Interface for entities that belong to a taxonomy.

For example:

  • entities from the /wp/v2/categories endpoint.
  • entities from the /wp/v2/tags endpoint.

Hierarchy

Properties

count

count: number

Number of published posts for the term.

Defined in

packages/core/src/data/types/entities.ts:441


description

description: string

HTML description of the term.

Defined in

packages/core/src/data/types/entities.ts:446


id

id: number

Unique identifier for the term.

Defined in

packages/core/src/data/types/entities.ts:436


link: string

URL of the term.

Defined in

packages/core/src/data/types/entities.ts:451


meta

meta: Record<string, unknown>

Meta fields.

Defined in

packages/core/src/data/types/entities.ts:476


name

name: string

HTML title for the term.

Defined in

packages/core/src/data/types/entities.ts:456


parent

parent: number

The parent term ID.

Defined in

packages/core/src/data/types/entities.ts:471


slug

slug: string

An alphanumeric identifier for the term unique to its type.

Defined in

packages/core/src/data/types/entities.ts:461


taxonomy

taxonomy: string

Type attribution for the term.

Defined in

packages/core/src/data/types/entities.ts:466


yoast_head

Optional yoast_head: null | string

Overrides

Entity.yoast_head

Defined in

packages/core/src/data/types/entities.ts:479


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Overrides

Entity.yoast_head_json

Defined in

packages/core/src/data/types/entities.ts:478