Skip to main content

Interface: PageEntity

@headstartwp/core.PageEntity

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

Hierarchy

Properties

_embedded

_embedded: Object

Type declaration

NameType
authorAuthorEntity[]
wp:termTermEntity[][]

Inherited from

PostTypeEntity._embedded

Defined in

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


author

Optional author: AuthorEntity[]

Inherited from

PostTypeEntity.author

Defined in

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


comment_status

Optional comment_status: "open" | "closed"

Whether or not comments are open on the object.

Inherited from

PostTypeEntity.comment_status

Defined in

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


content

content: Rendered

The content for the object.

Defined in

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


date

date: string

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

Inherited from

PostTypeEntity.date

Defined in

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


date_gmt

date_gmt: string

The date the object was published, as GMT.

Inherited from

PostTypeEntity.date_gmt

Defined in

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


excerpt

excerpt: Rendered

The excerpt for the object.

Defined in

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


featured_media: number

The ID of the featured media for the object.

Defined in

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


guid

guid: Rendered

The globally unique identifier for the object.

Inherited from

PostTypeEntity.guid

Defined in

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


id

id: number

Unique identifier for the object.

Inherited from

PostTypeEntity.id

Defined in

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


link: string

URL to the object.

Inherited from

PostTypeEntity.link

Defined in

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


menu_order: number

The order of the object in relation to other object of its type.

Defined in

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


meta

meta: Record<string, unknown>

Meta fields.

Defined in

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


modified

modified: string

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

Inherited from

PostTypeEntity.modified

Defined in

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


modified_gmt

modified_gmt: string

The date the object was last modified, as GMT.

Inherited from

PostTypeEntity.modified_gmt

Defined in

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


parent

parent: number

The ID for the parent of the object.

Defined in

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


ping_status

ping_status: "open" | "closed"

Whether or not the object can be pinged.

Inherited from

PostTypeEntity.ping_status

Defined in

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


slug

slug: string

An alphanumeric identifier for the object unique to its type.

Inherited from

PostTypeEntity.slug

Defined in

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


status

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

A named status for the object.

Inherited from

PostTypeEntity.status

Defined in

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


template

template: string

The theme file to use to display the object.

Defined in

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


terms

Optional terms: Record<string, TermEntity[]>

Inherited from

PostTypeEntity.terms

Defined in

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


title

title: Rendered

The title for the object.

Inherited from

PostTypeEntity.title

Defined in

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


type

type: string

Type of Post for the object.

Inherited from

PostTypeEntity.type

Defined in

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


yoast_head

Optional yoast_head: null | string

Inherited from

PostTypeEntity.yoast_head

Defined in

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


yoast_head_json

Optional yoast_head_json: null | Record<string, any>

Inherited from

PostTypeEntity.yoast_head_json

Defined in

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