Skip to main content

Interface: TermEntity

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

Interface for entities that belong to a taxonomy.

For example:

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

Extends​

Indexable​

[k: string]: unknown

Properties​

count​

count: number

Defined in: packages/core/src/data/types/entities.ts:445

Number of published posts for the term.

description​

description: string

Defined in: packages/core/src/data/types/entities.ts:450

HTML description of the term.

id​

id: number

Defined in: packages/core/src/data/types/entities.ts:440

Unique identifier for the term.

link: string

Defined in: packages/core/src/data/types/entities.ts:455

URL of the term.

meta​

meta: Record<string, unknown>

Defined in: packages/core/src/data/types/entities.ts:480

Meta fields.

name​

name: string

Defined in: packages/core/src/data/types/entities.ts:460

HTML title for the term.

parent​

parent: number

Defined in: packages/core/src/data/types/entities.ts:475

The parent term ID.

slug​

slug: string

Defined in: packages/core/src/data/types/entities.ts:465

An alphanumeric identifier for the term unique to its type.

taxonomy​

taxonomy: string

Defined in: packages/core/src/data/types/entities.ts:470

Type attribution for the term.

yoast_head?​

optional yoast_head: null | string

Defined in: packages/core/src/data/types/entities.ts:17

Inherited from​

Entity.yoast_head

yoast_head_json?​

optional yoast_head_json: null | YoastJSON

Defined in: packages/core/src/data/types/entities.ts:16

Inherited from​

Entity.yoast_head_json