Skip to main content

Interface: PostEntity

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

Interface for entities from the /wp/v2/posts endpoint.

Extends

Indexable

[k: string]: unknown

Properties

_embedded

_embedded: object

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

author

author: AuthorEntity[]

wp:term

wp:term: TermEntity[][]

Inherited from

PostTypeEntity._embedded


author?

optional author: AuthorEntity[]

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

Inherited from

PostTypeEntity.author


categories?

optional categories: number[]

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

The terms assigned to the object in the category taxonomy.


comment_status?

optional comment_status: "open" | "closed"

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

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status


content

content: RenderedWithBlockStyles

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

The content for the object.


date

date: string

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

The date the object was published, in the site's timezone.

Inherited from

PostTypeEntity.date


date_gmt

date_gmt: string

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

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt


excerpt

excerpt: Rendered

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

The excerpt for the object.


featured_media: number

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

The ID of the featured media for the object.


format

format: "link" | "status" | "image" | "aside" | "audio" | "video" | "standard" | "chat" | "gallery" | "quote"

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

The format for the object.


guid

guid: Rendered

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

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid


id

id: number

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

Unique identifier for the object.

Inherited from

PostTypeEntity.id


link: string

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

URL to the object.

Inherited from

PostTypeEntity.link


meta

meta: Record<string, unknown>

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

Meta fields.


modified

modified: string

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

The date the object was last modified, in the site's timezone.

Inherited from

PostTypeEntity.modified


modified_gmt

modified_gmt: string

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

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt


ping_status

ping_status: "open" | "closed"

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

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status


slug

slug: string

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

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug


status

status: "publish" | "future" | "draft" | "pending" | "private"

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

A named status for the object.

Inherited from

PostTypeEntity.status


sticky

sticky: boolean

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

Whether or not the object should be treated as sticky.


tags?

optional tags: number[]

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

The terms assigned to the object in the post_tag taxonomy.


template

template: string

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

The theme file to use to display the object.


terms?

optional terms: Record<string, TermEntity[]>

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

Inherited from

PostTypeEntity.terms


title

title: Rendered

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

The title for the object.

Inherited from

PostTypeEntity.title


type

type: string

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

Type of Post for the object.

Inherited from

PostTypeEntity.type


yoast_head?

optional yoast_head: null | string

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

Inherited from

PostTypeEntity.yoast_head


yoast_head_json?

optional yoast_head_json: null | YoastJSON

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

Inherited from

PostTypeEntity.yoast_head_json