From 5de2541b9eb1f766c273448a8933f44338032c7a Mon Sep 17 00:00:00 2001 From: Scott Cranfill Date: Thu, 24 Aug 2023 13:12:04 -0700 Subject: [PATCH 1/2] Move schema field type to right column Also clarify that it refers to JSON data types. --- bin/templates/reference-parts/schema.html | 20 +- reference/application-passwords.md | 104 +++---- reference/block-directory-items.md | 164 +++++----- reference/block-pattern-categories.md | 36 +-- reference/block-patterns.md | 145 +++++---- reference/block-revisions.md | 156 +++++----- reference/block-types.md | 346 ++++++++++----------- reference/blocks.md | 213 +++++++------ reference/categories.md | 112 +++---- reference/comments.md | 228 +++++++------- reference/media.md | 348 +++++++++++----------- reference/menu-locations.md | 36 +-- reference/nav_menu_item-revisions.md | 152 +++++----- reference/nav_menu_items.md | 220 +++++++------- reference/nav_menus.md | 84 +++--- reference/navigation-fallbacks.md | 45 +++ reference/page-revisions.md | 160 +++++----- reference/pages.md | 308 +++++++++---------- reference/pattern-directory-items.md | 96 +++--- reference/plugins.md | 152 +++++----- reference/post-revisions.md | 160 +++++----- reference/post-statuses.md | 96 +++--- reference/post-types.md | 168 +++++------ reference/posts.md | 332 ++++++++++----------- reference/rendered-blocks.md | 12 +- reference/search-results.md | 64 ++-- reference/settings.md | 248 +++++++-------- reference/sidebars.md | 120 ++++---- reference/tags.md | 100 +++---- reference/taxonomies.md | 132 ++++---- reference/themes.md | 194 ++++++------ reference/users.md | 252 ++++++++-------- reference/widget-types.md | 60 ++-- reference/widgets.md | 84 +++--- reference/wp-site-health-tests.md | 72 ++--- reference/wp_global_styles-revisions.md | 190 ++++++++++++ reference/wp_global_styles.md | 48 +-- reference/wp_navigation-revisions.md | 150 +++++----- reference/wp_navigations.md | 192 ++++++------ reference/wp_template-revisions.md | 148 ++++----- reference/wp_template_part-revisions.md | 148 ++++----- reference/wp_template_parts.md | 182 +++++------ reference/wp_templates.md | 182 +++++------ 43 files changed, 3397 insertions(+), 3062 deletions(-) create mode 100644 reference/navigation-fallbacks.md create mode 100644 reference/wp_global_styles-revisions.md diff --git a/bin/templates/reference-parts/schema.html b/bin/templates/reference-parts/schema.html index 32e8586..41263b0 100644 --- a/bin/templates/reference-parts/schema.html +++ b/bin/templates/reference-parts/schema.html @@ -4,20 +4,20 @@

Schema

{% for key, property in schema.properties %} - {{ key }}
- - {{ property.type | join(' or ') }}{% if property.format %}, + {{ key }} + + +

{{ property.description }}

+

+ JSON data type: {{ property.type | join(' or ') }}{% if property.format %}, {% if property.format == 'date-time' %} - datetime (details) + Format: datetime (details) {% elseif property.format == 'uri' %} - uri + Format: uri {% else %} - {{ property.format }} + Format: {{ property.format }} {% endif %}{% endif %} - - - -

{{ property.description }}

+

{% if property.readonly %}

Read only

{% endif %} diff --git a/reference/application-passwords.md b/reference/application-passwords.md index 98939d5..a075601 100644 --- a/reference/application-passwords.md +++ b/reference/application-passwords.md @@ -10,92 +10,92 @@ - + - + - + - + - + - + - + diff --git a/reference/block-directory-items.md b/reference/block-directory-items.md index 7995d6f..59fc802 100644 --- a/reference/block-directory-items.md +++ b/reference/block-directory-items.md @@ -10,148 +10,148 @@
- uuid
- - string, - uuid - - 		-

The unique identifier for the application password.

+ uuid + 		+

The unique identifier for the application password.

+

+ JSON data type: string, + Format: uuid +

Read only

Context: view, edit, embed
- app_id
- - string, - uuid - - 		-

A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.

+ app_id + 		+

A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.

+

+ JSON data type: string, + Format: uuid +

Context: view, edit, embed
- name
- - string - 		-

The name of the application password.

+ name + 		+

The name of the application password.

+

+ JSON data type: string

Context: view, edit, embed
- password
- - string - 		-

The generated password. Only available after adding an application.

+ password + 		+

The generated password. Only available after adding an application.

+

+ JSON data type: string

Read only

Context: edit
- created
- - string, - datetime (details) - - 		-

The GMT date the application password was created.

+ created + 		+

The GMT date the application password was created.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- last_used
- - string or null, - datetime (details) - - 		-

The GMT date the application password was last used.

+ last_used + 		+

The GMT date the application password was last used.

+

+ JSON data type: string or null, + Format: datetime (details) +

Read only

Context: view, edit
- last_ip
- - string or null, - ip - - 		-

The IP address the application password was last used by.

+ last_ip + 		+

The IP address the application password was last used by.

+

+ JSON data type: string or null, + Format: ip +

Read only

Context: view, edit

- + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/block-pattern-categories.md b/reference/block-pattern-categories.md index c83a0e1..f139793 100644 --- a/reference/block-pattern-categories.md +++ b/reference/block-pattern-categories.md @@ -10,36 +10,36 @@
- name
- - string - 		-

The block name, in namespace/block-name format.

+ name + 		+

The block name, in namespace/block-name format.

+

+ JSON data type: string

Context: view
- title
- - string - 		-

The block title, in human readable format.

+ title + 		+

The block title, in human readable format.

+

+ JSON data type: string

Context: view
- description
- - string - 		-

A short description of the block, in human readable format.

+ description + 		+

A short description of the block, in human readable format.

+

+ JSON data type: string

Context: view
- id
- - string - 		-

The block slug.

+ id + 		+

The block slug.

+

+ JSON data type: string

Context: view
- rating
- - number - 		-

The star rating of the block.

+ rating + 		+

The star rating of the block.

+

+ JSON data type: number

Context: view
- rating_count
- - integer - 		-

The number of ratings.

+ rating_count + 		+

The number of ratings.

+

+ JSON data type: integer

Context: view
- active_installs
- - integer - 		-

The number sites that have activated this block.

+ active_installs + 		+

The number sites that have activated this block.

+

+ JSON data type: integer

Context: view
- author_block_rating
- - number - 		-

The average rating of blocks published by the same author.

+ author_block_rating + 		+

The average rating of blocks published by the same author.

+

+ JSON data type: number

Context: view
- author_block_count
- - integer - 		-

The number of blocks published by the same author.

+ author_block_count + 		+

The number of blocks published by the same author.

+

+ JSON data type: integer

Context: view
- author
- - string - 		-

The WordPress.org username of the block author.

+ author + 		+

The WordPress.org username of the block author.

+

+ JSON data type: string

Context: view
- icon
- - string, - uri - - 		-

The block icon.

+ icon + 		+

The block icon.

+

+ JSON data type: string, + Format: uri +

Context: view
- last_updated
- - string, - datetime (details) - - 		-

The date when the block was last updated.

+ last_updated + 		+

The date when the block was last updated.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view
- humanized_updated
- - string - 		-

The date when the block was last updated, in fuzzy human readable format.

+ humanized_updated + 		+

The date when the block was last updated, in fuzzy human readable format.

+

+ JSON data type: string

Context: view
- + - + - + diff --git a/reference/block-patterns.md b/reference/block-patterns.md index 506a84a..39af9f7 100644 --- a/reference/block-patterns.md +++ b/reference/block-patterns.md @@ -10,134 +10,147 @@
- name
- - string - 		-

The category name.

+ name + 		+

The category name.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- label
- - string - 		-

The category label, in human readable format.

+ label + 		+

The category label, in human readable format.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- description
- - string - 		-

The category description, in human readable format.

+ description + 		+

The category description, in human readable format.

+

+ JSON data type: string

Read only

Context: view, edit, embed

- + - + - + - + - + - + - + - + - + - + - + + + + +
- name
- - string - 		-

The pattern name.

+ name + 		+

The pattern name.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- title
- - string - 		-

The pattern title, in human readable format.

+ title + 		+

The pattern title, in human readable format.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- content
- - string - 		-

The pattern content.

+ content + 		+

The pattern content.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- description
- - string - 		-

The pattern detailed description.

+ description + 		+

The pattern detailed description.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- viewport_width
- - number - 		-

The pattern viewport width for inserter preview.

+ viewport_width + 		+

The pattern viewport width for inserter preview.

+

+ JSON data type: number

Read only

Context: view, edit, embed
- inserter
- - boolean - 		-

Determines whether the pattern is visible in inserter.

+ inserter + 		+

Determines whether the pattern is visible in inserter.

+

+ JSON data type: boolean

Read only

Context: view, edit, embed
- categories
- - array - 		-

The pattern category slugs.

+ categories + 		+

The pattern category slugs.

+

+ JSON data type: array

Read only

Context: view, edit, embed
- keywords
- - array - 		-

The pattern keywords.

+ keywords + 		+

The pattern keywords.

+

+ JSON data type: array

Read only

Context: view, edit, embed
- block_types
- - array - 		-

Block types that the pattern is intended to be used with.

+ block_types + 		+

Block types that the pattern is intended to be used with.

+

+ JSON data type: array

Read only

Context: view, edit, embed
- post_types
- - array - 		-

An array of post types that the pattern is restricted to be used with.

+ post_types + 		+

An array of post types that the pattern is restricted to be used with.

+

+ JSON data type: array

Read only

Context: view, edit, embed
- template_types
- - array - 		-

An array of template types where the pattern fits.

+ template_types + 		+

An array of template types where the pattern fits.

+

+ JSON data type: array

+

Read only

+

Context: view, edit, embed

+
+ source + +

Where the pattern comes from e.g. core

+

+ JSON data type: string

Read only

Context: view, edit, embed

+

One of: core, plugin, theme, pattern-directory/core, pattern-directory/theme, pattern-directory/featured
diff --git a/reference/block-revisions.md b/reference/block-revisions.md index 3402604..b9f68a8 100644 --- a/reference/block-revisions.md +++ b/reference/block-revisions.md @@ -10,131 +10,131 @@ - + - + - + - + - + - + - + - + - + - + - + @@ -455,6 +455,14 @@ + + + +
- author
- - integer - 		-

The ID for the author of the revision.

+ author + 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string, - datetime (details) - - 		-

The date the revision was published, as GMT.

+ date_gmt + 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the revision.

+ id + 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the revision was last modified, as GMT.

+ modified_gmt + 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- parent
- - integer - 		-

The ID for the parent of the revision.

+ parent + 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the revision unique to its type.

+ slug + 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object - 		-

The content for the post.

+ content + 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit

The content for the post.

+ meta
+ 		+

Meta fields.

+
diff --git a/reference/block-types.md b/reference/block-types.md index 87b297a..be2bd4b 100644 --- a/reference/block-types.md +++ b/reference/block-types.md @@ -10,336 +10,348 @@ - + - + - + - + - + - + - + + uses_context + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/blocks.md b/reference/blocks.md index 7fbb2e2..c69d24b 100644 --- a/reference/blocks.md +++ b/reference/blocks.md @@ -10,172 +10,183 @@
- api_version
- - integer - 		-

Version of block API.

+ api_version + 		+

Version of block API.

+

+ JSON data type: integer

Read only

Context: embed, view, edit
- title
- - string - 		-

Title of block type.

+ title + 		+

Title of block type.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- name
- - string - 		-

Unique name identifying the block type.

+ name + 		+

Unique name identifying the block type.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- description
- - string - 		-

Description of block type.

+ description + 		+

Description of block type.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- icon
- - string or null - 		-

Icon of block type.

+ icon + 		+

Icon of block type.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit
- attributes
- - object or null - 		-

Block attributes.

+ attributes + 		+

Block attributes.

+

+ JSON data type: object or null

Read only

Context: embed, view, edit
- provides_context
- - object - 		-

Context provided by blocks of this type.

+ provides_context + 		+

Context provided by blocks of this type.

+

+ JSON data type: object

Read only

Context: embed, view, edit
- uses_context
- - array - 		+

Context values inherited by blocks of this type.

+

+ JSON data type: array

+

Read only

+

Context: embed, view, edit

+
-

Context values inherited by blocks of this type.

+ selectors + 		+

Custom CSS selectors.

+

+ JSON data type: object

Read only

Context: embed, view, edit
- supports
- - object - 		-

Block supports.

+ supports + 		+

Block supports.

+

+ JSON data type: object

Read only

Context: embed, view, edit
- category
- - string or null - 		-

Block category.

+ category + 		+

Block category.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit
- is_dynamic
- - boolean - 		-

Is the block dynamically rendered.

+ is_dynamic + 		+

Is the block dynamically rendered.

+

+ JSON data type: boolean

Read only

Context: embed, view, edit
- editor_script_handles
- - array - 		-

Editor script handles.

+ editor_script_handles + 		+

Editor script handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- script_handles
- - array - 		-

Public facing and editor script handles.

+ script_handles + 		+

Public facing and editor script handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- view_script_handles
- - array - 		-

Public facing script handles.

+ view_script_handles + 		+

Public facing script handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- editor_style_handles
- - array - 		-

Editor style handles.

+ editor_style_handles + 		+

Editor style handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- style_handles
- - array - 		-

Public facing and editor style handles.

+ style_handles + 		+

Public facing and editor style handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- styles
- - array - 		-

Block style variations.

+ styles + 		+

Block style variations.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- variations
- - array - 		-

Block variations.

+ variations + 		+

Block variations.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- textdomain
- - string or null - 		-

Public text domain.

+ textdomain + 		+

Public text domain.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit
- parent
- - array or null - 		-

Parent blocks.

+ parent + 		+

Parent blocks.

+

+ JSON data type: array or null

Read only

Context: embed, view, edit
- ancestor
- - array or null - 		-

Ancestor blocks.

+ ancestor + 		+

Ancestor blocks.

+

+ JSON data type: array or null

Read only

Context: embed, view, edit
- keywords
- - array - 		-

Block keywords.

+ keywords + 		+

Block keywords.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- example
- - object or null - 		-

Block example.

+ example + 		+

Block example.

+

+ JSON data type: object or null

Read only

Context: embed, view, edit
- editor_script
- - string or null - 		-

Editor script handle. DEPRECATED: Use `editor_script_handles` instead.

+ editor_script + 		+

Editor script handle. DEPRECATED: Use `editor_script_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit
- script
- - string or null - 		-

Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.

+ script + 		+

Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit
- view_script
- - string or null - 		-

Public facing script handle. DEPRECATED: Use `view_script_handles` instead.

+ view_script + 		+

Public facing script handle. DEPRECATED: Use `view_script_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit
- editor_style
- - string or null - 		-

Editor style handle. DEPRECATED: Use `editor_style_handles` instead.

+ editor_style + 		+

