Interface: PostEntity
@headstartwp/core.PostEntity
Interface for entities from the /wp/v2/posts endpoint.
Hierarchy
↳
PostEntity
Properties
_embedded
• _embedded: Object
Type declaration
| Name | Type |
|---|---|
author | AuthorEntity[] |
wp:term | TermEntity[][] |
Inherited from
Defined in
packages/core/src/data/types/entities.ts:98
author
• Optional author: AuthorEntity[]
Inherited from
Defined in
packages/core/src/data/types/entities.ts:94
categories
• Optional categories: number[]
The terms assigned to the object in the category taxonomy.
Defined in
packages/core/src/data/types/entities.ts:164
comment_status
• Optional comment_status: "open" | "closed"
Whether or not comments are open on the object.
Inherited from
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:124
date
• date: string
The date the object was published, in the site's timezone.
Inherited from
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
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:129
featured_media
• featured_media: number
The ID of the featured media for the object.
Defined in
packages/core/src/data/types/entities.ts:174
format
• format: "link" | "status" | "standard" | "aside" | "chat" | "gallery" | "image" | "quote" | "video" | "audio"
The format for the object.
Defined in
packages/core/src/data/types/entities.ts:134
guid
• guid: Rendered
The globally unique identifier for the object.
Inherited from
Defined in
packages/core/src/data/types/entities.ts:52
id
• id: number
Unique identifier for the object.
Inherited from
Defined in
packages/core/src/data/types/entities.ts:67
link
• link: string
URL to the object.
Inherited from
Defined in
packages/core/src/data/types/entities.ts:72
meta
• meta: Record<string, unknown>
Meta fields.
Defined in
packages/core/src/data/types/entities.ts:149
modified
• modified: string
The date the object was last modified, in the site's timezone.
Inherited from
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
Defined in
packages/core/src/data/types/entities.ts:62
ping_status
• ping_status: "open" | "closed"
Whether or not the object can be pinged.
Inherited from
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
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
Defined in
packages/core/src/data/types/entities.ts:82
sticky
• sticky: boolean
Whether or not the object should be treated as sticky.
Defined in
packages/core/src/data/types/entities.ts:154
tags
• Optional tags: number[]
The terms assigned to the object in the post_tag taxonomy.
Defined in
packages/core/src/data/types/entities.ts:169
template
• template: string
The theme file to use to display the object.
Defined in
packages/core/src/data/types/entities.ts:159
terms
• Optional terms: Record<string, TermEntity[]>
Inherited from
Defined in
packages/core/src/data/types/entities.ts:96
title
• title: Rendered
The title for the object.
Inherited from
Defined in
packages/core/src/data/types/entities.ts:92
type
• type: string
Type of Post for the object.
Inherited from
Defined in
packages/core/src/data/types/entities.ts:87
yoast_head
• Optional yoast_head: null | string
Inherited from
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