Editor style handle. DEPRECATED: Use `editor_style_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit
- style
- - string or null - 		-

Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.

+ style + 		+

Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

- + - + - + - + - + - + - + - + - + - + - + - + + content + + + + + - + @@ -414,6 +425,14 @@ + + + + + + + +
- date
- - string or null, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string or null, - datetime (details) - - 		-

The date the post was published, as GMT.

+ date_gmt + 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the post.

+ id + 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the post was last modified, as GMT.

+ modified_gmt + 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- slug
- - string - 		-

An alphanumeric identifier for the post unique to its type.

+ slug + 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- status
- - string - 		-

A named status for the post.

+ status + 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private
- type
- - string - 		-

Type of post.

+ type + 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- password
- - string - 		-

A password to protect access to the content and excerpt.

+ password + 		+

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object - 		+

The content for the post.

+

+ JSON data type: object

+

Context: view, edit

+
-

The content for the post.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- template
- - string - 		-

The theme file to use to display the post.

+ template + 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit

The content for the post.

+ meta
+ 		+

Meta fields.

+
@@ -548,6 +567,14 @@

The content for the post.

+ meta
+ 		+

Meta fields.

+
diff --git a/reference/categories.md b/reference/categories.md index c831273..e1a294e 100644 --- a/reference/categories.md +++ b/reference/categories.md @@ -10,83 +10,83 @@ - + - + - + - + - + - + - + - + - + diff --git a/reference/comments.md b/reference/comments.md index 1dbdf6b..c6707a9 100644 --- a/reference/comments.md +++ b/reference/comments.md @@ -10,204 +10,204 @@
- id
- - integer - 		-

Unique identifier for the term.

+ id + 		+

Unique identifier for the term.

+

+ JSON data type: integer

Read only

Context: view, embed, edit
- count
- - integer - 		-

Number of published posts for the term.

+ count + 		+

Number of published posts for the term.

+

+ JSON data type: integer

Read only

Context: view, edit
- description
- - string - 		-

HTML description of the term.

+ description + 		+

HTML description of the term.

+

+ JSON data type: string

Context: view, edit
- name
- - string - 		-

HTML title for the term.

+ name + 		+

HTML title for the term.

+

+ JSON data type: string

Context: view, embed, edit
- slug
- - string - 		-

An alphanumeric identifier for the term unique to its type.

+ slug + 		+

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

Context: view, embed, edit
- taxonomy
- - string - 		-

Type attribution for the term.

+ taxonomy + 		+

Type attribution for the term.

+

+ JSON data type: string

Read only

Context: view, embed, edit

One of: category

@@ -94,23 +94,23 @@
- parent
- - integer - 		-

The parent term ID.

+ parent + 		+

The parent term ID.

+

+ JSON data type: integer

Context: view, edit
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/media.md b/reference/media.md index 13ca74b..0427bc1 100644 --- a/reference/media.md +++ b/reference/media.md @@ -10,264 +10,264 @@
- id
- - integer - 		-

Unique identifier for the comment.

+ id + 		+

Unique identifier for the comment.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- author
- - integer - 		-

The ID of the user object, if author was a user.

+ author + 		+

The ID of the user object, if author was a user.

+

+ JSON data type: integer

Context: view, edit, embed
- author_email
- - string, - email - - 		-

Email address for the comment author.

+ author_email + 		+

Email address for the comment author.

+

+ JSON data type: string, + Format: email +

Context: edit
- author_ip
- - string, - ip - - 		-

IP address for the comment author.

+ author_ip + 		+

IP address for the comment author.

+

+ JSON data type: string, + Format: ip +

Context: edit
- author_name
- - string - 		-

Display name for the comment author.

+ author_name + 		+

Display name for the comment author.

+

+ JSON data type: string

Context: view, edit, embed
- author_url
- - string, - uri - - 		-

URL for the comment author.

+ author_url + 		+

URL for the comment author.

+

+ JSON data type: string, + Format: uri +

Context: view, edit, embed
- author_user_agent
- - string - 		-

User agent for the comment author.

+ author_user_agent + 		+

User agent for the comment author.

+

+ JSON data type: string

Context: edit
- content
- - object - 		-

The content for the comment.

+ content + 		+

The content for the comment.

+

+ JSON data type: object

Context: view, edit, embed
- date
- - string, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string, - datetime (details) - - 		-

The date the comment was published, as GMT.

+ date_gmt + 		+

The date the comment was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- parent
- - integer - 		-

The ID for the parent of the comment.

+ parent + 		+

The ID for the parent of the comment.

+

+ JSON data type: integer

Context: view, edit, embed
- post
- - integer - 		-

The ID of the associated post object.

+ post + 		+

The ID of the associated post object.

+

+ JSON data type: integer

Context: view, edit
- status
- - string - 		-

State of the comment.

+ status + 		+

State of the comment.

+

+ JSON data type: string

Context: view, edit
- type
- - string - 		-

Type of the comment.

+ type + 		+

Type of the comment.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- author_avatar_urls
- - object - 		-

Avatar URLs for the comment author.

+ author_avatar_urls + 		+

Avatar URLs for the comment author.

+

+ JSON data type: object

Read only

Context: view, edit, embed
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/menu-locations.md b/reference/menu-locations.md index 9abd5af..3a76e21 100644 --- a/reference/menu-locations.md +++ b/reference/menu-locations.md @@ -10,36 +10,36 @@
- date
- - string or null, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string or null, - datetime (details) - - 		-

The date the post was published, as GMT.

+ date_gmt + 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the post.

+ id + 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the post was last modified, as GMT.

+ modified_gmt + 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- slug
- - string - 		-

An alphanumeric identifier for the post unique to its type.

+ slug + 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- status
- - string - 		-

A named status for the post.

+ status + 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private
- type
- - string - 		-

Type of post.

+ type + 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- generated_slug
- - string - 		-

Slug automatically generated from the post title.

+ generated_slug + 		+

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- author
- - integer - 		-

The ID for the author of the post.

+ author + 		+

The ID for the author of the post.

+

+ JSON data type: integer

Context: view, edit, embed
- comment_status
- - string - 		-

Whether or not comments are open on the post.

+ comment_status + 		+

Whether or not comments are open on the post.

+

+ JSON data type: string

Context: view, edit

One of: open, closed
- ping_status
- - string - 		-

Whether or not the post can be pinged.

+ ping_status + 		+

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

One of: open, closed
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- template
- - string - 		-

The theme file to use to display the post.

+ template + 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
- alt_text
- - string - 		-

Alternative text to display when attachment is not displayed.

+ alt_text + 		+

Alternative text to display when attachment is not displayed.

+

+ JSON data type: string

Context: view, edit, embed
- caption
- - object - 		-

The attachment caption.

+ caption + 		+

The attachment caption.

+

+ JSON data type: object

Context: view, edit, embed
- description
- - object - 		-

The attachment description.

+ description + 		+

The attachment description.

+

+ JSON data type: object

Context: view, edit
- media_type
- - string - 		-

Attachment type.

+ media_type + 		+

Attachment type.

+

+ JSON data type: string

Read only

Context: view, edit, embed

One of: image, file

@@ -275,61 +275,61 @@
- mime_type
- - string - 		-

The attachment MIME type.

+ mime_type + 		+

The attachment MIME type.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- media_details
- - object - 		-

Details about the media file, specific to its type.

+ media_details + 		+

Details about the media file, specific to its type.

+

+ JSON data type: object

Read only

Context: view, edit, embed
- post
- - integer - 		-

The ID for the associated post of the attachment.

+ post + 		+

The ID for the associated post of the attachment.

+

+ JSON data type: integer

Context: view, edit
- source_url
- - string, - uri - - 		-

URL to the original attachment file.

+ source_url + 		+

URL to the original attachment file.

+

+ JSON data type: string, + Format: uri +

Read only

Context: view, edit, embed
- missing_image_sizes
- - array - 		-

List of the missing image sizes of the attachment.

+ missing_image_sizes + 		+

List of the missing image sizes of the attachment.

+

+ JSON data type: array

Read only

Context: edit

- + - + - + diff --git a/reference/nav_menu_item-revisions.md b/reference/nav_menu_item-revisions.md index 0e982ec..4757ba5 100644 --- a/reference/nav_menu_item-revisions.md +++ b/reference/nav_menu_item-revisions.md @@ -10,132 +10,132 @@
- name
- - string - 		-

The name of the menu location.

+ name + 		+

The name of the menu location.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- description
- - string - 		-

The description of the menu location.

+ description + 		+

The description of the menu location.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- menu
- - integer - 		-

The ID of the assigned menu.

+ menu + 		+

The ID of the assigned menu.

+

+ JSON data type: integer

Read only

Context: embed, view, edit

- + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/nav_menu_items.md b/reference/nav_menu_items.md index c180bfa..bab65d2 100644 --- a/reference/nav_menu_items.md +++ b/reference/nav_menu_items.md @@ -10,207 +10,207 @@
- author
- - integer - 		-

The ID for the author of the revision.

+ author + 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string, - datetime (details) - - 		-

The date the revision was published, as GMT.

+ date_gmt + 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- guid
- - string - 		-

GUID for the revision, as it exists in the database.

+ guid + 		+

GUID for the revision, as it exists in the database.

+

+ JSON data type: string

Context: view, edit
- id
- - integer - 		-

Unique identifier for the revision.

+ id + 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the revision was last modified, as GMT.

+ modified_gmt + 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- parent
- - integer - 		-

The ID for the parent of the revision.

+ parent + 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the revision unique to its type.

+ slug + 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- title
- - string or object - 		-

The title for the object.

+ title + 		+

The title for the object.

+

+ JSON data type: string or object

Context: view, edit, embed
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/nav_menus.md b/reference/nav_menus.md index 2d56edb..359f748 100644 --- a/reference/nav_menus.md +++ b/reference/nav_menus.md @@ -10,79 +10,79 @@
- title
- - string or object - 		-

The title for the object.

+ title + 		+

The title for the object.

+

+ JSON data type: string or object

Context: view, edit, embed
- id
- - integer - 		-

Unique identifier for the object.

+ id + 		+

Unique identifier for the object.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- type_label
- - string - 		-

The singular label used to describe this type of menu item.

+ type_label + 		+

The singular label used to describe this type of menu item.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- type
- - string - 		-

The family of objects originally represented, such as "post_type" or "taxonomy".

+ type + 		+

The family of objects originally represented, such as "post_type" or "taxonomy".

+

+ JSON data type: string

Context: view, edit, embed

One of: taxonomy, post_type, post_type_archive, custom
- status
- - string - 		-

A named status for the object.

+ status + 		+

A named status for the object.

+

+ JSON data type: string

Context: view, edit, embed

One of: publish, future, draft, pending, private
- parent
- - integer - 		-

The ID for the parent of the object.

+ parent + 		+

The ID for the parent of the object.

+

+ JSON data type: integer

Context: view, edit, embed
- attr_title
- - string - 		-

Text for the title attribute of the link element for this menu item.

+ attr_title + 		+

Text for the title attribute of the link element for this menu item.

+

+ JSON data type: string

Context: view, edit, embed
- classes
- - array - 		-

Class names for the link element of this menu item.

+ classes + 		+

Class names for the link element of this menu item.

+

+ JSON data type: array

Context: view, edit, embed
- description
- - string - 		-

The description of this menu item.

+ description + 		+

The description of this menu item.

+

+ JSON data type: string

Context: view, edit, embed
- menu_order
- - integer - 		-

The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.

+ menu_order + 		+

The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.

+

+ JSON data type: integer

Context: view, edit, embed
- object
- - string - 		-

The type of object originally represented, such as "category", "post", or "attachment".

+ object + 		+

The type of object originally represented, such as "category", "post", or "attachment".

+

+ JSON data type: string

Context: view, edit, embed
- object_id
- - integer - 		-

The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.

+ object_id + 		+

The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.

+

+ JSON data type: integer

Context: view, edit, embed
- target
- - string - 		-

The target attribute of the link element for this menu item.

+ target + 		+

The target attribute of the link element for this menu item.

+

+ JSON data type: string

Context: view, edit, embed

One of: _blank,

- url
- - string, - uri - - 		-

The URL to which this menu item points.

+ url + 		+

The URL to which this menu item points.

+

+ JSON data type: string, + Format: uri +

Context: view, edit, embed
- xfn
- - array - 		-

The XFN relationship expressed in the link of this menu item.

+ xfn + 		+

The XFN relationship expressed in the link of this menu item.

+

+ JSON data type: array

Context: view, edit, embed
- invalid
- - boolean - 		-

Whether the menu item represents an object that no longer exists.

+ invalid + 		+

Whether the menu item represents an object that no longer exists.

+

+ JSON data type: boolean

Read only

Context: view, edit, embed
- menus
- - integer - 		-

The terms assigned to the object in the nav_menu taxonomy.

+ menus + 		+

The terms assigned to the object in the nav_menu taxonomy.

+

+ JSON data type: integer

Context: view, edit
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- + - + - + - + - + - + - + diff --git a/reference/navigation-fallbacks.md b/reference/navigation-fallbacks.md new file mode 100644 index 0000000..a7d9087 --- /dev/null +++ b/reference/navigation-fallbacks.md @@ -0,0 +1,45 @@ +--- +--- + +# Navigation Fallbacks + +
+
+

Schema

+

The schema defines all the fields that exist within a navigation fallback record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

+
- id
- - integer - 		-

Unique identifier for the term.

+ id + 		+

Unique identifier for the term.

+

+ JSON data type: integer

Read only

Context: view, embed, edit
- description
- - string - 		-

HTML description of the term.

+ description + 		+

HTML description of the term.

+

+ JSON data type: string

Context: view, edit
- name
- - string - 		-

HTML title for the term.

+ name + 		+

HTML title for the term.

+

+ JSON data type: string

Context: view, embed, edit
- slug
- - string - 		-

An alphanumeric identifier for the term unique to its type.

+ slug + 		+

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

Context: view, embed, edit
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- locations
- - array - 		-

The locations assigned to the menu.

+ locations + 		+

The locations assigned to the menu.

+

+ JSON data type: array

Context: view, edit
- auto_add
- - boolean - 		-

Whether to automatically add top level pages to this menu.

+ auto_add + 		+

Whether to automatically add top level pages to this menu.

+

+ JSON data type: boolean

Context: view, edit
+ + + + +
+ id + +

The unique identifier for the Navigation Menu.

+

+ JSON data type: integer

+

Read only

+

Context: view, edit, embed

+
+ + + + +
+
+

Retrieve a Navigation Fallback

+ +

Definition & Example Request

+ + GET /wp-block-editor/v1/navigation-fallback + +

Query this endpoint to retrieve a specific navigation fallback record.

+ + $ curl https://example.com/wp-json/wp-block-editor/v1/navigation-fallback +
+
+

There are no arguments for this endpoint.

+ +
+
+
diff --git a/reference/page-revisions.md b/reference/page-revisions.md index 651bc48..e274bef 100644 --- a/reference/page-revisions.md +++ b/reference/page-revisions.md @@ -10,142 +10,142 @@ - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/pages.md b/reference/pages.md index f197431..0121e77 100644 --- a/reference/pages.md +++ b/reference/pages.md @@ -10,286 +10,286 @@
- author
- - integer - 		-

The ID for the author of the revision.

+ author + 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string, - datetime (details) - - 		-

The date the revision was published, as GMT.

+ date_gmt + 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the revision.

+ id + 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the revision was last modified, as GMT.

+ modified_gmt + 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- parent
- - integer - 		-

The ID for the parent of the revision.

+ parent + 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the revision unique to its type.

+ slug + 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object - 		-

The content for the post.

+ content + 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
- excerpt
- - object - 		-

The excerpt for the post.

+ excerpt + 		+

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/pattern-directory-items.md b/reference/pattern-directory-items.md index bb383b2..5746085 100644 --- a/reference/pattern-directory-items.md +++ b/reference/pattern-directory-items.md @@ -10,89 +10,89 @@
- date
- - string or null, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string or null, - datetime (details) - - 		-

The date the post was published, as GMT.

+ date_gmt + 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the post.

+ id + 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the post was last modified, as GMT.

+ modified_gmt + 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- slug
- - string - 		-

An alphanumeric identifier for the post unique to its type.

+ slug + 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- status
- - string - 		-

A named status for the post.

+ status + 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private
- type
- - string - 		-

Type of post.

+ type + 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- password
- - string - 		-

A password to protect access to the content and excerpt.

+ password + 		+

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
- generated_slug
- - string - 		-

Slug automatically generated from the post title.

+ generated_slug + 		+

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit
- parent
- - integer - 		-

The ID for the parent of the post.

+ parent + 		+

The ID for the parent of the post.

+

+ JSON data type: integer

Context: view, edit
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object - 		-

The content for the post.

+ content + 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
- author
- - integer - 		-

The ID for the author of the post.

+ author + 		+

The ID for the author of the post.

+

+ JSON data type: integer

Context: view, edit, embed
- excerpt
- - object - 		-

The excerpt for the post.

+ excerpt + 		+

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
- comment_status
- - string - 		-

Whether or not comments are open on the post.

+ comment_status + 		+

Whether or not comments are open on the post.

+

+ JSON data type: string

Context: view, edit

One of: open, closed
- ping_status
- - string - 		-

Whether or not the post can be pinged.

+ ping_status + 		+

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

One of: open, closed
- menu_order
- - integer - 		-

The order of the post in relation to other posts.

+ menu_order + 		+

The order of the post in relation to other posts.

+

+ JSON data type: integer

Context: view, edit
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- template
- - string - 		-

The theme file to use to display the post.

+ template + 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
- + - + - + - + - + - + - + - + diff --git a/reference/plugins.md b/reference/plugins.md index 1650640..40b45ff 100644 --- a/reference/plugins.md +++ b/reference/plugins.md @@ -10,148 +10,148 @@
- id
- - integer - 		-

The pattern ID.

+ id + 		+

The pattern ID.

+

+ JSON data type: integer

Context: view, edit, embed
- title
- - string - 		-

The pattern title, in human readable format.

+ title + 		+

The pattern title, in human readable format.

+

+ JSON data type: string

Context: view, edit, embed
- content
- - string - 		-

The pattern content.

+ content + 		+

The pattern content.

+

+ JSON data type: string

Context: view, edit, embed
- categories
- - array - 		-

The pattern's category slugs.

+ categories + 		+

The pattern's category slugs.

+

+ JSON data type: array

Context: view, edit, embed
- keywords
- - array - 		-

The pattern's keywords.

+ keywords + 		+

The pattern's keywords.

+

+ JSON data type: array

Context: view, edit, embed
- description
- - string - 		-

A description of the pattern.

+ description + 		+

A description of the pattern.

+

+ JSON data type: string

Context: view, edit, embed
- viewport_width
- - integer - 		-

The preferred width of the viewport when previewing a pattern, in pixels.

+ viewport_width + 		+

The preferred width of the viewport when previewing a pattern, in pixels.

+

+ JSON data type: integer

Context: view, edit, embed
- block_types
- - array - 		-

The block types which can use this pattern.

+ block_types + 		+

The block types which can use this pattern.

+

+ JSON data type: array

Context: view, embed
- + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/post-revisions.md b/reference/post-revisions.md index 6eba444..ee629e1 100644 --- a/reference/post-revisions.md +++ b/reference/post-revisions.md @@ -10,142 +10,142 @@
- plugin
- - string - 		-

The plugin file.

+ plugin + 		+

The plugin file.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- status
- - string - 		-

The plugin activation status.

+ status + 		+

The plugin activation status.

+

+ JSON data type: string

Context: view, edit, embed

One of: inactive, active
- name
- - string - 		-

The plugin name.

+ name + 		+

The plugin name.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- plugin_uri
- - string, - uri - - 		-

The plugin's website address.

+ plugin_uri + 		+

The plugin's website address.

+

+ JSON data type: string, + Format: uri +

Read only

Context: view, edit
- author
- - object - 		-

The plugin author.

+ author + 		+

The plugin author.

+

+ JSON data type: object

Read only

Context: view, edit
- author_uri
- - string, - uri - - 		-

Plugin author's website address.

+ author_uri + 		+

Plugin author's website address.

+

+ JSON data type: string, + Format: uri +

Read only

Context: view, edit
- description
- - object - 		-

The plugin description.

+ description + 		+

The plugin description.

+

+ JSON data type: object

Read only

Context: view, edit
- version
- - string - 		-

The plugin version number.

+ version + 		+

The plugin version number.

+

+ JSON data type: string

Read only

Context: view, edit
- network_only
- - boolean - 		-

Whether the plugin can only be activated network-wide.

+ network_only + 		+

Whether the plugin can only be activated network-wide.

+

+ JSON data type: boolean

Read only

Context: view, edit, embed
- requires_wp
- - string - 		-

Minimum required version of WordPress.

+ requires_wp + 		+

Minimum required version of WordPress.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- requires_php
- - string - 		-

Minimum required version of PHP.

+ requires_php + 		+

Minimum required version of PHP.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- textdomain
- - string - 		-

The plugin's text domain.

+ textdomain + 		+

The plugin's text domain.

+

+ JSON data type: string

Read only

Context: view, edit

- + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/post-statuses.md b/reference/post-statuses.md index 4761f49..e4442d9 100644 --- a/reference/post-statuses.md +++ b/reference/post-statuses.md @@ -10,96 +10,96 @@
- author
- - integer - 		-

The ID for the author of the revision.

+ author + 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string, - datetime (details) - - 		-

The date the revision was published, as GMT.

+ date_gmt + 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the revision.

+ id + 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the revision was last modified, as GMT.

+ modified_gmt + 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- parent
- - integer - 		-

The ID for the parent of the revision.

+ parent + 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the revision unique to its type.

+ slug + 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object - 		-

The content for the post.

+ content + 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
- excerpt
- - object - 		-

The excerpt for the post.

+ excerpt + 		+

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
- + - + - + - + - + - + - + - + diff --git a/reference/post-types.md b/reference/post-types.md index 58af21f..05c6ad2 100644 --- a/reference/post-types.md +++ b/reference/post-types.md @@ -10,168 +10,168 @@
- name
- - string - 		-

The title for the status.

+ name + 		+

The title for the status.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- private
- - boolean - 		-

Whether posts with this status should be private.

+ private + 		+

Whether posts with this status should be private.

+

+ JSON data type: boolean

Read only

Context: edit
- protected
- - boolean - 		-

Whether posts with this status should be protected.

+ protected + 		+

Whether posts with this status should be protected.

+

+ JSON data type: boolean

Read only

Context: edit
- public
- - boolean - 		-

Whether posts of this status should be shown in the front end of the site.

+ public + 		+

Whether posts of this status should be shown in the front end of the site.

+

+ JSON data type: boolean

Read only

Context: view, edit
- queryable
- - boolean - 		-

Whether posts with this status should be publicly-queryable.

+ queryable + 		+

Whether posts with this status should be publicly-queryable.

+

+ JSON data type: boolean

Read only

Context: view, edit
- show_in_list
- - boolean - 		-

Whether to include posts in the edit listing for their post type.

+ show_in_list + 		+

Whether to include posts in the edit listing for their post type.

+

+ JSON data type: boolean

Read only

Context: edit
- slug
- - string - 		-

An alphanumeric identifier for the status.

+ slug + 		+

An alphanumeric identifier for the status.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- date_floating
- - boolean - 		-

Whether posts of this status may have floating published dates.

+ date_floating + 		+

Whether posts of this status may have floating published dates.

+

+ JSON data type: boolean

Read only

Context: view, edit

- + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/posts.md b/reference/posts.md index 7596962..823b2da 100644 --- a/reference/posts.md +++ b/reference/posts.md @@ -10,309 +10,309 @@
- capabilities
- - object - 		-

All capabilities used by the post type.

+ capabilities + 		+

All capabilities used by the post type.

+

+ JSON data type: object

Read only

Context: edit
- description
- - string - 		-

A human-readable description of the post type.

+ description + 		+

A human-readable description of the post type.

+

+ JSON data type: string

Read only

Context: view, edit
- hierarchical
- - boolean - 		-

Whether or not the post type should have children.

+ hierarchical + 		+

Whether or not the post type should have children.

+

+ JSON data type: boolean

Read only

Context: view, edit
- viewable
- - boolean - 		-

Whether or not the post type can be viewed.

+ viewable + 		+

Whether or not the post type can be viewed.

+

+ JSON data type: boolean

Read only

Context: edit
- labels
- - object - 		-

Human-readable labels for the post type for various contexts.

+ labels + 		+

Human-readable labels for the post type for various contexts.

+

+ JSON data type: object

Read only

Context: edit
- name
- - string - 		-

The title for the post type.

+ name + 		+

The title for the post type.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the post type.

+ slug + 		+

An alphanumeric identifier for the post type.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- supports
- - object - 		-

All features, supported by the post type.

+ supports + 		+

All features, supported by the post type.

+

+ JSON data type: object

Read only

Context: edit
- has_archive
- - string or boolean - 		-

If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.

+ has_archive + 		+

If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.

+

+ JSON data type: string or boolean

Read only

Context: view, edit
- taxonomies
- - array - 		-

Taxonomies associated with post type.

+ taxonomies + 		+

Taxonomies associated with post type.

+

+ JSON data type: array

Read only

Context: view, edit
- rest_base
- - string - 		-

REST base route for the post type.

+ rest_base + 		+

REST base route for the post type.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- rest_namespace
- - string - 		-

REST route's namespace for the post type.

+ rest_namespace + 		+

REST route's namespace for the post type.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- visibility
- - object - 		-

The visibility settings for the post type.

+ visibility + 		+

The visibility settings for the post type.

+

+ JSON data type: object

Read only

Context: edit
- icon
- - string or null - 		-

The icon for the post type.

+ icon + 		+

The icon for the post type.

+

+ JSON data type: string or null

Read only

Context: view, edit, embed

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/rendered-blocks.md b/reference/rendered-blocks.md index 1586e6e..227b094 100644 --- a/reference/rendered-blocks.md +++ b/reference/rendered-blocks.md @@ -10,12 +10,12 @@
- date
- - string or null, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string or null, - datetime (details) - - 		-

The date the post was published, as GMT.

+ date_gmt + 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the post.

+ id + 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the post was last modified, as GMT.

+ modified_gmt + 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- slug
- - string - 		-

An alphanumeric identifier for the post unique to its type.

+ slug + 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- status
- - string - 		-

A named status for the post.

+ status + 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private
- type
- - string - 		-

Type of post.

+ type + 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- password
- - string - 		-

A password to protect access to the content and excerpt.

+ password + 		+

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
- generated_slug
- - string - 		-

Slug automatically generated from the post title.

+ generated_slug + 		+

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object - 		-

The content for the post.

+ content + 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
- author
- - integer - 		-

The ID for the author of the post.

+ author + 		+

The ID for the author of the post.

+

+ JSON data type: integer

Context: view, edit, embed
- excerpt
- - object - 		-

The excerpt for the post.

+ excerpt + 		+

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
- comment_status
- - string - 		-

Whether or not comments are open on the post.

+ comment_status + 		+

Whether or not comments are open on the post.

+

+ JSON data type: string

Context: view, edit

One of: open, closed
- ping_status
- - string - 		-

Whether or not the post can be pinged.

+ ping_status + 		+

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

One of: open, closed
- format
- - string - 		-

The format for the post.

+ format + 		+

The format for the post.

+

+ JSON data type: string

Context: view, edit

One of: standard, aside, chat, gallery, link, image, quote, status, video, audio
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- sticky
- - boolean - 		-

Whether or not the post should be treated as sticky.

+ sticky + 		+

Whether or not the post should be treated as sticky.

+

+ JSON data type: boolean

Context: view, edit
- template
- - string - 		-

The theme file to use to display the post.

+ template + 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
- categories
- - array - 		-

The terms assigned to the post in the category taxonomy.

+ categories + 		+

The terms assigned to the post in the category taxonomy.

+

+ JSON data type: array

Context: view, edit
- tags
- - array - 		-

The terms assigned to the post in the post_tag taxonomy.

+ tags + 		+

The terms assigned to the post in the post_tag taxonomy.

+

+ JSON data type: array

Context: view, edit
- + diff --git a/reference/search-results.md b/reference/search-results.md index 5326aef..31969c7 100644 --- a/reference/search-results.md +++ b/reference/search-results.md @@ -10,50 +10,50 @@
- rendered
- - string - 		-

The rendered block.

+ rendered + 		+

The rendered block.

+

+ JSON data type: string

Context: edit
- + - + - + - + - +
- id
- - integer or string - 		-

Unique identifier for the object.

+ id + 		+

Unique identifier for the object.

+

+ JSON data type: integer or string

Read only

Context: view, embed
- title
- - string - 		-

The title for the object.

+ title + 		+

The title for the object.

+

+ JSON data type: string

Read only

Context: view, embed
- url
- - string, - uri - - 		-

URL to the object.

+ url + 		+

URL to the object.

+

+ JSON data type: string, + Format: uri +

Read only

Context: view, embed
- type
- - string - 		-

Object type.

+ type + 		+

Object type.

+

+ JSON data type: string

Read only

Context: view, embed

One of: post, term, post-format

@@ -61,12 +61,12 @@
- subtype
- - string - 		-

Object subtype.

+ subtype + 		+

Object subtype.

+

+ JSON data type: string

Read only

Context: view, embed

One of: post, page, category, post_tag

diff --git a/reference/settings.md b/reference/settings.md index 4d3c9df..8420eb3 100644 --- a/reference/settings.md +++ b/reference/settings.md @@ -10,227 +10,227 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/sidebars.md b/reference/sidebars.md index b7253ac..3463f1a 100644 --- a/reference/sidebars.md +++ b/reference/sidebars.md @@ -10,108 +10,108 @@
- title
- - string - 		-

Site title.

+ title + 		+

Site title.

+

+ JSON data type: string

Context:

- description
- - string - 		-

Site tagline.

+ description + 		+

Site tagline.

+

+ JSON data type: string

Context:

- url
- - string, - uri - - 		-

Site URL.

+ url + 		+

Site URL.

+

+ JSON data type: string, + Format: uri +

Context:

- email
- - string, - email - - 		-

This address is used for admin purposes, like new user notification.

+ email + 		+

This address is used for admin purposes, like new user notification.

+

+ JSON data type: string, + Format: email +

Context:

- timezone
- - string - 		-

A city in the same timezone as you.

+ timezone + 		+

A city in the same timezone as you.

+

+ JSON data type: string

Context:

- date_format
- - string - 		-

A date format for all date strings.

+ date_format + 		+

A date format for all date strings.

+

+ JSON data type: string

Context:

- time_format
- - string - 		-

A time format for all time strings.

+ time_format + 		+

A time format for all time strings.

+

+ JSON data type: string

Context:

- start_of_week
- - integer - 		-

A day number of the week that the week should start on.

+ start_of_week + 		+

A day number of the week that the week should start on.

+

+ JSON data type: integer

Context:

- language
- - string - 		-

WordPress locale code.

+ language + 		+

WordPress locale code.

+

+ JSON data type: string

Context:

- use_smilies
- - boolean - 		-

Convert emoticons like :-) and :-P to graphics on display.

+ use_smilies + 		+

Convert emoticons like :-) and :-P to graphics on display.

+

+ JSON data type: boolean

Context:

- default_category
- - integer - 		-

Default post category.

+ default_category + 		+

Default post category.

+

+ JSON data type: integer

Context:

- default_post_format
- - string - 		-

Default post format.

+ default_post_format + 		+

Default post format.

+

+ JSON data type: string

Context:

- posts_per_page
- - integer - 		-

Blog pages show at most.

+ posts_per_page + 		+

Blog pages show at most.

+

+ JSON data type: integer

Context:

- show_on_front
- - string - 		-

What to show on the front page

+ show_on_front + 		+

What to show on the front page

+

+ JSON data type: string

Context:

- page_on_front
- - integer - 		-

The ID of the page that should be displayed on the front page

+ page_on_front + 		+

The ID of the page that should be displayed on the front page

+

+ JSON data type: integer

Context:

- page_for_posts
- - integer - 		-

The ID of the page that should display the latest posts

+ page_for_posts + 		+

The ID of the page that should display the latest posts

+

+ JSON data type: integer

Context:

- default_ping_status
- - string - 		-

Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.

+ default_ping_status + 		+

Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.

+

+ JSON data type: string

Context:

One of: open, closed
- default_comment_status
- - string - 		-

Allow people to submit comments on new posts.

+ default_comment_status + 		+

Allow people to submit comments on new posts.

+

+ JSON data type: string

Context:

One of: open, closed
- site_icon
- - integer - 		-

Site icon.

+ site_icon + 		+

Site icon.

+

+ JSON data type: integer

Context:

- + - + - + - + - + - + - + - + - + - + diff --git a/reference/tags.md b/reference/tags.md index 5964008..d710b0c 100644 --- a/reference/tags.md +++ b/reference/tags.md @@ -10,83 +10,83 @@
- id
- - string - 		-

ID of sidebar.

+ id + 		+

ID of sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- name
- - string - 		-

Unique name identifying the sidebar.

+ name + 		+

Unique name identifying the sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- description
- - string - 		-

Description of sidebar.

+ description + 		+

Description of sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- class
- - string - 		-

Extra CSS class to assign to the sidebar in the Widgets interface.

+ class + 		+

Extra CSS class to assign to the sidebar in the Widgets interface.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- before_widget
- - string - 		-

HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.

+ before_widget + 		+

HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- after_widget
- - string - 		-

HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.

+ after_widget + 		+

HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- before_title
- - string - 		-

HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.

+ before_title + 		+

HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- after_title
- - string - 		-

HTML content to append to the sidebar title when displayed. Default is a closing h2 element.

+ after_title + 		+

HTML content to append to the sidebar title when displayed. Default is a closing h2 element.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- status
- - string - 		-

Status of sidebar.

+ status + 		+

Status of sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit

One of: active, inactive

@@ -119,12 +119,12 @@
- widgets
- - array - 		-

Nested widgets.

+ widgets + 		+

Nested widgets.

+

+ JSON data type: array

Context: embed, view, edit
- + - + - + - + - + - + - + - + diff --git a/reference/taxonomies.md b/reference/taxonomies.md index f1e0f0c..d6f6c2f 100644 --- a/reference/taxonomies.md +++ b/reference/taxonomies.md @@ -10,132 +10,132 @@
- id
- - integer - 		-

Unique identifier for the term.

+ id + 		+

Unique identifier for the term.

+

+ JSON data type: integer

Read only

Context: view, embed, edit
- count
- - integer - 		-

Number of published posts for the term.

+ count + 		+

Number of published posts for the term.

+

+ JSON data type: integer

Read only

Context: view, edit
- description
- - string - 		-

HTML description of the term.

+ description + 		+

HTML description of the term.

+

+ JSON data type: string

Context: view, edit
- name
- - string - 		-

HTML title for the term.

+ name + 		+

HTML title for the term.

+

+ JSON data type: string

Context: view, embed, edit
- slug
- - string - 		-

An alphanumeric identifier for the term unique to its type.

+ slug + 		+

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

Context: view, embed, edit
- taxonomy
- - string - 		-

Type attribution for the term.

+ taxonomy + 		+

Type attribution for the term.

+

+ JSON data type: string

Read only

Context: view, embed, edit

One of: post_tag

@@ -94,12 +94,12 @@
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
- + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/themes.md b/reference/themes.md index e796bb7..9a1b082 100644 --- a/reference/themes.md +++ b/reference/themes.md @@ -10,182 +10,194 @@
- capabilities
- - object - 		-

All capabilities used by the taxonomy.

+ capabilities + 		+

All capabilities used by the taxonomy.

+

+ JSON data type: object

Read only

Context: edit
- description
- - string - 		-

A human-readable description of the taxonomy.

+ description + 		+

A human-readable description of the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit
- hierarchical
- - boolean - 		-

Whether or not the taxonomy should have children.

+ hierarchical + 		+

Whether or not the taxonomy should have children.

+

+ JSON data type: boolean

Read only

Context: view, edit
- labels
- - object - 		-

Human-readable labels for the taxonomy for various contexts.

+ labels + 		+

Human-readable labels for the taxonomy for various contexts.

+

+ JSON data type: object

Read only

Context: edit
- name
- - string - 		-

The title for the taxonomy.

+ name + 		+

The title for the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the taxonomy.

+ slug + 		+

An alphanumeric identifier for the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- show_cloud
- - boolean - 		-

Whether or not the term cloud should be displayed.

+ show_cloud + 		+

Whether or not the term cloud should be displayed.

+

+ JSON data type: boolean

Read only

Context: edit
- types
- - array - 		-

Types associated with the taxonomy.

+ types + 		+

Types associated with the taxonomy.

+

+ JSON data type: array

Read only

Context: view, edit
- rest_base
- - string - 		-

REST base route for the taxonomy.

+ rest_base + 		+

REST base route for the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- rest_namespace
- - string - 		-

REST namespace route for the taxonomy.

+ rest_namespace + 		+

REST namespace route for the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- visibility
- - object - 		-

The visibility settings for the taxonomy.

+ visibility + 		+

The visibility settings for the taxonomy.

+

+ JSON data type: object

Read only

Context: edit

- + - + - + - + + description + + + + + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/users.md b/reference/users.md index ff52668..19cee4a 100644 --- a/reference/users.md +++ b/reference/users.md @@ -10,225 +10,225 @@
- stylesheet
- - string - 		-

The theme's stylesheet. This uniquely identifies the theme.

+ stylesheet + 		+

The theme's stylesheet. This uniquely identifies the theme.

+

+ JSON data type: string

Read only

Context:

- template
- - string - 		-

The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's stylesheet.

+ template + 		+

The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's stylesheet.

+

+ JSON data type: string

Read only

Context:

- author
- - object - 		-

The theme author.

+ author + 		+

The theme author.

+

+ JSON data type: object

Read only

Context:

- author_uri
- - object - 		-

The website of the theme author.

+ author_uri + 		+

The website of the theme author.

+

+ JSON data type: object

Read only

Context:

- description
- - object - 		+

A description of the theme.

+

+ JSON data type: object

+

Read only

+

Context:

+
-

A description of the theme.

+ is_block_theme + 		+

Whether the theme is a block-based theme.

+

+ JSON data type: boolean

Read only

Context:

- name
- - object - 		-

The name of the theme.

+ name + 		+

The name of the theme.

+

+ JSON data type: object

Read only

Context:

- requires_php
- - string - 		-

The minimum PHP version required for the theme to work.

+ requires_php + 		+

The minimum PHP version required for the theme to work.

+

+ JSON data type: string

Read only

Context:

- requires_wp
- - string - 		-

The minimum WordPress version required for the theme to work.

+ requires_wp + 		+

The minimum WordPress version required for the theme to work.

+

+ JSON data type: string

Read only

Context:

- screenshot
- - string, - uri - - 		-

The theme's screenshot URL.

+ screenshot + 		+

The theme's screenshot URL.

+

+ JSON data type: string, + Format: uri +

Read only

Context:

- tags
- - object - 		-

Tags indicating styles and features of the theme.

+ tags + 		+

Tags indicating styles and features of the theme.

+

+ JSON data type: object

Read only

Context:

- textdomain
- - string - 		-

The theme's text domain.

+ textdomain + 		+

The theme's text domain.

+

+ JSON data type: string

Read only

Context:

- theme_supports
- - object - 		-

Features supported by this theme.

+ theme_supports + 		+

Features supported by this theme.

+

+ JSON data type: object

Read only

Context:

- theme_uri
- - object - 		-

The URI of the theme's webpage.

+ theme_uri + 		+

The URI of the theme's webpage.

+

+ JSON data type: object

Read only

Context:

- version
- - string - 		-

The theme's current version.

+ version + 		+

The theme's current version.

+

+ JSON data type: string

Read only

Context:

- status
- - string - 		-

A named status for the theme.

+ status + 		+

A named status for the theme.

+

+ JSON data type: string

Context:

One of: inactive, active

- + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -461,7 +461,7 @@ @@ -630,7 +630,7 @@ @@ -829,7 +829,7 @@ diff --git a/reference/widget-types.md b/reference/widget-types.md index 02db927..d3998d3 100644 --- a/reference/widget-types.md +++ b/reference/widget-types.md @@ -10,59 +10,59 @@
- id
- - integer - 		-

Unique identifier for the user.

+ id + 		+

Unique identifier for the user.

+

+ JSON data type: integer

Read only

Context: embed, view, edit
- username
- - string - 		-

Login name for the user.

+ username + 		+

Login name for the user.

+

+ JSON data type: string

Context: edit
- name
- - string - 		-

Display name for the user.

+ name + 		+

Display name for the user.

+

+ JSON data type: string

Context: embed, view, edit
- first_name
- - string - 		-

First name for the user.

+ first_name + 		+

First name for the user.

+

+ JSON data type: string

Context: edit
- last_name
- - string - 		-

Last name for the user.

+ last_name + 		+

Last name for the user.

+

+ JSON data type: string

Context: edit
- email
- - string, - email - - 		-

The email address for the user.

+ email + 		+

The email address for the user.

+

+ JSON data type: string, + Format: email +

Context: edit
- url
- - string, - uri - - 		-

URL of the user.

+ url + 		+

URL of the user.

+

+ JSON data type: string, + Format: uri +

Context: embed, view, edit
- description
- - string - 		-

Description of the user.

+ description + 		+

Description of the user.

+

+ JSON data type: string

Context: embed, view, edit
- locale
- - string - 		-

Locale for the user.

+ locale + 		+

Locale for the user.

+

+ JSON data type: string

Context: edit

-

One of: , en_US, de_DE

+

One of: , en_US
- nickname
- - string - 		-

The nickname for the user.

+ nickname + 		+

The nickname for the user.

+

+ JSON data type: string

Context: edit
- slug
- - string - 		-

An alphanumeric identifier for the user.

+ slug + 		+

An alphanumeric identifier for the user.

+

+ JSON data type: string

Context: embed, view, edit
- registered_date
- - string, - datetime (details) - - 		-

Registration date for the user.

+ registered_date + 		+

Registration date for the user.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: edit
- roles
- - array - 		-

Roles assigned to the user.

+ roles + 		+

Roles assigned to the user.

+

+ JSON data type: array

Context: edit
- password
- - string - 		-

Password for the user (never included).

+ password + 		+

Password for the user (never included).

+

+ JSON data type: string

Context:

- capabilities
- - object - 		-

All capabilities assigned to the user.

+ capabilities + 		+

All capabilities assigned to the user.

+

+ JSON data type: object

Read only

Context: edit
- extra_capabilities
- - object - 		-

Any extra capabilities assigned to the user.

+ extra_capabilities + 		+

Any extra capabilities assigned to the user.

+

+ JSON data type: object

Read only

Context: edit
- avatar_urls
- - object - 		-

Avatar URLs for the user.

+ avatar_urls + 		+

Avatar URLs for the user.

+

+ JSON data type: object

Read only

Context: embed, view, edit
- meta
- - object - 		-

Meta fields.

+ meta + 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit

Locale for the user.

-

One of: , en_US, de_DE

+

One of: , en_US

Locale for the user.

-

One of: , en_US, de_DE

+

One of: , en_US

Locale for the user.

-

One of: , en_US, de_DE

+

One of: , en_US
- + - + - + - + - + diff --git a/reference/widgets.md b/reference/widgets.md index 798a45d..74483d3 100644 --- a/reference/widgets.md +++ b/reference/widgets.md @@ -10,80 +10,80 @@
- id
- - string - 		-

Unique slug identifying the widget type.

+ id + 		+

Unique slug identifying the widget type.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- name
- - string - 		-

Human-readable name identifying the widget type.

+ name + 		+

Human-readable name identifying the widget type.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- description
- - string - 		-

Description of the widget.

+ description + 		+

Description of the widget.

+

+ JSON data type: string

Context: view, edit, embed
- is_multi
- - boolean - 		-

Whether the widget supports multiple instances

+ is_multi + 		+

Whether the widget supports multiple instances

+

+ JSON data type: boolean

Read only

Context: view, edit, embed
- classname
- - string - 		-

Class name

+ classname + 		+

Class name

+

+ JSON data type: string

Read only

Context: embed, view, edit

- + - + - + - + - + - + - + diff --git a/reference/wp-site-health-tests.md b/reference/wp-site-health-tests.md index 902a588..c863a2a 100644 --- a/reference/wp-site-health-tests.md +++ b/reference/wp-site-health-tests.md @@ -10,36 +10,36 @@
- id
- - string - 		-

Unique identifier for the widget.

+ id + 		+

Unique identifier for the widget.

+

+ JSON data type: string

Context: view, edit, embed
- id_base
- - string - 		-

The type of the widget. Corresponds to ID in widget-types endpoint.

+ id_base + 		+

The type of the widget. Corresponds to ID in widget-types endpoint.

+

+ JSON data type: string

Context: view, edit, embed
- sidebar
- - string - 		-

The sidebar the widget belongs to.

+ sidebar + 		+

The sidebar the widget belongs to.

+

+ JSON data type: string

Context: view, edit, embed
- rendered
- - string - 		-

HTML representation of the widget.

+ rendered + 		+

HTML representation of the widget.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- rendered_form
- - string - 		-

HTML representation of the widget admin form.

+ rendered_form + 		+

HTML representation of the widget admin form.

+

+ JSON data type: string

Read only

Context: edit
- instance
- - object - 		-

Instance settings of the widget, if supported.

+ instance + 		+

Instance settings of the widget, if supported.

+

+ JSON data type: object

Context: edit
- form_data
- - string - 		-

URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.

+ form_data + 		+

URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.

+

+ JSON data type: string

Context:

- + - + - + - + - + - + diff --git a/reference/wp_global_styles-revisions.md b/reference/wp_global_styles-revisions.md new file mode 100644 index 0000000..7d8e8e7 --- /dev/null +++ b/reference/wp_global_styles-revisions.md @@ -0,0 +1,190 @@ +--- +--- + +# Global_Styles Revisions + +
+
+

Schema

+

The schema defines all the fields that exist within a global_styles revision record. Any response from these endpoints can be expected to contain the fields below unless the `_filter` query parameter is used or the schema field only appears in a specific context.

+
- test
- - string - 		-

The name of the test being run.

+ test + 		+

The name of the test being run.

+

+ JSON data type: string

Read only

Context:

- label
- - string - 		-

A label describing the test.

+ label + 		+

A label describing the test.

+

+ JSON data type: string

Read only

Context:

- status
- - string - 		-

The status of the test.

+ status + 		+

The status of the test.

+

+ JSON data type: string

Read only

Context:

One of: good, recommended, critical

@@ -47,36 +47,36 @@
- badge
- - object - 		-

The category this test is grouped in.

+ badge + 		+

The category this test is grouped in.

+

+ JSON data type: object

Read only

Context:

- description
- - string - 		-

A more descriptive explanation of what the test looks for, and why it is important for the user.

+ description + 		+

A more descriptive explanation of what the test looks for, and why it is important for the user.

+

+ JSON data type: string

Read only

Context:

- actions
- - string - 		-

HTML containing an action to direct the user to where they can resolve the issue.

+ actions + 		+

HTML containing an action to direct the user to where they can resolve the issue.

+

+ JSON data type: string

Read only

Context:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ author + +

The ID for the author of the revision.

+

+ JSON data type: integer

+

Context: view, edit, embed

+
+ date + +

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

+

+ JSON data type: string, + Format: datetime (details) +

+

Context: view, edit, embed

+
+ date_gmt + +

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

+

Context: view, edit

+
+ id + +

Unique identifier for the revision.

+

+ JSON data type: integer

+

Context: view, edit, embed

+
+ modified + +

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

+

+ JSON data type: string, + Format: datetime (details) +

+

Context: view, edit

+
+ modified_gmt + +

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

+

Context: view, edit

+
+ parent + +

The ID for the parent of the revision.

+

+ JSON data type: integer

+

Context: view, edit, embed

+
+ styles + +

Global styles.

+

+ JSON data type: object

+

Context: view, edit

+
+ settings + +

Global settings.

+

+ JSON data type: object

+

Context: view, edit

+
+ + + + +
+
+

List Global_Styles Revisions

+

Query this endpoint to retrieve a collection of global_styles revisions. The response you receive can be controlled and filtered using the URL query parameters below.

+ +

Definition

+ + GET /wp/v2/global-styles/<parent>/revisions + +

Example Request

+ + $ curl https://example.com/wp-json/wp/v2/global-styles/<parent>/revisions +
+
+

Arguments

+ + + + + + + + + + + + + + + + + + + + + +
+ parent
+ 		+

The ID for the parent of the revision.

+
+ context
+ 		+

Scope under which the request is made; determines fields present in response.

+

+ Default: view +

+

One of: view, embed, edit

+
+ page
+ 		+

Current page of the collection.

+

+ Default: 1 +

+
+ per_page
+ 		+

Maximum number of items to be returned in result set.

+
+ offset
+ 		+

Offset the result set by a specific number of items.

+
+ +
+
+
diff --git a/reference/wp_global_styles.md b/reference/wp_global_styles.md index 1b27ff9..c9df3db 100644 --- a/reference/wp_global_styles.md +++ b/reference/wp_global_styles.md @@ -10,46 +10,46 @@ - + - + - + - + diff --git a/reference/wp_navigation-revisions.md b/reference/wp_navigation-revisions.md index c3197a5..a2c92e0 100644 --- a/reference/wp_navigation-revisions.md +++ b/reference/wp_navigation-revisions.md @@ -10,132 +10,132 @@
- id
- - string - 		-

ID of global styles config.

+ id + 		+

ID of global styles config.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- styles
- - object - 		-

Global styles.

+ styles + 		+

Global styles.

+

+ JSON data type: object

Context: view, edit
- settings
- - object - 		-

Global settings.

+ settings + 		+

Global settings.

+

+ JSON data type: object

Context: view, edit
- title
- - object or string - 		-

Title of the global styles variation.

+ title + 		+

Title of the global styles variation.

+

+ JSON data type: object or string

Context: embed, view, edit
- + - + - + - + - + - + - + - + - + - + - +
- author
- - integer - 		-

The ID for the author of the revision.

+ author + 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string, - datetime (details) - - 		-

The date the revision was published, as GMT.

+ date_gmt + 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the revision.

+ id + 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the revision was last modified, as GMT.

+ modified_gmt + 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- parent
- - integer - 		-

The ID for the parent of the revision.

+ parent + 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the revision unique to its type.

+ slug + 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object - 		-

The content for the post.

-

Context: view, edit

+ content + 		+

The content for the post.

+

+ JSON data type: object

+

Context: view, edit, embed
diff --git a/reference/wp_navigations.md b/reference/wp_navigations.md index 23dc6aa..02a3205 100644 --- a/reference/wp_navigations.md +++ b/reference/wp_navigations.md @@ -10,172 +10,172 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/wp_template-revisions.md b/reference/wp_template-revisions.md index 09754d1..e005b96 100644 --- a/reference/wp_template-revisions.md +++ b/reference/wp_template-revisions.md @@ -10,130 +10,130 @@
- date
- - string or null, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string or null, - datetime (details) - - 		-

The date the post was published, as GMT.

+ date_gmt + 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
- guid
- - object - 		-

The globally unique identifier for the post.

+ guid + 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit
- id
- - integer - 		-

Unique identifier for the post.

+ id + 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the post was last modified, as GMT.

+ modified_gmt + 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit
- slug
- - string - 		-

An alphanumeric identifier for the post unique to its type.

+ slug + 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- status
- - string - 		-

A named status for the post.

-

Context: view, edit

+ status + 		+

A named status for the post.

+

+ JSON data type: string

+

Context: view, edit, embed

One of: publish, future, draft, pending, private
- type
- - string - 		-

Type of post.

+ type + 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- password
- - string - 		-

A password to protect access to the content and excerpt.

+ password + 		+

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
- title
- - object - 		-

The title for the post.

+ title + 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object - 		-

The content for the post.

-

Context: view, edit

+ content + 		+

The content for the post.

+

+ JSON data type: object

+

Context: view, edit, embed
- template
- - string - 		-

The theme file to use to display the post.

+ template + 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
- + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/wp_template_part-revisions.md b/reference/wp_template_part-revisions.md index 5c0b31f..0cca2b3 100644 --- a/reference/wp_template_part-revisions.md +++ b/reference/wp_template_part-revisions.md @@ -10,130 +10,130 @@
- author
- - integer - 		-

The ID for the author of the revision.

+ author + 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string, - datetime (details) - - 		-

The date the revision was published, as GMT.

+ date_gmt + 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- guid
- - string - 		-

GUID for the revision, as it exists in the database.

+ guid + 		+

GUID for the revision, as it exists in the database.

+

+ JSON data type: string

Context: view, edit
- id
- - integer - 		-

Unique identifier for the revision.

+ id + 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the revision was last modified, as GMT.

+ modified_gmt + 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- parent
- - integer - 		-

The ID for the parent of the revision.

+ parent + 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the revision unique to its type.

+ slug + 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- title
- - object or string - 		-

Title of template.

+ title + 		+

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- content
- - object or string - 		-

Content of template.

+ content + 		+

Content of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/wp_template_parts.md b/reference/wp_template_parts.md index cab3739..7b1b643 100644 --- a/reference/wp_template_parts.md +++ b/reference/wp_template_parts.md @@ -10,161 +10,175 @@
- author
- - integer - 		-

The ID for the author of the revision.

+ author + 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - - 		-

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

+ date + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
- date_gmt
- - string, - datetime (details) - - 		-

The date the revision was published, as GMT.

+ date_gmt + 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- guid
- - string - 		-

GUID for the revision, as it exists in the database.

+ guid + 		+

GUID for the revision, as it exists in the database.

+

+ JSON data type: string

Context: view, edit
- id
- - integer - 		-

Unique identifier for the revision.

+ id + 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - - 		-

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

+ modified + 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- modified_gmt
- - string, - datetime (details) - - 		-

The date the revision was last modified, as GMT.

+ modified_gmt + 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
- parent
- - integer - 		-

The ID for the parent of the revision.

+ parent + 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- slug
- - string - 		-

An alphanumeric identifier for the revision unique to its type.

+ slug + 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- title
- - object or string - 		-

Title of template.

+ title + 		+

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- content
- - object or string - 		-

Content of template.

+ content + 		+

Content of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- + - + - + - + - + - + - + - + - + - + - + - + - + - + + modified + + + + + diff --git a/reference/wp_templates.md b/reference/wp_templates.md index 0627d6e..2153c0a 100644 --- a/reference/wp_templates.md +++ b/reference/wp_templates.md @@ -10,161 +10,175 @@
- id
- - string - 		-

ID of template.

+ id + 		+

ID of template.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- slug
- - string - 		-

Unique slug identifying the template.

+ slug + 		+

Unique slug identifying the template.

+

+ JSON data type: string

Context: embed, view, edit
- theme
- - string - 		-

Theme identifier for the template.

+ theme + 		+

Theme identifier for the template.

+

+ JSON data type: string

Context: embed, view, edit
- type
- - string - 		-

Type of template.

+ type + 		+

Type of template.

+

+ JSON data type: string

Context: embed, view, edit
- source
- - string - 		-

Source of template

+ source + 		+

Source of template

+

+ JSON data type: string

Read only

Context: embed, view, edit
- origin
- - string - 		-

Source of a customized template

+ origin + 		+

Source of a customized template

+

+ JSON data type: string

Read only

Context: embed, view, edit
- content
- - object or string - 		-

Content of template.

+ content + 		+

Content of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- title
- - object or string - 		-

Title of template.

+ title + 		+

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- description
- - string - 		-

Description of template.

+ description + 		+

Description of template.

+

+ JSON data type: string

Context: embed, view, edit
- status
- - string - 		-

Status of template.

+ status + 		+

Status of template.

+

+ JSON data type: string

Context: embed, view, edit

One of: publish, future, draft, pending, private
- wp_id
- - integer - 		-

Post ID.

+ wp_id + 		+

Post ID.

+

+ JSON data type: integer

Read only

Context: embed, view, edit
- has_theme_file
- - bool - 		-

Theme file exists.

+ has_theme_file + 		+

Theme file exists.

+

+ JSON data type: bool

Read only

Context: embed, view, edit
- author
- - integer - 		-

The ID for the author of the template.

+ author + 		+

The ID for the author of the template.

+

+ JSON data type: integer

Context: view, edit, embed
- area
- - string - 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

+

Read only

+

Context: view, edit

+
-

Where the template part is intended for use (header, footer, etc.)

+ area + 		+

Where the template part is intended for use (header, footer, etc.)

+

+ JSON data type: string

Context: embed, view, edit
- + - + - + - + - + - + - + - + - + - + - + - + - + - + + modified + + + + + From b612adec01ad51d39546810a55e2cda3508d4d30 Mon Sep 17 00:00:00 2001 From: Scott Cranfill Date: Thu, 24 Aug 2023 13:38:10 -0700 Subject: [PATCH 2/2] Fix accidental indentation changes --- bin/templates/reference-parts/schema.html | 22 +- reference/application-passwords.md | 84 +++---- reference/block-directory-items.md | 138 +++++----- reference/block-pattern-categories.md | 30 +-- reference/block-patterns.md | 120 ++++----- reference/block-revisions.md | 126 +++++----- reference/block-types.md | 290 ++++++++++----------- reference/blocks.md | 170 ++++++------- reference/categories.md | 94 +++---- reference/comments.md | 190 +++++++------- reference/media.md | 294 +++++++++++----------- reference/menu-locations.md | 30 +-- reference/nav_menu_item-revisions.md | 130 +++++----- reference/nav_menu_items.md | 184 +++++++------- reference/nav_menus.md | 70 +++--- reference/navigation-fallbacks.md | 10 +- reference/page-revisions.md | 136 +++++----- reference/pages.md | 260 +++++++++---------- reference/pattern-directory-items.md | 80 +++--- reference/plugins.md | 128 +++++----- reference/post-revisions.md | 136 +++++----- reference/post-statuses.md | 80 +++--- reference/post-types.md | 140 +++++------ reference/posts.md | 280 ++++++++++----------- reference/rendered-blocks.md | 10 +- reference/search-results.md | 54 ++-- reference/settings.md | 206 +++++++-------- reference/sidebars.md | 100 ++++---- reference/tags.md | 84 +++---- reference/taxonomies.md | 110 ++++---- reference/themes.md | 164 ++++++------ reference/users.md | 204 +++++++-------- reference/widget-types.md | 50 ++-- reference/widgets.md | 70 +++--- reference/wp-site-health-tests.md | 60 ++--- reference/wp_global_styles-revisions.md | 106 ++++---- reference/wp_global_styles.md | 40 +-- reference/wp_navigation-revisions.md | 126 +++++----- reference/wp_navigations.md | 160 ++++++------ reference/wp_template-revisions.md | 126 +++++----- reference/wp_template_part-revisions.md | 126 +++++----- reference/wp_template_parts.md | 154 ++++++------ reference/wp_templates.md | 154 ++++++------ 43 files changed, 2663 insertions(+), 2663 deletions(-) diff --git a/bin/templates/reference-parts/schema.html b/bin/templates/reference-parts/schema.html index 41263b0..f0dbcfe 100644 --- a/bin/templates/reference-parts/schema.html +++ b/bin/templates/reference-parts/schema.html @@ -5,17 +5,17 @@

Schema

 - + - + - + @@ -38,22 +38,22 @@ - + - + @@ -61,13 +61,13 @@ - + @@ -75,13 +75,13 @@ - + @@ -89,12 +89,12 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/block-pattern-categories.md b/reference/block-pattern-categories.md index f139793..6d38a6b 100644 --- a/reference/block-pattern-categories.md +++ b/reference/block-pattern-categories.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + diff --git a/reference/block-patterns.md b/reference/block-patterns.md index 39af9f7..295c080 100644 --- a/reference/block-patterns.md +++ b/reference/block-patterns.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + @@ -47,11 +47,11 @@ - + @@ -59,11 +59,11 @@ - + @@ -71,11 +71,11 @@ - + @@ -83,11 +83,11 @@ - + @@ -95,11 +95,11 @@ - + @@ -107,11 +107,11 @@ - + @@ -119,11 +119,11 @@ - + @@ -131,11 +131,11 @@ - + @@ -143,11 +143,11 @@ - + - + - + - + - + @@ -60,81 +60,81 @@ - + - + - + - + - + - + - + diff --git a/reference/block-types.md b/reference/block-types.md index be2bd4b..e2bbcad 100644 --- a/reference/block-types.md +++ b/reference/block-types.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + @@ -47,11 +47,11 @@ - + @@ -59,11 +59,11 @@ - + @@ -71,11 +71,11 @@ - + @@ -83,11 +83,11 @@ - + @@ -95,11 +95,11 @@ - + @@ -107,11 +107,11 @@ - + @@ -119,11 +119,11 @@ - + @@ -131,11 +131,11 @@ - + @@ -143,11 +143,11 @@ - + @@ -155,11 +155,11 @@ - + @@ -167,11 +167,11 @@ - + @@ -179,11 +179,11 @@ - + @@ -191,11 +191,11 @@ - + @@ -203,11 +203,11 @@ - + @@ -215,11 +215,11 @@ - + @@ -227,11 +227,11 @@ - + @@ -239,11 +239,11 @@ - + @@ -251,11 +251,11 @@ - + @@ -263,11 +263,11 @@ - + @@ -275,11 +275,11 @@ - + @@ -287,11 +287,11 @@ - + @@ -299,11 +299,11 @@ - + @@ -311,11 +311,11 @@ - + @@ -323,11 +323,11 @@ - + @@ -335,11 +335,11 @@ - + @@ -347,11 +347,11 @@ - + diff --git a/reference/blocks.md b/reference/blocks.md index c69d24b..df2e0d8 100644 --- a/reference/blocks.md +++ b/reference/blocks.md @@ -11,37 +11,37 @@ - + - + - + @@ -49,11 +49,11 @@ - + @@ -61,13 +61,13 @@ - + @@ -75,13 +75,13 @@ - + @@ -89,13 +89,13 @@ - + @@ -103,22 +103,22 @@ - + - + @@ -126,11 +126,11 @@ - + @@ -138,55 +138,55 @@ - + - + - + - + - + diff --git a/reference/categories.md b/reference/categories.md index e1a294e..7779760 100644 --- a/reference/categories.md +++ b/reference/categories.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,24 +35,24 @@ - + - + @@ -60,33 +60,33 @@ - + - + - + - + - + diff --git a/reference/comments.md b/reference/comments.md index c6707a9..eb6b541 100644 --- a/reference/comments.md +++ b/reference/comments.md @@ -11,11 +11,11 @@ - + @@ -23,23 +23,23 @@ - + - + @@ -47,12 +47,12 @@ - + @@ -60,85 +60,85 @@ - + - + - + - + - + - + - + @@ -146,44 +146,44 @@ - + - + - + - + @@ -191,11 +191,11 @@ - + @@ -203,11 +203,11 @@ - + diff --git a/reference/media.md b/reference/media.md index 0427bc1..c5f1b2d 100644 --- a/reference/media.md +++ b/reference/media.md @@ -11,37 +11,37 @@ - + - + - + @@ -49,11 +49,11 @@ - + @@ -61,13 +61,13 @@ - + @@ -75,13 +75,13 @@ - + @@ -89,13 +89,13 @@ - + @@ -103,22 +103,22 @@ - + - + @@ -126,11 +126,11 @@ - + @@ -138,11 +138,11 @@ - + @@ -150,11 +150,11 @@ - + @@ -162,33 +162,33 @@ - + - + - + @@ -196,11 +196,11 @@ - + @@ -208,66 +208,66 @@ - + - + - + - + - + - + - + @@ -288,11 +288,11 @@ - + @@ -300,24 +300,24 @@ - + - + @@ -325,11 +325,11 @@ - + diff --git a/reference/menu-locations.md b/reference/menu-locations.md index 3a76e21..97943d1 100644 --- a/reference/menu-locations.md +++ b/reference/menu-locations.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + diff --git a/reference/nav_menu_item-revisions.md b/reference/nav_menu_item-revisions.md index 4757ba5..dcc87db 100644 --- a/reference/nav_menu_item-revisions.md +++ b/reference/nav_menu_item-revisions.md @@ -11,131 +11,131 @@ - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/nav_menu_items.md b/reference/nav_menu_items.md index bab65d2..25e5d18 100644 --- a/reference/nav_menu_items.md +++ b/reference/nav_menu_items.md @@ -11,22 +11,22 @@ - + - + @@ -34,11 +34,11 @@ - + @@ -46,11 +46,11 @@ - + @@ -58,11 +58,11 @@ - + @@ -70,88 +70,88 @@ - + - + - + - + - + - + - + - + @@ -159,35 +159,35 @@ - + - + - + @@ -195,22 +195,22 @@ - + - + diff --git a/reference/nav_menus.md b/reference/nav_menus.md index 359f748..90beb23 100644 --- a/reference/nav_menus.md +++ b/reference/nav_menus.md @@ -11,11 +11,11 @@ - + @@ -23,66 +23,66 @@ - + - + - + - + - + - + diff --git a/reference/navigation-fallbacks.md b/reference/navigation-fallbacks.md index a7d9087..62fc004 100644 --- a/reference/navigation-fallbacks.md +++ b/reference/navigation-fallbacks.md @@ -11,11 +11,11 @@ - + diff --git a/reference/page-revisions.md b/reference/page-revisions.md index e274bef..9f45333 100644 --- a/reference/page-revisions.md +++ b/reference/page-revisions.md @@ -11,48 +11,48 @@ - + - + - + - + @@ -60,92 +60,92 @@ - + - + - + - + - + - + - + - + diff --git a/reference/pages.md b/reference/pages.md index 0121e77..0215628 100644 --- a/reference/pages.md +++ b/reference/pages.md @@ -11,37 +11,37 @@ - + - + - + @@ -49,11 +49,11 @@ - + @@ -61,13 +61,13 @@ - + @@ -75,13 +75,13 @@ - + @@ -89,13 +89,13 @@ - + @@ -103,22 +103,22 @@ - + - + @@ -126,11 +126,11 @@ - + @@ -138,22 +138,22 @@ - + - + @@ -161,11 +161,11 @@ - + @@ -173,77 +173,77 @@ - + - + - + - + - + - + - + @@ -251,11 +251,11 @@ - + @@ -263,33 +263,33 @@ - + - + - + diff --git a/reference/pattern-directory-items.md b/reference/pattern-directory-items.md index 5746085..7ddec50 100644 --- a/reference/pattern-directory-items.md +++ b/reference/pattern-directory-items.md @@ -11,88 +11,88 @@ - + - + - + - + - + - + - + - + diff --git a/reference/plugins.md b/reference/plugins.md index 40b45ff..fa4aca0 100644 --- a/reference/plugins.md +++ b/reference/plugins.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + @@ -47,13 +47,13 @@ - + @@ -61,11 +61,11 @@ - + @@ -73,13 +73,13 @@ - + @@ -87,11 +87,11 @@ - + @@ -99,11 +99,11 @@ - + @@ -111,11 +111,11 @@ - + @@ -123,11 +123,11 @@ - + @@ -135,11 +135,11 @@ - + @@ -147,11 +147,11 @@ - + diff --git a/reference/post-revisions.md b/reference/post-revisions.md index ee629e1..054f4ed 100644 --- a/reference/post-revisions.md +++ b/reference/post-revisions.md @@ -11,48 +11,48 @@ - + - + - + - + @@ -60,92 +60,92 @@ - + - + - + - + - + - + - + - + diff --git a/reference/post-statuses.md b/reference/post-statuses.md index e4442d9..000e27b 100644 --- a/reference/post-statuses.md +++ b/reference/post-statuses.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + @@ -47,11 +47,11 @@ - + @@ -59,11 +59,11 @@ - + @@ -71,11 +71,11 @@ - + @@ -83,11 +83,11 @@ - + @@ -95,11 +95,11 @@ - + diff --git a/reference/post-types.md b/reference/post-types.md index 05c6ad2..dd9dedb 100644 --- a/reference/post-types.md +++ b/reference/post-types.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + @@ -47,11 +47,11 @@ - + @@ -59,11 +59,11 @@ - + @@ -71,11 +71,11 @@ - + @@ -83,11 +83,11 @@ - + @@ -95,11 +95,11 @@ - + @@ -107,11 +107,11 @@ - + @@ -119,11 +119,11 @@ - + @@ -131,11 +131,11 @@ - + @@ -143,11 +143,11 @@ - + @@ -155,11 +155,11 @@ - + @@ -167,11 +167,11 @@ - + diff --git a/reference/posts.md b/reference/posts.md index 823b2da..42f840d 100644 --- a/reference/posts.md +++ b/reference/posts.md @@ -11,37 +11,37 @@ - + - + - + @@ -49,11 +49,11 @@ - + @@ -61,13 +61,13 @@ - + @@ -75,13 +75,13 @@ - + @@ -89,13 +89,13 @@ - + @@ -103,22 +103,22 @@ - + - + @@ -126,11 +126,11 @@ - + @@ -138,22 +138,22 @@ - + - + @@ -161,11 +161,11 @@ - + @@ -173,66 +173,66 @@ - + - + - + - + - + - + @@ -240,11 +240,11 @@ - + @@ -252,11 +252,11 @@ - + @@ -264,55 +264,55 @@ - + - + - + - + - + diff --git a/reference/rendered-blocks.md b/reference/rendered-blocks.md index 227b094..1e466a5 100644 --- a/reference/rendered-blocks.md +++ b/reference/rendered-blocks.md @@ -11,11 +11,11 @@ - + diff --git a/reference/search-results.md b/reference/search-results.md index 31969c7..438fcc3 100644 --- a/reference/search-results.md +++ b/reference/search-results.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,13 +35,13 @@ - + @@ -49,11 +49,11 @@ - + - + - + - + - + - + @@ -59,143 +59,143 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -203,11 +203,11 @@ - + @@ -215,22 +215,22 @@ - + - + diff --git a/reference/sidebars.md b/reference/sidebars.md index 3463f1a..e925efe 100644 --- a/reference/sidebars.md +++ b/reference/sidebars.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + @@ -47,11 +47,11 @@ - + @@ -59,11 +59,11 @@ - + @@ -71,11 +71,11 @@ - + @@ -83,11 +83,11 @@ - + @@ -95,11 +95,11 @@ - + @@ -107,11 +107,11 @@ - + - + diff --git a/reference/tags.md b/reference/tags.md index d710b0c..7e9b7f8 100644 --- a/reference/tags.md +++ b/reference/tags.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,24 +35,24 @@ - + - + @@ -60,33 +60,33 @@ - + - + - + - + diff --git a/reference/taxonomies.md b/reference/taxonomies.md index d6f6c2f..121e3ab 100644 --- a/reference/taxonomies.md +++ b/reference/taxonomies.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + @@ -47,11 +47,11 @@ - + @@ -59,11 +59,11 @@ - + @@ -71,11 +71,11 @@ - + @@ -83,11 +83,11 @@ - + @@ -95,11 +95,11 @@ - + @@ -107,11 +107,11 @@ - + @@ -119,11 +119,11 @@ - + @@ -131,11 +131,11 @@ - + diff --git a/reference/themes.md b/reference/themes.md index 9a1b082..a3afe4b 100644 --- a/reference/themes.md +++ b/reference/themes.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + @@ -47,11 +47,11 @@ - + @@ -59,11 +59,11 @@ - + @@ -71,11 +71,11 @@ - + @@ -83,11 +83,11 @@ - + @@ -95,11 +95,11 @@ - + @@ -107,11 +107,11 @@ - + @@ -119,13 +119,13 @@ - + @@ -133,11 +133,11 @@ - + @@ -145,11 +145,11 @@ - + @@ -157,11 +157,11 @@ - + @@ -169,11 +169,11 @@ - + @@ -181,11 +181,11 @@ - + @@ -193,11 +193,11 @@ - + diff --git a/reference/users.md b/reference/users.md index 19cee4a..62bce0f 100644 --- a/reference/users.md +++ b/reference/users.md @@ -11,11 +11,11 @@ - + @@ -23,56 +23,56 @@ - + - + - + - + - + @@ -80,37 +80,37 @@ - + - + - + @@ -118,11 +118,11 @@ - + @@ -130,35 +130,35 @@ - + - + - + @@ -166,33 +166,33 @@ - + - + - + @@ -200,11 +200,11 @@ - + @@ -212,11 +212,11 @@ - + @@ -224,11 +224,11 @@ - + diff --git a/reference/widget-types.md b/reference/widget-types.md index d3998d3..5077952 100644 --- a/reference/widget-types.md +++ b/reference/widget-types.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,22 +35,22 @@ - + - + @@ -58,11 +58,11 @@ - + diff --git a/reference/widgets.md b/reference/widgets.md index 74483d3..66d85c7 100644 --- a/reference/widgets.md +++ b/reference/widgets.md @@ -11,44 +11,44 @@ - + - + - + - + @@ -56,11 +56,11 @@ - + @@ -68,22 +68,22 @@ - + - + diff --git a/reference/wp-site-health-tests.md b/reference/wp-site-health-tests.md index c863a2a..c051a63 100644 --- a/reference/wp-site-health-tests.md +++ b/reference/wp-site-health-tests.md @@ -11,11 +11,11 @@ - + @@ -23,11 +23,11 @@ - + @@ -35,11 +35,11 @@ - + - + @@ -60,11 +60,11 @@ - + @@ -72,11 +72,11 @@ - + diff --git a/reference/wp_global_styles-revisions.md b/reference/wp_global_styles-revisions.md index 7d8e8e7..c83567c 100644 --- a/reference/wp_global_styles-revisions.md +++ b/reference/wp_global_styles-revisions.md @@ -11,107 +11,107 @@ - + - + - + - + - + - + - + - + - + diff --git a/reference/wp_global_styles.md b/reference/wp_global_styles.md index c9df3db..d06e1e7 100644 --- a/reference/wp_global_styles.md +++ b/reference/wp_global_styles.md @@ -11,11 +11,11 @@ - + @@ -23,33 +23,33 @@ - + - + - + diff --git a/reference/wp_navigation-revisions.md b/reference/wp_navigation-revisions.md index a2c92e0..8debdbc 100644 --- a/reference/wp_navigation-revisions.md +++ b/reference/wp_navigation-revisions.md @@ -11,48 +11,48 @@ - + - + - + - + @@ -60,81 +60,81 @@ - + - + - + - + - + - + - + diff --git a/reference/wp_navigations.md b/reference/wp_navigations.md index 02a3205..59a2362 100644 --- a/reference/wp_navigations.md +++ b/reference/wp_navigations.md @@ -11,37 +11,37 @@ - + - + - + @@ -49,11 +49,11 @@ - + @@ -61,13 +61,13 @@ - + @@ -75,13 +75,13 @@ - + @@ -89,13 +89,13 @@ - + @@ -103,22 +103,22 @@ - + - + @@ -126,11 +126,11 @@ - + @@ -138,44 +138,44 @@ - + - + - + - + diff --git a/reference/wp_template-revisions.md b/reference/wp_template-revisions.md index e005b96..786cb04 100644 --- a/reference/wp_template-revisions.md +++ b/reference/wp_template-revisions.md @@ -11,129 +11,129 @@ - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/wp_template_part-revisions.md b/reference/wp_template_part-revisions.md index 0cca2b3..79df84d 100644 --- a/reference/wp_template_part-revisions.md +++ b/reference/wp_template_part-revisions.md @@ -11,129 +11,129 @@ - + - + - + - + - + - + - + - + - + - + - + diff --git a/reference/wp_template_parts.md b/reference/wp_template_parts.md index 7b1b643..1fe738b 100644 --- a/reference/wp_template_parts.md +++ b/reference/wp_template_parts.md @@ -11,11 +11,11 @@ - + @@ -23,44 +23,44 @@ - + - + - + - + @@ -68,11 +68,11 @@ - + @@ -80,44 +80,44 @@ - + - + - + - + @@ -125,11 +125,11 @@ - + @@ -137,11 +137,11 @@ - + @@ -149,24 +149,24 @@ - + - + @@ -174,11 +174,11 @@ - + diff --git a/reference/wp_templates.md b/reference/wp_templates.md index 2153c0a..de5603e 100644 --- a/reference/wp_templates.md +++ b/reference/wp_templates.md @@ -11,11 +11,11 @@ - + @@ -23,44 +23,44 @@ - + - + - + - + @@ -68,11 +68,11 @@ - + @@ -80,44 +80,44 @@ - + - + - + - + @@ -125,11 +125,11 @@ - + @@ -137,11 +137,11 @@ - + @@ -149,24 +149,24 @@ - + - + @@ -174,11 +174,11 @@ - +
- id
- - string - 		-

ID of template.

+ id + 		+

ID of template.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- slug
- - string - 		-

Unique slug identifying the template.

+ slug + 		+

Unique slug identifying the template.

+

+ JSON data type: string

Context: embed, view, edit
- theme
- - string - 		-

Theme identifier for the template.

+ theme + 		+

Theme identifier for the template.

+

+ JSON data type: string

Context: embed, view, edit
- type
- - string - 		-

Type of template.

+ type + 		+

Type of template.

+

+ JSON data type: string

Context: embed, view, edit
- source
- - string - 		-

Source of template

+ source + 		+

Source of template

+

+ JSON data type: string

Read only

Context: embed, view, edit
- origin
- - string - 		-

Source of a customized template

+ origin + 		+

Source of a customized template

+

+ JSON data type: string

Read only

Context: embed, view, edit
- content
- - object or string - 		-

Content of template.

+ content + 		+

Content of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- title
- - object or string - 		-

Title of template.

+ title + 		+

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- description
- - string - 		-

Description of template.

+ description + 		+

Description of template.

+

+ JSON data type: string

Context: embed, view, edit
- status
- - string - 		-

Status of template.

+ status + 		+

Status of template.

+

+ JSON data type: string

Context: embed, view, edit

One of: publish, future, draft, pending, private
- wp_id
- - integer - 		-

Post ID.

+ wp_id + 		+

Post ID.

+

+ JSON data type: integer

Read only

Context: embed, view, edit
- has_theme_file
- - bool - 		-

Theme file exists.

+ has_theme_file + 		+

Theme file exists.

+

+ JSON data type: bool

Read only

Context: embed, view, edit
- author
- - integer - 		-

The ID for the author of the template.

+ author + 		+

The ID for the author of the template.

+

+ JSON data type: integer

Context: view, edit, embed
- is_custom
- - bool - 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

+

Read only

+

Context: view, edit

+
-

Whether a template is a custom template.

+ is_custom + 		+

Whether a template is a custom template.

+

+ JSON data type: bool

Read only

Context: embed, view, edit

{{ key }} - -

{{ property.description }}

-

- JSON data type: {{ property.type | join(' or ') }}{% if property.format %}, - {% if property.format == 'date-time' %} - Format: datetime (details) - {% elseif property.format == 'uri' %} - Format: uri - {% else %} - Format: {{ property.format }} +

+

{{ property.description }}

+

+ JSON data type: {{ property.type | join(' or ') }}{% if property.format %}, + {% if property.format == 'date-time' %} + Format: datetime (details) + {% elseif property.format == 'uri' %} + Format: uri + {% else %} + Format: {{ property.format }} {% endif %}{% endif %}

{% if property.readonly %} diff --git a/reference/application-passwords.md b/reference/application-passwords.md index a075601..c9d0660 100644 --- a/reference/application-passwords.md +++ b/reference/application-passwords.md @@ -11,12 +11,12 @@
uuid - -

The unique identifier for the application password.

-

- JSON data type: string, - Format: uuid +

+

The unique identifier for the application password.

+

+ JSON data type: string, + Format: uuid

Read only

Context: view, edit, embed

@@ -25,12 +25,12 @@
app_id - -

A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.

-

- JSON data type: string, - Format: uuid +

+

A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.

+

+ JSON data type: string, + Format: uuid

Context: view, edit, embed

name - -

The name of the application password.

-

- JSON data type: string

+ 		+

The name of the application password.

+

+ JSON data type: string

Context: view, edit, embed
password - -

The generated password. Only available after adding an application.

-

- JSON data type: string

+ 		+

The generated password. Only available after adding an application.

+

+ JSON data type: string

Read only

Context: edit

created - -

The GMT date the application password was created.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The GMT date the application password was created.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

last_used - -

The GMT date the application password was last used.

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

The GMT date the application password was last used.

+

+ JSON data type: string or null, + Format: datetime (details) +

Read only

Context: view, edit

last_ip - -

The IP address the application password was last used by.

-

- JSON data type: string or null, - Format: ip +

+

The IP address the application password was last used by.

+

+ JSON data type: string or null, + Format: ip

Read only

Context: view, edit

diff --git a/reference/block-directory-items.md b/reference/block-directory-items.md index 59fc802..89bebe8 100644 --- a/reference/block-directory-items.md +++ b/reference/block-directory-items.md @@ -11,147 +11,147 @@
name - -

The block name, in namespace/block-name format.

-

- JSON data type: string

+ 		+

The block name, in namespace/block-name format.

+

+ JSON data type: string

Context: view
title - -

The block title, in human readable format.

-

- JSON data type: string

+ 		+

The block title, in human readable format.

+

+ JSON data type: string

Context: view
description - -

A short description of the block, in human readable format.

-

- JSON data type: string

+ 		+

A short description of the block, in human readable format.

+

+ JSON data type: string

Context: view
id - -

The block slug.

-

- JSON data type: string

+ 		+

The block slug.

+

+ JSON data type: string

Context: view
rating - -

The star rating of the block.

-

- JSON data type: number

+ 		+

The star rating of the block.

+

+ JSON data type: number

Context: view
rating_count - -

The number of ratings.

-

- JSON data type: integer

+ 		+

The number of ratings.

+

+ JSON data type: integer

Context: view
active_installs - -

The number sites that have activated this block.

-

- JSON data type: integer

+ 		+

The number sites that have activated this block.

+

+ JSON data type: integer

Context: view
author_block_rating - -

The average rating of blocks published by the same author.

-

- JSON data type: number

+ 		+

The average rating of blocks published by the same author.

+

+ JSON data type: number

Context: view
author_block_count - -

The number of blocks published by the same author.

-

- JSON data type: integer

+ 		+

The number of blocks published by the same author.

+

+ JSON data type: integer

Context: view
author - -

The WordPress.org username of the block author.

-

- JSON data type: string

+ 		+

The WordPress.org username of the block author.

+

+ JSON data type: string

Context: view
icon - -

The block icon.

-

- JSON data type: string, - Format: uri -

+ 		+

The block icon.

+

+ JSON data type: string, + Format: uri +

Context: view
last_updated - -

The date when the block was last updated.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date when the block was last updated.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view
humanized_updated - -

The date when the block was last updated, in fuzzy human readable format.

-

- JSON data type: string

+ 		+

The date when the block was last updated, in fuzzy human readable format.

+

+ JSON data type: string

Context: view
name - -

The category name.

-

- JSON data type: string

+ 		+

The category name.

+

+ JSON data type: string

Read only

Context: view, edit, embed

label - -

The category label, in human readable format.

-

- JSON data type: string

+ 		+

The category label, in human readable format.

+

+ JSON data type: string

Read only

Context: view, edit, embed

description - -

The category description, in human readable format.

-

- JSON data type: string

+ 		+

The category description, in human readable format.

+

+ JSON data type: string

Read only

Context: view, edit, embed

name - -

The pattern name.

-

- JSON data type: string

+ 		+

The pattern name.

+

+ JSON data type: string

Read only

Context: view, edit, embed

title - -

The pattern title, in human readable format.

-

- JSON data type: string

+ 		+

The pattern title, in human readable format.

+

+ JSON data type: string

Read only

Context: view, edit, embed

content - -

The pattern content.

-

- JSON data type: string

+ 		+

The pattern content.

+

+ JSON data type: string

Read only

Context: view, edit, embed

description - -

The pattern detailed description.

-

- JSON data type: string

+ 		+

The pattern detailed description.

+

+ JSON data type: string

Read only

Context: view, edit, embed

viewport_width - -

The pattern viewport width for inserter preview.

-

- JSON data type: number

+ 		+

The pattern viewport width for inserter preview.

+

+ JSON data type: number

Read only

Context: view, edit, embed

inserter - -

Determines whether the pattern is visible in inserter.

-

- JSON data type: boolean

+ 		+

Determines whether the pattern is visible in inserter.

+

+ JSON data type: boolean

Read only

Context: view, edit, embed

categories - -

The pattern category slugs.

-

- JSON data type: array

+ 		+

The pattern category slugs.

+

+ JSON data type: array

Read only

Context: view, edit, embed

keywords - -

The pattern keywords.

-

- JSON data type: array

+ 		+

The pattern keywords.

+

+ JSON data type: array

Read only

Context: view, edit, embed

block_types - -

Block types that the pattern is intended to be used with.

-

- JSON data type: array

+ 		+

Block types that the pattern is intended to be used with.

+

+ JSON data type: array

Read only

Context: view, edit, embed

post_types - -

An array of post types that the pattern is restricted to be used with.

-

- JSON data type: array

+ 		+

An array of post types that the pattern is restricted to be used with.

+

+ JSON data type: array

Read only

Context: view, edit, embed

template_types - -

An array of template types where the pattern fits.

-

- JSON data type: array

+ 		+

An array of template types where the pattern fits.

+

+ JSON data type: array

Read only

Context: view, edit, embed

source - -

Where the pattern comes from e.g. core

-

- JSON data type: string

+ 		+

Where the pattern comes from e.g. core

+

+ JSON data type: string

Read only

Context: view, edit, embed

One of: core, plugin, theme, pattern-directory/core, pattern-directory/theme, pattern-directory/featured

diff --git a/reference/block-revisions.md b/reference/block-revisions.md index b9f68a8..56bdd20 100644 --- a/reference/block-revisions.md +++ b/reference/block-revisions.md @@ -11,48 +11,48 @@
author - -

The ID for the author of the revision.

-

- JSON data type: integer

+ 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the revision was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the revision.

-

- JSON data type: integer

+ 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
modified_gmt - -

The date the revision was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the revision.

-

- JSON data type: integer

+ 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
slug - -

An alphanumeric identifier for the revision unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
content - -

The content for the post.

-

- JSON data type: object

+ 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
api_version - -

Version of block API.

-

- JSON data type: integer

+ 		+

Version of block API.

+

+ JSON data type: integer

Read only

Context: embed, view, edit

title - -

Title of block type.

-

- JSON data type: string

+ 		+

Title of block type.

+

+ JSON data type: string

Read only

Context: embed, view, edit

name - -

Unique name identifying the block type.

-

- JSON data type: string

+ 		+

Unique name identifying the block type.

+

+ JSON data type: string

Read only

Context: embed, view, edit

description - -

Description of block type.

-

- JSON data type: string

+ 		+

Description of block type.

+

+ JSON data type: string

Read only

Context: embed, view, edit

icon - -

Icon of block type.

-

- JSON data type: string or null

+ 		+

Icon of block type.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

attributes - -

Block attributes.

-

- JSON data type: object or null

+ 		+

Block attributes.

+

+ JSON data type: object or null

Read only

Context: embed, view, edit

provides_context - -

Context provided by blocks of this type.

-

- JSON data type: object

+ 		+

Context provided by blocks of this type.

+

+ JSON data type: object

Read only

Context: embed, view, edit

uses_context - -

Context values inherited by blocks of this type.

-

- JSON data type: array

+ 		+

Context values inherited by blocks of this type.

+

+ JSON data type: array

Read only

Context: embed, view, edit

selectors - -

Custom CSS selectors.

-

- JSON data type: object

+ 		+

Custom CSS selectors.

+

+ JSON data type: object

Read only

Context: embed, view, edit

supports - -

Block supports.

-

- JSON data type: object

+ 		+

Block supports.

+

+ JSON data type: object

Read only

Context: embed, view, edit

category - -

Block category.

-

- JSON data type: string or null

+ 		+

Block category.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

is_dynamic - -

Is the block dynamically rendered.

-

- JSON data type: boolean

+ 		+

Is the block dynamically rendered.

+

+ JSON data type: boolean

Read only

Context: embed, view, edit

editor_script_handles - -

Editor script handles.

-

- JSON data type: array

+ 		+

Editor script handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit

script_handles - -

Public facing and editor script handles.

-

- JSON data type: array

+ 		+

Public facing and editor script handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit

view_script_handles - -

Public facing script handles.

-

- JSON data type: array

+ 		+

Public facing script handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit

editor_style_handles - -

Editor style handles.

-

- JSON data type: array

+ 		+

Editor style handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit

style_handles - -

Public facing and editor style handles.

-

- JSON data type: array

+ 		+

Public facing and editor style handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit

styles - -

Block style variations.

-

- JSON data type: array

+ 		+

Block style variations.

+

+ JSON data type: array

Read only

Context: embed, view, edit

variations - -

Block variations.

-

- JSON data type: array

+ 		+

Block variations.

+

+ JSON data type: array

Read only

Context: embed, view, edit

textdomain - -

Public text domain.

-

- JSON data type: string or null

+ 		+

Public text domain.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

parent - -

Parent blocks.

-

- JSON data type: array or null

+ 		+

Parent blocks.

+

+ JSON data type: array or null

Read only

Context: embed, view, edit

ancestor - -

Ancestor blocks.

-

- JSON data type: array or null

+ 		+

Ancestor blocks.

+

+ JSON data type: array or null

Read only

Context: embed, view, edit

keywords - -

Block keywords.

-

- JSON data type: array

+ 		+

Block keywords.

+

+ JSON data type: array

Read only

Context: embed, view, edit

example - -

Block example.

-

- JSON data type: object or null

+ 		+

Block example.

+

+ JSON data type: object or null

Read only

Context: embed, view, edit

editor_script - -

Editor script handle. DEPRECATED: Use `editor_script_handles` instead.

-

- JSON data type: string or null

+ 		+

Editor script handle. DEPRECATED: Use `editor_script_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

script - -

Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.

-

- JSON data type: string or null

+ 		+

Public facing and editor script handle. DEPRECATED: Use `script_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

view_script - -

Public facing script handle. DEPRECATED: Use `view_script_handles` instead.

-

- JSON data type: string or null

+ 		+

Public facing script handle. DEPRECATED: Use `view_script_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

editor_style - -

Editor style handle. DEPRECATED: Use `editor_style_handles` instead.

-

- JSON data type: string or null

+ 		+

Editor style handle. DEPRECATED: Use `editor_style_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

style - -

Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.

-

- JSON data type: string or null

+ 		+

Public facing and editor style handle. DEPRECATED: Use `style_handles` instead.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

date - -

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

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the post was published, as GMT.

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the post.

-

- JSON data type: integer

+ 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed

modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

modified_gmt - -

The date the post was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

slug - -

An alphanumeric identifier for the post unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
status - -

A named status for the post.

-

- JSON data type: string

+ 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private

type - -

Type of post.

-

- JSON data type: string

+ 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed

password - -

A password to protect access to the content and excerpt.

-

- JSON data type: string

+ 		+

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
content - -

The content for the post.

-

- JSON data type: object

+ 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
template - -

The theme file to use to display the post.

-

- JSON data type: string

+ 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
id - -

Unique identifier for the term.

-

- JSON data type: integer

+ 		+

Unique identifier for the term.

+

+ JSON data type: integer

Read only

Context: view, embed, edit

count - -

Number of published posts for the term.

-

- JSON data type: integer

+ 		+

Number of published posts for the term.

+

+ JSON data type: integer

Read only

Context: view, edit

description - -

HTML description of the term.

-

- JSON data type: string

+ 		+

HTML description of the term.

+

+ JSON data type: string

Context: view, edit
name - -

HTML title for the term.

-

- JSON data type: string

+ 		+

HTML title for the term.

+

+ JSON data type: string

Context: view, embed, edit
slug - -

An alphanumeric identifier for the term unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

Context: view, embed, edit
taxonomy - -

Type attribution for the term.

-

- JSON data type: string

+ 		+

Type attribution for the term.

+

+ JSON data type: string

Read only

Context: view, embed, edit

One of: category

@@ -95,22 +95,22 @@
parent - -

The parent term ID.

-

- JSON data type: integer

+ 		+

The parent term ID.

+

+ JSON data type: integer

Context: view, edit
meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
id - -

Unique identifier for the comment.

-

- JSON data type: integer

+ 		+

Unique identifier for the comment.

+

+ JSON data type: integer

Read only

Context: view, edit, embed

author - -

The ID of the user object, if author was a user.

-

- JSON data type: integer

+ 		+

The ID of the user object, if author was a user.

+

+ JSON data type: integer

Context: view, edit, embed
author_email - -

Email address for the comment author.

-

- JSON data type: string, - Format: email +

+

Email address for the comment author.

+

+ JSON data type: string, + Format: email

Context: edit

author_ip - -

IP address for the comment author.

-

- JSON data type: string, - Format: ip +

+

IP address for the comment author.

+

+ JSON data type: string, + Format: ip

Context: edit

author_name - -

Display name for the comment author.

-

- JSON data type: string

+ 		+

Display name for the comment author.

+

+ JSON data type: string

Context: view, edit, embed
author_url - -

URL for the comment author.

-

- JSON data type: string, - Format: uri -

+ 		+

URL for the comment author.

+

+ JSON data type: string, + Format: uri +

Context: view, edit, embed
author_user_agent - -

User agent for the comment author.

-

- JSON data type: string

+ 		+

User agent for the comment author.

+

+ JSON data type: string

Context: edit
content - -

The content for the comment.

-

- JSON data type: object

+ 		+

The content for the comment.

+

+ JSON data type: object

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the comment was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the comment was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the comment.

-

- JSON data type: integer

+ 		+

The ID for the parent of the comment.

+

+ JSON data type: integer

Context: view, edit, embed
post - -

The ID of the associated post object.

-

- JSON data type: integer

+ 		+

The ID of the associated post object.

+

+ JSON data type: integer

Context: view, edit
status - -

State of the comment.

-

- JSON data type: string

+ 		+

State of the comment.

+

+ JSON data type: string

Context: view, edit
type - -

Type of the comment.

-

- JSON data type: string

+ 		+

Type of the comment.

+

+ JSON data type: string

Read only

Context: view, edit, embed

author_avatar_urls - -

Avatar URLs for the comment author.

-

- JSON data type: object

+ 		+

Avatar URLs for the comment author.

+

+ JSON data type: object

Read only

Context: view, edit, embed

meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
date - -

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

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the post was published, as GMT.

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the post.

-

- JSON data type: integer

+ 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed

modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

modified_gmt - -

The date the post was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

slug - -

An alphanumeric identifier for the post unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
status - -

A named status for the post.

-

- JSON data type: string

+ 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private

type - -

Type of post.

-

- JSON data type: string

+ 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed

generated_slug - -

Slug automatically generated from the post title.

-

- JSON data type: string

+ 		+

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit

title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
author - -

The ID for the author of the post.

-

- JSON data type: integer

+ 		+

The ID for the author of the post.

+

+ JSON data type: integer

Context: view, edit, embed
comment_status - -

Whether or not comments are open on the post.

-

- JSON data type: string

+ 		+

Whether or not comments are open on the post.

+

+ JSON data type: string

Context: view, edit

One of: open, closed

ping_status - -

Whether or not the post can be pinged.

-

- JSON data type: string

+ 		+

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

One of: open, closed

meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
template - -

The theme file to use to display the post.

-

- JSON data type: string

+ 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
alt_text - -

Alternative text to display when attachment is not displayed.

-

- JSON data type: string

+ 		+

Alternative text to display when attachment is not displayed.

+

+ JSON data type: string

Context: view, edit, embed
caption - -

The attachment caption.

-

- JSON data type: object

+ 		+

The attachment caption.

+

+ JSON data type: object

Context: view, edit, embed
description - -

The attachment description.

-

- JSON data type: object

+ 		+

The attachment description.

+

+ JSON data type: object

Context: view, edit
media_type - -

Attachment type.

-

- JSON data type: string

+ 		+

Attachment type.

+

+ JSON data type: string

Read only

Context: view, edit, embed

One of: image, file

@@ -276,11 +276,11 @@
mime_type - -

The attachment MIME type.

-

- JSON data type: string

+ 		+

The attachment MIME type.

+

+ JSON data type: string

Read only

Context: view, edit, embed

media_details - -

Details about the media file, specific to its type.

-

- JSON data type: object

+ 		+

Details about the media file, specific to its type.

+

+ JSON data type: object

Read only

Context: view, edit, embed

post - -

The ID for the associated post of the attachment.

-

- JSON data type: integer

+ 		+

The ID for the associated post of the attachment.

+

+ JSON data type: integer

Context: view, edit
source_url - -

URL to the original attachment file.

-

- JSON data type: string, - Format: uri -

+ 		+

URL to the original attachment file.

+

+ JSON data type: string, + Format: uri +

Read only

Context: view, edit, embed

missing_image_sizes - -

List of the missing image sizes of the attachment.

-

- JSON data type: array

+ 		+

List of the missing image sizes of the attachment.

+

+ JSON data type: array

Read only

Context: edit

name - -

The name of the menu location.

-

- JSON data type: string

+ 		+

The name of the menu location.

+

+ JSON data type: string

Read only

Context: embed, view, edit

description - -

The description of the menu location.

-

- JSON data type: string

+ 		+

The description of the menu location.

+

+ JSON data type: string

Read only

Context: embed, view, edit

menu - -

The ID of the assigned menu.

-

- JSON data type: integer

+ 		+

The ID of the assigned menu.

+

+ JSON data type: integer

Read only

Context: embed, view, edit

author - -

The ID for the author of the revision.

-

- JSON data type: integer

+ 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the revision was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
guid - -

GUID for the revision, as it exists in the database.

-

- JSON data type: string

+ 		+

GUID for the revision, as it exists in the database.

+

+ JSON data type: string

Context: view, edit
id - -

Unique identifier for the revision.

-

- JSON data type: integer

+ 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
modified_gmt - -

The date the revision was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the revision.

-

- JSON data type: integer

+ 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
slug - -

An alphanumeric identifier for the revision unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
title - -

The title for the object.

-

- JSON data type: string or object

+ 		+

The title for the object.

+

+ JSON data type: string or object

Context: view, edit, embed
title - -

The title for the object.

-

- JSON data type: string or object

+ 		+

The title for the object.

+

+ JSON data type: string or object

Context: view, edit, embed
id - -

Unique identifier for the object.

-

- JSON data type: integer

+ 		+

Unique identifier for the object.

+

+ JSON data type: integer

Read only

Context: view, edit, embed

type_label - -

The singular label used to describe this type of menu item.

-

- JSON data type: string

+ 		+

The singular label used to describe this type of menu item.

+

+ JSON data type: string

Read only

Context: view, edit, embed

type - -

The family of objects originally represented, such as "post_type" or "taxonomy".

-

- JSON data type: string

+ 		+

The family of objects originally represented, such as "post_type" or "taxonomy".

+

+ JSON data type: string

Context: view, edit, embed

One of: taxonomy, post_type, post_type_archive, custom

status - -

A named status for the object.

-

- JSON data type: string

+ 		+

A named status for the object.

+

+ JSON data type: string

Context: view, edit, embed

One of: publish, future, draft, pending, private

parent - -

The ID for the parent of the object.

-

- JSON data type: integer

+ 		+

The ID for the parent of the object.

+

+ JSON data type: integer

Context: view, edit, embed
attr_title - -

Text for the title attribute of the link element for this menu item.

-

- JSON data type: string

+ 		+

Text for the title attribute of the link element for this menu item.

+

+ JSON data type: string

Context: view, edit, embed
classes - -

Class names for the link element of this menu item.

-

- JSON data type: array

+ 		+

Class names for the link element of this menu item.

+

+ JSON data type: array

Context: view, edit, embed
description - -

The description of this menu item.

-

- JSON data type: string

+ 		+

The description of this menu item.

+

+ JSON data type: string

Context: view, edit, embed
menu_order - -

The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.

-

- JSON data type: integer

+ 		+

The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0.

+

+ JSON data type: integer

Context: view, edit, embed
object - -

The type of object originally represented, such as "category", "post", or "attachment".

-

- JSON data type: string

+ 		+

The type of object originally represented, such as "category", "post", or "attachment".

+

+ JSON data type: string

Context: view, edit, embed
object_id - -

The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.

-

- JSON data type: integer

+ 		+

The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories.

+

+ JSON data type: integer

Context: view, edit, embed
target - -

The target attribute of the link element for this menu item.

-

- JSON data type: string

+ 		+

The target attribute of the link element for this menu item.

+

+ JSON data type: string

Context: view, edit, embed

One of: _blank,

url - -

The URL to which this menu item points.

-

- JSON data type: string, - Format: uri -

+ 		+

The URL to which this menu item points.

+

+ JSON data type: string, + Format: uri +

Context: view, edit, embed
xfn - -

The XFN relationship expressed in the link of this menu item.

-

- JSON data type: array

+ 		+

The XFN relationship expressed in the link of this menu item.

+

+ JSON data type: array

Context: view, edit, embed
invalid - -

Whether the menu item represents an object that no longer exists.

-

- JSON data type: boolean

+ 		+

Whether the menu item represents an object that no longer exists.

+

+ JSON data type: boolean

Read only

Context: view, edit, embed

menus - -

The terms assigned to the object in the nav_menu taxonomy.

-

- JSON data type: integer

+ 		+

The terms assigned to the object in the nav_menu taxonomy.

+

+ JSON data type: integer

Context: view, edit
meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
id - -

Unique identifier for the term.

-

- JSON data type: integer

+ 		+

Unique identifier for the term.

+

+ JSON data type: integer

Read only

Context: view, embed, edit

description - -

HTML description of the term.

-

- JSON data type: string

+ 		+

HTML description of the term.

+

+ JSON data type: string

Context: view, edit
name - -

HTML title for the term.

-

- JSON data type: string

+ 		+

HTML title for the term.

+

+ JSON data type: string

Context: view, embed, edit
slug - -

An alphanumeric identifier for the term unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

Context: view, embed, edit
meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
locations - -

The locations assigned to the menu.

-

- JSON data type: array

+ 		+

The locations assigned to the menu.

+

+ JSON data type: array

Context: view, edit
auto_add - -

Whether to automatically add top level pages to this menu.

-

- JSON data type: boolean

+ 		+

Whether to automatically add top level pages to this menu.

+

+ JSON data type: boolean

Context: view, edit
id - -

The unique identifier for the Navigation Menu.

-

- JSON data type: integer

+ 		+

The unique identifier for the Navigation Menu.

+

+ JSON data type: integer

Read only

Context: view, edit, embed

author - -

The ID for the author of the revision.

-

- JSON data type: integer

+ 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the revision was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the revision.

-

- JSON data type: integer

+ 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
modified_gmt - -

The date the revision was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the revision.

-

- JSON data type: integer

+ 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
slug - -

An alphanumeric identifier for the revision unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
content - -

The content for the post.

-

- JSON data type: object

+ 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
excerpt - -

The excerpt for the post.

-

- JSON data type: object

+ 		+

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
date - -

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

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the post was published, as GMT.

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the post.

-

- JSON data type: integer

+ 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed

modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

modified_gmt - -

The date the post was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

slug - -

An alphanumeric identifier for the post unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
status - -

A named status for the post.

-

- JSON data type: string

+ 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private

type - -

Type of post.

-

- JSON data type: string

+ 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed

password - -

A password to protect access to the content and excerpt.

-

- JSON data type: string

+ 		+

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
generated_slug - -

Slug automatically generated from the post title.

-

- JSON data type: string

+ 		+

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit

parent - -

The ID for the parent of the post.

-

- JSON data type: integer

+ 		+

The ID for the parent of the post.

+

+ JSON data type: integer

Context: view, edit
title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
content - -

The content for the post.

-

- JSON data type: object

+ 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
author - -

The ID for the author of the post.

-

- JSON data type: integer

+ 		+

The ID for the author of the post.

+

+ JSON data type: integer

Context: view, edit, embed
excerpt - -

The excerpt for the post.

-

- JSON data type: object

+ 		+

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
comment_status - -

Whether or not comments are open on the post.

-

- JSON data type: string

+ 		+

Whether or not comments are open on the post.

+

+ JSON data type: string

Context: view, edit

One of: open, closed

ping_status - -

Whether or not the post can be pinged.

-

- JSON data type: string

+ 		+

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

One of: open, closed

menu_order - -

The order of the post in relation to other posts.

-

- JSON data type: integer

+ 		+

The order of the post in relation to other posts.

+

+ JSON data type: integer

Context: view, edit
meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
template - -

The theme file to use to display the post.

-

- JSON data type: string

+ 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
id - -

The pattern ID.

-

- JSON data type: integer

+ 		+

The pattern ID.

+

+ JSON data type: integer

Context: view, edit, embed
title - -

The pattern title, in human readable format.

-

- JSON data type: string

+ 		+

The pattern title, in human readable format.

+

+ JSON data type: string

Context: view, edit, embed
content - -

The pattern content.

-

- JSON data type: string

+ 		+

The pattern content.

+

+ JSON data type: string

Context: view, edit, embed
categories - -

The pattern's category slugs.

-

- JSON data type: array

+ 		+

The pattern's category slugs.

+

+ JSON data type: array

Context: view, edit, embed
keywords - -

The pattern's keywords.

-

- JSON data type: array

+ 		+

The pattern's keywords.

+

+ JSON data type: array

Context: view, edit, embed
description - -

A description of the pattern.

-

- JSON data type: string

+ 		+

A description of the pattern.

+

+ JSON data type: string

Context: view, edit, embed
viewport_width - -

The preferred width of the viewport when previewing a pattern, in pixels.

-

- JSON data type: integer

+ 		+

The preferred width of the viewport when previewing a pattern, in pixels.

+

+ JSON data type: integer

Context: view, edit, embed
block_types - -

The block types which can use this pattern.

-

- JSON data type: array

+ 		+

The block types which can use this pattern.

+

+ JSON data type: array

Context: view, embed
plugin - -

The plugin file.

-

- JSON data type: string

+ 		+

The plugin file.

+

+ JSON data type: string

Read only

Context: view, edit, embed

status - -

The plugin activation status.

-

- JSON data type: string

+ 		+

The plugin activation status.

+

+ JSON data type: string

Context: view, edit, embed

One of: inactive, active

name - -

The plugin name.

-

- JSON data type: string

+ 		+

The plugin name.

+

+ JSON data type: string

Read only

Context: view, edit, embed

plugin_uri - -

The plugin's website address.

-

- JSON data type: string, - Format: uri -

+ 		+

The plugin's website address.

+

+ JSON data type: string, + Format: uri +

Read only

Context: view, edit

author - -

The plugin author.

-

- JSON data type: object

+ 		+

The plugin author.

+

+ JSON data type: object

Read only

Context: view, edit

author_uri - -

Plugin author's website address.

-

- JSON data type: string, - Format: uri -

+ 		+

Plugin author's website address.

+

+ JSON data type: string, + Format: uri +

Read only

Context: view, edit

description - -

The plugin description.

-

- JSON data type: object

+ 		+

The plugin description.

+

+ JSON data type: object

Read only

Context: view, edit

version - -

The plugin version number.

-

- JSON data type: string

+ 		+

The plugin version number.

+

+ JSON data type: string

Read only

Context: view, edit

network_only - -

Whether the plugin can only be activated network-wide.

-

- JSON data type: boolean

+ 		+

Whether the plugin can only be activated network-wide.

+

+ JSON data type: boolean

Read only

Context: view, edit, embed

requires_wp - -

Minimum required version of WordPress.

-

- JSON data type: string

+ 		+

Minimum required version of WordPress.

+

+ JSON data type: string

Read only

Context: view, edit, embed

requires_php - -

Minimum required version of PHP.

-

- JSON data type: string

+ 		+

Minimum required version of PHP.

+

+ JSON data type: string

Read only

Context: view, edit, embed

textdomain - -

The plugin's text domain.

-

- JSON data type: string

+ 		+

The plugin's text domain.

+

+ JSON data type: string

Read only

Context: view, edit

author - -

The ID for the author of the revision.

-

- JSON data type: integer

+ 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the revision was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the revision.

-

- JSON data type: integer

+ 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
modified_gmt - -

The date the revision was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the revision.

-

- JSON data type: integer

+ 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
slug - -

An alphanumeric identifier for the revision unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
content - -

The content for the post.

-

- JSON data type: object

+ 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
excerpt - -

The excerpt for the post.

-

- JSON data type: object

+ 		+

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
name - -

The title for the status.

-

- JSON data type: string

+ 		+

The title for the status.

+

+ JSON data type: string

Read only

Context: embed, view, edit

private - -

Whether posts with this status should be private.

-

- JSON data type: boolean

+ 		+

Whether posts with this status should be private.

+

+ JSON data type: boolean

Read only

Context: edit

protected - -

Whether posts with this status should be protected.

-

- JSON data type: boolean

+ 		+

Whether posts with this status should be protected.

+

+ JSON data type: boolean

Read only

Context: edit

public - -

Whether posts of this status should be shown in the front end of the site.

-

- JSON data type: boolean

+ 		+

Whether posts of this status should be shown in the front end of the site.

+

+ JSON data type: boolean

Read only

Context: view, edit

queryable - -

Whether posts with this status should be publicly-queryable.

-

- JSON data type: boolean

+ 		+

Whether posts with this status should be publicly-queryable.

+

+ JSON data type: boolean

Read only

Context: view, edit

show_in_list - -

Whether to include posts in the edit listing for their post type.

-

- JSON data type: boolean

+ 		+

Whether to include posts in the edit listing for their post type.

+

+ JSON data type: boolean

Read only

Context: edit

slug - -

An alphanumeric identifier for the status.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the status.

+

+ JSON data type: string

Read only

Context: embed, view, edit

date_floating - -

Whether posts of this status may have floating published dates.

-

- JSON data type: boolean

+ 		+

Whether posts of this status may have floating published dates.

+

+ JSON data type: boolean

Read only

Context: view, edit

capabilities - -

All capabilities used by the post type.

-

- JSON data type: object

+ 		+

All capabilities used by the post type.

+

+ JSON data type: object

Read only

Context: edit

description - -

A human-readable description of the post type.

-

- JSON data type: string

+ 		+

A human-readable description of the post type.

+

+ JSON data type: string

Read only

Context: view, edit

hierarchical - -

Whether or not the post type should have children.

-

- JSON data type: boolean

+ 		+

Whether or not the post type should have children.

+

+ JSON data type: boolean

Read only

Context: view, edit

viewable - -

Whether or not the post type can be viewed.

-

- JSON data type: boolean

+ 		+

Whether or not the post type can be viewed.

+

+ JSON data type: boolean

Read only

Context: edit

labels - -

Human-readable labels for the post type for various contexts.

-

- JSON data type: object

+ 		+

Human-readable labels for the post type for various contexts.

+

+ JSON data type: object

Read only

Context: edit

name - -

The title for the post type.

-

- JSON data type: string

+ 		+

The title for the post type.

+

+ JSON data type: string

Read only

Context: view, edit, embed

slug - -

An alphanumeric identifier for the post type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the post type.

+

+ JSON data type: string

Read only

Context: view, edit, embed

supports - -

All features, supported by the post type.

-

- JSON data type: object

+ 		+

All features, supported by the post type.

+

+ JSON data type: object

Read only

Context: edit

has_archive - -

If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.

-

- JSON data type: string or boolean

+ 		+

If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive.

+

+ JSON data type: string or boolean

Read only

Context: view, edit

taxonomies - -

Taxonomies associated with post type.

-

- JSON data type: array

+ 		+

Taxonomies associated with post type.

+

+ JSON data type: array

Read only

Context: view, edit

rest_base - -

REST base route for the post type.

-

- JSON data type: string

+ 		+

REST base route for the post type.

+

+ JSON data type: string

Read only

Context: view, edit, embed

rest_namespace - -

REST route's namespace for the post type.

-

- JSON data type: string

+ 		+

REST route's namespace for the post type.

+

+ JSON data type: string

Read only

Context: view, edit, embed

visibility - -

The visibility settings for the post type.

-

- JSON data type: object

+ 		+

The visibility settings for the post type.

+

+ JSON data type: object

Read only

Context: edit

icon - -

The icon for the post type.

-

- JSON data type: string or null

+ 		+

The icon for the post type.

+

+ JSON data type: string or null

Read only

Context: view, edit, embed

date - -

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

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the post was published, as GMT.

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the post.

-

- JSON data type: integer

+ 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed

modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

modified_gmt - -

The date the post was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

slug - -

An alphanumeric identifier for the post unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
status - -

A named status for the post.

-

- JSON data type: string

+ 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit

One of: publish, future, draft, pending, private

type - -

Type of post.

-

- JSON data type: string

+ 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed

password - -

A password to protect access to the content and excerpt.

-

- JSON data type: string

+ 		+

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
generated_slug - -

Slug automatically generated from the post title.

-

- JSON data type: string

+ 		+

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit

title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
content - -

The content for the post.

-

- JSON data type: object

+ 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit
author - -

The ID for the author of the post.

-

- JSON data type: integer

+ 		+

The ID for the author of the post.

+

+ JSON data type: integer

Context: view, edit, embed
excerpt - -

The excerpt for the post.

-

- JSON data type: object

+ 		+

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
comment_status - -

Whether or not comments are open on the post.

-

- JSON data type: string

+ 		+

Whether or not comments are open on the post.

+

+ JSON data type: string

Context: view, edit

One of: open, closed

ping_status - -

Whether or not the post can be pinged.

-

- JSON data type: string

+ 		+

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

One of: open, closed

format - -

The format for the post.

-

- JSON data type: string

+ 		+

The format for the post.

+

+ JSON data type: string

Context: view, edit

One of: standard, aside, chat, gallery, link, image, quote, status, video, audio

meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
sticky - -

Whether or not the post should be treated as sticky.

-

- JSON data type: boolean

+ 		+

Whether or not the post should be treated as sticky.

+

+ JSON data type: boolean

Context: view, edit
template - -

The theme file to use to display the post.

-

- JSON data type: string

+ 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
categories - -

The terms assigned to the post in the category taxonomy.

-

- JSON data type: array

+ 		+

The terms assigned to the post in the category taxonomy.

+

+ JSON data type: array

Context: view, edit
tags - -

The terms assigned to the post in the post_tag taxonomy.

-

- JSON data type: array

+ 		+

The terms assigned to the post in the post_tag taxonomy.

+

+ JSON data type: array

Context: view, edit
rendered - -

The rendered block.

-

- JSON data type: string

+ 		+

The rendered block.

+

+ JSON data type: string

Context: edit
id - -

Unique identifier for the object.

-

- JSON data type: integer or string

+ 		+

Unique identifier for the object.

+

+ JSON data type: integer or string

Read only

Context: view, embed

title - -

The title for the object.

-

- JSON data type: string

+ 		+

The title for the object.

+

+ JSON data type: string

Read only

Context: view, embed

url - -

URL to the object.

-

- JSON data type: string, - Format: uri -

+ 		+

URL to the object.

+

+ JSON data type: string, + Format: uri +

Read only

Context: view, embed

type - -

Object type.

-

- JSON data type: string

+ 		+

Object type.

+

+ JSON data type: string

Read only

Context: view, embed

One of: post, term, post-format

@@ -62,11 +62,11 @@
subtype - -

Object subtype.

-

- JSON data type: string

+ 		+

Object subtype.

+

+ JSON data type: string

Read only

Context: view, embed

One of: post, page, category, post_tag

diff --git a/reference/settings.md b/reference/settings.md index 8420eb3..834bdd1 100644 --- a/reference/settings.md +++ b/reference/settings.md @@ -11,47 +11,47 @@
title - -

Site title.

-

- JSON data type: string

+ 		+

Site title.

+

+ JSON data type: string

Context:

description - -

Site tagline.

-

- JSON data type: string

+ 		+

Site tagline.

+

+ JSON data type: string

Context:

url - -

Site URL.

-

- JSON data type: string, - Format: uri -

+ 		+

Site URL.

+

+ JSON data type: string, + Format: uri +

Context:

email - -

This address is used for admin purposes, like new user notification.

-

- JSON data type: string, - Format: email +

+

This address is used for admin purposes, like new user notification.

+

+ JSON data type: string, + Format: email

Context:

timezone - -

A city in the same timezone as you.

-

- JSON data type: string

+ 		+

A city in the same timezone as you.

+

+ JSON data type: string

Context:

date_format - -

A date format for all date strings.

-

- JSON data type: string

+ 		+

A date format for all date strings.

+

+ JSON data type: string

Context:

time_format - -

A time format for all time strings.

-

- JSON data type: string

+ 		+

A time format for all time strings.

+

+ JSON data type: string

Context:

start_of_week - -

A day number of the week that the week should start on.

-

- JSON data type: integer

+ 		+

A day number of the week that the week should start on.

+

+ JSON data type: integer

Context:

language - -

WordPress locale code.

-

- JSON data type: string

+ 		+

WordPress locale code.

+

+ JSON data type: string

Context:

use_smilies - -

Convert emoticons like :-) and :-P to graphics on display.

-

- JSON data type: boolean

+ 		+

Convert emoticons like :-) and :-P to graphics on display.

+

+ JSON data type: boolean

Context:

default_category - -

Default post category.

-

- JSON data type: integer

+ 		+

Default post category.

+

+ JSON data type: integer

Context:

default_post_format - -

Default post format.

-

- JSON data type: string

+ 		+

Default post format.

+

+ JSON data type: string

Context:

posts_per_page - -

Blog pages show at most.

-

- JSON data type: integer

+ 		+

Blog pages show at most.

+

+ JSON data type: integer

Context:

show_on_front - -

What to show on the front page

-

- JSON data type: string

+ 		+

What to show on the front page

+

+ JSON data type: string

Context:

page_on_front - -

The ID of the page that should be displayed on the front page

-

- JSON data type: integer

+ 		+

The ID of the page that should be displayed on the front page

+

+ JSON data type: integer

Context:

page_for_posts - -

The ID of the page that should display the latest posts

-

- JSON data type: integer

+ 		+

The ID of the page that should display the latest posts

+

+ JSON data type: integer

Context:

default_ping_status - -

Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.

-

- JSON data type: string

+ 		+

Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.

+

+ JSON data type: string

Context:

One of: open, closed

default_comment_status - -

Allow people to submit comments on new posts.

-

- JSON data type: string

+ 		+

Allow people to submit comments on new posts.

+

+ JSON data type: string

Context:

One of: open, closed

site_icon - -

Site icon.

-

- JSON data type: integer

+ 		+

Site icon.

+

+ JSON data type: integer

Context:

id - -

ID of sidebar.

-

- JSON data type: string

+ 		+

ID of sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit

name - -

Unique name identifying the sidebar.

-

- JSON data type: string

+ 		+

Unique name identifying the sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit

description - -

Description of sidebar.

-

- JSON data type: string

+ 		+

Description of sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit

class - -

Extra CSS class to assign to the sidebar in the Widgets interface.

-

- JSON data type: string

+ 		+

Extra CSS class to assign to the sidebar in the Widgets interface.

+

+ JSON data type: string

Read only

Context: embed, view, edit

before_widget - -

HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.

-

- JSON data type: string

+ 		+

HTML content to prepend to each widget's HTML output when assigned to this sidebar. Default is an opening list item element.

+

+ JSON data type: string

Read only

Context: embed, view, edit

after_widget - -

HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.

-

- JSON data type: string

+ 		+

HTML content to append to each widget's HTML output when assigned to this sidebar. Default is a closing list item element.

+

+ JSON data type: string

Read only

Context: embed, view, edit

before_title - -

HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.

-

- JSON data type: string

+ 		+

HTML content to prepend to the sidebar title when displayed. Default is an opening h2 element.

+

+ JSON data type: string

Read only

Context: embed, view, edit

after_title - -

HTML content to append to the sidebar title when displayed. Default is a closing h2 element.

-

- JSON data type: string

+ 		+

HTML content to append to the sidebar title when displayed. Default is a closing h2 element.

+

+ JSON data type: string

Read only

Context: embed, view, edit

status - -

Status of sidebar.

-

- JSON data type: string

+ 		+

Status of sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit

One of: active, inactive

@@ -120,11 +120,11 @@
widgets - -

Nested widgets.

-

- JSON data type: array

+ 		+

Nested widgets.

+

+ JSON data type: array

Context: embed, view, edit
id - -

Unique identifier for the term.

-

- JSON data type: integer

+ 		+

Unique identifier for the term.

+

+ JSON data type: integer

Read only

Context: view, embed, edit

count - -

Number of published posts for the term.

-

- JSON data type: integer

+ 		+

Number of published posts for the term.

+

+ JSON data type: integer

Read only

Context: view, edit

description - -

HTML description of the term.

-

- JSON data type: string

+ 		+

HTML description of the term.

+

+ JSON data type: string

Context: view, edit
name - -

HTML title for the term.

-

- JSON data type: string

+ 		+

HTML title for the term.

+

+ JSON data type: string

Context: view, embed, edit
slug - -

An alphanumeric identifier for the term unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

Context: view, embed, edit
taxonomy - -

Type attribution for the term.

-

- JSON data type: string

+ 		+

Type attribution for the term.

+

+ JSON data type: string

Read only

Context: view, embed, edit

One of: post_tag

@@ -95,11 +95,11 @@
meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
capabilities - -

All capabilities used by the taxonomy.

-

- JSON data type: object

+ 		+

All capabilities used by the taxonomy.

+

+ JSON data type: object

Read only

Context: edit

description - -

A human-readable description of the taxonomy.

-

- JSON data type: string

+ 		+

A human-readable description of the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit

hierarchical - -

Whether or not the taxonomy should have children.

-

- JSON data type: boolean

+ 		+

Whether or not the taxonomy should have children.

+

+ JSON data type: boolean

Read only

Context: view, edit

labels - -

Human-readable labels for the taxonomy for various contexts.

-

- JSON data type: object

+ 		+

Human-readable labels for the taxonomy for various contexts.

+

+ JSON data type: object

Read only

Context: edit

name - -

The title for the taxonomy.

-

- JSON data type: string

+ 		+

The title for the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit, embed

slug - -

An alphanumeric identifier for the taxonomy.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit, embed

show_cloud - -

Whether or not the term cloud should be displayed.

-

- JSON data type: boolean

+ 		+

Whether or not the term cloud should be displayed.

+

+ JSON data type: boolean

Read only

Context: edit

types - -

Types associated with the taxonomy.

-

- JSON data type: array

+ 		+

Types associated with the taxonomy.

+

+ JSON data type: array

Read only

Context: view, edit

rest_base - -

REST base route for the taxonomy.

-

- JSON data type: string

+ 		+

REST base route for the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit, embed

rest_namespace - -

REST namespace route for the taxonomy.

-

- JSON data type: string

+ 		+

REST namespace route for the taxonomy.

+

+ JSON data type: string

Read only

Context: view, edit, embed

visibility - -

The visibility settings for the taxonomy.

-

- JSON data type: object

+ 		+

The visibility settings for the taxonomy.

+

+ JSON data type: object

Read only

Context: edit

stylesheet - -

The theme's stylesheet. This uniquely identifies the theme.

-

- JSON data type: string

+ 		+

The theme's stylesheet. This uniquely identifies the theme.

+

+ JSON data type: string

Read only

Context:

template - -

The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's stylesheet.

-

- JSON data type: string

+ 		+

The theme's template. If this is a child theme, this refers to the parent theme, otherwise this is the same as the theme's stylesheet.

+

+ JSON data type: string

Read only

Context:

author - -

The theme author.

-

- JSON data type: object

+ 		+

The theme author.

+

+ JSON data type: object

Read only

Context:

author_uri - -

The website of the theme author.

-

- JSON data type: object

+ 		+

The website of the theme author.

+

+ JSON data type: object

Read only

Context:

description - -

A description of the theme.

-

- JSON data type: object

+ 		+

A description of the theme.

+

+ JSON data type: object

Read only

Context:

is_block_theme - -

Whether the theme is a block-based theme.

-

- JSON data type: boolean

+ 		+

Whether the theme is a block-based theme.

+

+ JSON data type: boolean

Read only

Context:

name - -

The name of the theme.

-

- JSON data type: object

+ 		+

The name of the theme.

+

+ JSON data type: object

Read only

Context:

requires_php - -

The minimum PHP version required for the theme to work.

-

- JSON data type: string

+ 		+

The minimum PHP version required for the theme to work.

+

+ JSON data type: string

Read only

Context:

requires_wp - -

The minimum WordPress version required for the theme to work.

-

- JSON data type: string

+ 		+

The minimum WordPress version required for the theme to work.

+

+ JSON data type: string

Read only

Context:

screenshot - -

The theme's screenshot URL.

-

- JSON data type: string, - Format: uri -

+ 		+

The theme's screenshot URL.

+

+ JSON data type: string, + Format: uri +

Read only

Context:

tags - -

Tags indicating styles and features of the theme.

-

- JSON data type: object

+ 		+

Tags indicating styles and features of the theme.

+

+ JSON data type: object

Read only

Context:

textdomain - -

The theme's text domain.

-

- JSON data type: string

+ 		+

The theme's text domain.

+

+ JSON data type: string

Read only

Context:

theme_supports - -

Features supported by this theme.

-

- JSON data type: object

+ 		+

Features supported by this theme.

+

+ JSON data type: object

Read only

Context:

theme_uri - -

The URI of the theme's webpage.

-

- JSON data type: object

+ 		+

The URI of the theme's webpage.

+

+ JSON data type: object

Read only

Context:

version - -

The theme's current version.

-

- JSON data type: string

+ 		+

The theme's current version.

+

+ JSON data type: string

Read only

Context:

status - -

A named status for the theme.

-

- JSON data type: string

+ 		+

A named status for the theme.

+

+ JSON data type: string

Context:

One of: inactive, active

id - -

Unique identifier for the user.

-

- JSON data type: integer

+ 		+

Unique identifier for the user.

+

+ JSON data type: integer

Read only

Context: embed, view, edit

username - -

Login name for the user.

-

- JSON data type: string

+ 		+

Login name for the user.

+

+ JSON data type: string

Context: edit
name - -

Display name for the user.

-

- JSON data type: string

+ 		+

Display name for the user.

+

+ JSON data type: string

Context: embed, view, edit
first_name - -

First name for the user.

-

- JSON data type: string

+ 		+

First name for the user.

+

+ JSON data type: string

Context: edit
last_name - -

Last name for the user.

-

- JSON data type: string

+ 		+

Last name for the user.

+

+ JSON data type: string

Context: edit
email - -

The email address for the user.

-

- JSON data type: string, - Format: email +

+

The email address for the user.

+

+ JSON data type: string, + Format: email

Context: edit

url - -

URL of the user.

-

- JSON data type: string, - Format: uri -

+ 		+

URL of the user.

+

+ JSON data type: string, + Format: uri +

Context: embed, view, edit
description - -

Description of the user.

-

- JSON data type: string

+ 		+

Description of the user.

+

+ JSON data type: string

Context: embed, view, edit
locale - -

Locale for the user.

-

- JSON data type: string

+ 		+

Locale for the user.

+

+ JSON data type: string

Context: edit

One of: , en_US

nickname - -

The nickname for the user.

-

- JSON data type: string

+ 		+

The nickname for the user.

+

+ JSON data type: string

Context: edit
slug - -

An alphanumeric identifier for the user.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the user.

+

+ JSON data type: string

Context: embed, view, edit
registered_date - -

Registration date for the user.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

Registration date for the user.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: edit

roles - -

Roles assigned to the user.

-

- JSON data type: array

+ 		+

Roles assigned to the user.

+

+ JSON data type: array

Context: edit
password - -

Password for the user (never included).

-

- JSON data type: string

+ 		+

Password for the user (never included).

+

+ JSON data type: string

Context:

capabilities - -

All capabilities assigned to the user.

-

- JSON data type: object

+ 		+

All capabilities assigned to the user.

+

+ JSON data type: object

Read only

Context: edit

extra_capabilities - -

Any extra capabilities assigned to the user.

-

- JSON data type: object

+ 		+

Any extra capabilities assigned to the user.

+

+ JSON data type: object

Read only

Context: edit

avatar_urls - -

Avatar URLs for the user.

-

- JSON data type: object

+ 		+

Avatar URLs for the user.

+

+ JSON data type: object

Read only

Context: embed, view, edit

meta - -

Meta fields.

-

- JSON data type: object

+ 		+

Meta fields.

+

+ JSON data type: object

Context: view, edit
id - -

Unique slug identifying the widget type.

-

- JSON data type: string

+ 		+

Unique slug identifying the widget type.

+

+ JSON data type: string

Read only

Context: embed, view, edit

name - -

Human-readable name identifying the widget type.

-

- JSON data type: string

+ 		+

Human-readable name identifying the widget type.

+

+ JSON data type: string

Read only

Context: embed, view, edit

description - -

Description of the widget.

-

- JSON data type: string

+ 		+

Description of the widget.

+

+ JSON data type: string

Context: view, edit, embed
is_multi - -

Whether the widget supports multiple instances

-

- JSON data type: boolean

+ 		+

Whether the widget supports multiple instances

+

+ JSON data type: boolean

Read only

Context: view, edit, embed

classname - -

Class name

-

- JSON data type: string

+ 		+

Class name

+

+ JSON data type: string

Read only

Context: embed, view, edit

id - -

Unique identifier for the widget.

-

- JSON data type: string

+ 		+

Unique identifier for the widget.

+

+ JSON data type: string

Context: view, edit, embed
id_base - -

The type of the widget. Corresponds to ID in widget-types endpoint.

-

- JSON data type: string

+ 		+

The type of the widget. Corresponds to ID in widget-types endpoint.

+

+ JSON data type: string

Context: view, edit, embed
sidebar - -

The sidebar the widget belongs to.

-

- JSON data type: string

+ 		+

The sidebar the widget belongs to.

+

+ JSON data type: string

Context: view, edit, embed
rendered - -

HTML representation of the widget.

-

- JSON data type: string

+ 		+

HTML representation of the widget.

+

+ JSON data type: string

Read only

Context: view, edit, embed

rendered_form - -

HTML representation of the widget admin form.

-

- JSON data type: string

+ 		+

HTML representation of the widget admin form.

+

+ JSON data type: string

Read only

Context: edit

instance - -

Instance settings of the widget, if supported.

-

- JSON data type: object

+ 		+

Instance settings of the widget, if supported.

+

+ JSON data type: object

Context: edit
form_data - -

URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.

-

- JSON data type: string

+ 		+

URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only.

+

+ JSON data type: string

Context:

test - -

The name of the test being run.

-

- JSON data type: string

+ 		+

The name of the test being run.

+

+ JSON data type: string

Read only

Context:

label - -

A label describing the test.

-

- JSON data type: string

+ 		+

A label describing the test.

+

+ JSON data type: string

Read only

Context:

status - -

The status of the test.

-

- JSON data type: string

+ 		+

The status of the test.

+

+ JSON data type: string

Read only

Context:

One of: good, recommended, critical

@@ -48,11 +48,11 @@
badge - -

The category this test is grouped in.

-

- JSON data type: object

+ 		+

The category this test is grouped in.

+

+ JSON data type: object

Read only

Context:

description - -

A more descriptive explanation of what the test looks for, and why it is important for the user.

-

- JSON data type: string

+ 		+

A more descriptive explanation of what the test looks for, and why it is important for the user.

+

+ JSON data type: string

Read only

Context:

actions - -

HTML containing an action to direct the user to where they can resolve the issue.

-

- JSON data type: string

+ 		+

HTML containing an action to direct the user to where they can resolve the issue.

+

+ JSON data type: string

Read only

Context:

author - -

The ID for the author of the revision.

-

- JSON data type: integer

+ 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the revision was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
id - -

Unique identifier for the revision.

-

- JSON data type: integer

+ 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
modified_gmt - -

The date the revision was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the revision.

-

- JSON data type: integer

+ 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
styles - -

Global styles.

-

- JSON data type: object

+ 		+

Global styles.

+

+ JSON data type: object

Context: view, edit
settings - -

Global settings.

-

- JSON data type: object

+ 		+

Global settings.

+

+ JSON data type: object

Context: view, edit
id - -

ID of global styles config.

-

- JSON data type: string

+ 		+

ID of global styles config.

+

+ JSON data type: string

Read only

Context: embed, view, edit

styles - -

Global styles.

-

- JSON data type: object

+ 		+

Global styles.

+

+ JSON data type: object

Context: view, edit
settings - -

Global settings.

-

- JSON data type: object

+ 		+

Global settings.

+

+ JSON data type: object

Context: view, edit
title - -

Title of the global styles variation.

-

- JSON data type: object or string

+ 		+

Title of the global styles variation.

+

+ JSON data type: object or string

Context: embed, view, edit
author - -

The ID for the author of the revision.

-

- JSON data type: integer

+ 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the revision was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the revision.

-

- JSON data type: integer

+ 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
modified_gmt - -

The date the revision was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the revision.

-

- JSON data type: integer

+ 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
slug - -

An alphanumeric identifier for the revision unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
content - -

The content for the post.

-

- JSON data type: object

+ 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit, embed
date - -

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

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the post was published, as GMT.

-

- JSON data type: string or null, - Format: datetime (details) -

+ 		+

The date the post was published, as GMT.

+

+ JSON data type: string or null, + Format: datetime (details) +

Context: view, edit
guid - -

The globally unique identifier for the post.

-

- JSON data type: object

+ 		+

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

Context: view, edit

id - -

Unique identifier for the post.

-

- JSON data type: integer

+ 		+

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed

modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

modified_gmt - -

The date the post was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the post was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

slug - -

An alphanumeric identifier for the post unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
status - -

A named status for the post.

-

- JSON data type: string

+ 		+

A named status for the post.

+

+ JSON data type: string

Context: view, edit, embed

One of: publish, future, draft, pending, private

type - -

Type of post.

-

- JSON data type: string

+ 		+

Type of post.

+

+ JSON data type: string

Read only

Context: view, edit, embed

password - -

A password to protect access to the content and excerpt.

-

- JSON data type: string

+ 		+

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
title - -

The title for the post.

-

- JSON data type: object

+ 		+

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
content - -

The content for the post.

-

- JSON data type: object

+ 		+

The content for the post.

+

+ JSON data type: object

Context: view, edit, embed
template - -

The theme file to use to display the post.

-

- JSON data type: string

+ 		+

The theme file to use to display the post.

+

+ JSON data type: string

Context: view, edit
author - -

The ID for the author of the revision.

-

- JSON data type: integer

+ 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the revision was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
guid - -

GUID for the revision, as it exists in the database.

-

- JSON data type: string

+ 		+

GUID for the revision, as it exists in the database.

+

+ JSON data type: string

Context: view, edit
id - -

Unique identifier for the revision.

-

- JSON data type: integer

+ 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
modified_gmt - -

The date the revision was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the revision.

-

- JSON data type: integer

+ 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
slug - -

An alphanumeric identifier for the revision unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
title - -

Title of template.

-

- JSON data type: object or string

+ 		+

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
content - -

Content of template.

-

- JSON data type: object or string

+ 		+

Content of template.

+

+ JSON data type: object or string

Context: embed, view, edit
author - -

The ID for the author of the revision.

-

- JSON data type: integer

+ 		+

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
date - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit, embed
date_gmt - -

The date the revision was published, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was published, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
guid - -

GUID for the revision, as it exists in the database.

-

- JSON data type: string

+ 		+

GUID for the revision, as it exists in the database.

+

+ JSON data type: string

Context: view, edit
id - -

Unique identifier for the revision.

-

- JSON data type: integer

+ 		+

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
modified_gmt - -

The date the revision was last modified, as GMT.

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

The date the revision was last modified, as GMT.

+

+ JSON data type: string, + Format: datetime (details) +

Context: view, edit
parent - -

The ID for the parent of the revision.

-

- JSON data type: integer

+ 		+

The ID for the parent of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
slug - -

An alphanumeric identifier for the revision unique to its type.

-

- JSON data type: string

+ 		+

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
title - -

Title of template.

-

- JSON data type: object or string

+ 		+

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
content - -

Content of template.

-

- JSON data type: object or string

+ 		+

Content of template.

+

+ JSON data type: object or string

Context: embed, view, edit
id - -

ID of template.

-

- JSON data type: string

+ 		+

ID of template.

+

+ JSON data type: string

Read only

Context: embed, view, edit

slug - -

Unique slug identifying the template.

-

- JSON data type: string

+ 		+

Unique slug identifying the template.

+

+ JSON data type: string

Context: embed, view, edit
theme - -

Theme identifier for the template.

-

- JSON data type: string

+ 		+

Theme identifier for the template.

+

+ JSON data type: string

Context: embed, view, edit
type - -

Type of template.

-

- JSON data type: string

+ 		+

Type of template.

+

+ JSON data type: string

Context: embed, view, edit
source - -

Source of template

-

- JSON data type: string

+ 		+

Source of template

+

+ JSON data type: string

Read only

Context: embed, view, edit

origin - -

Source of a customized template

-

- JSON data type: string

+ 		+

Source of a customized template

+

+ JSON data type: string

Read only

Context: embed, view, edit

content - -

Content of template.

-

- JSON data type: object or string

+ 		+

Content of template.

+

+ JSON data type: object or string

Context: embed, view, edit
title - -

Title of template.

-

- JSON data type: object or string

+ 		+

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
description - -

Description of template.

-

- JSON data type: string

+ 		+

Description of template.

+

+ JSON data type: string

Context: embed, view, edit
status - -

Status of template.

-

- JSON data type: string

+ 		+

Status of template.

+

+ JSON data type: string

Context: embed, view, edit

One of: publish, future, draft, pending, private

wp_id - -

Post ID.

-

- JSON data type: integer

+ 		+

Post ID.

+

+ JSON data type: integer

Read only

Context: embed, view, edit

has_theme_file - -

Theme file exists.

-

- JSON data type: bool

+ 		+

Theme file exists.

+

+ JSON data type: bool

Read only

Context: embed, view, edit

author - -

The ID for the author of the template.

-

- JSON data type: integer

+ 		+

The ID for the author of the template.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

area - -

Where the template part is intended for use (header, footer, etc.)

-

- JSON data type: string

+ 		+

Where the template part is intended for use (header, footer, etc.)

+

+ JSON data type: string

Context: embed, view, edit
id - -

ID of template.

-

- JSON data type: string

+ 		+

ID of template.

+

+ JSON data type: string

Read only

Context: embed, view, edit

slug - -

Unique slug identifying the template.

-

- JSON data type: string

+ 		+

Unique slug identifying the template.

+

+ JSON data type: string

Context: embed, view, edit
theme - -

Theme identifier for the template.

-

- JSON data type: string

+ 		+

Theme identifier for the template.

+

+ JSON data type: string

Context: embed, view, edit
type - -

Type of template.

-

- JSON data type: string

+ 		+

Type of template.

+

+ JSON data type: string

Context: embed, view, edit
source - -

Source of template

-

- JSON data type: string

+ 		+

Source of template

+

+ JSON data type: string

Read only

Context: embed, view, edit

origin - -

Source of a customized template

-

- JSON data type: string

+ 		+

Source of a customized template

+

+ JSON data type: string

Read only

Context: embed, view, edit

content - -

Content of template.

-

- JSON data type: object or string

+ 		+

Content of template.

+

+ JSON data type: object or string

Context: embed, view, edit
title - -

Title of template.

-

- JSON data type: object or string

+ 		+

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
description - -

Description of template.

-

- JSON data type: string

+ 		+

Description of template.

+

+ JSON data type: string

Context: embed, view, edit
status - -

Status of template.

-

- JSON data type: string

+ 		+

Status of template.

+

+ JSON data type: string

Context: embed, view, edit

One of: publish, future, draft, pending, private

wp_id - -

Post ID.

-

- JSON data type: integer

+ 		+

Post ID.

+

+ JSON data type: integer

Read only

Context: embed, view, edit

has_theme_file - -

Theme file exists.

-

- JSON data type: bool

+ 		+

Theme file exists.

+

+ JSON data type: bool

Read only

Context: embed, view, edit

author - -

The ID for the author of the template.

-

- JSON data type: integer

+ 		+

The ID for the author of the template.

+

+ JSON data type: integer

Context: view, edit, embed
modified - -

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

-

- JSON data type: string, - Format: datetime (details) -

+ 		+

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

+

+ JSON data type: string, + Format: datetime (details) +

Read only

Context: view, edit

is_custom - -

Whether a template is a custom template.

-

- JSON data type: bool

+ 		+

Whether a template is a custom template.

+

+ JSON data type: bool

Read only

Context: embed, view, edit