diff --git a/bin/templates/reference-parts/schema.html b/bin/templates/reference-parts/schema.html index 32e8586..f0dbcfe 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 %}, - {% if property.format == 'date-time' %} - datetime (details) - {% elseif property.format == 'uri' %} - uri - {% else %} - {{ property.format }} - {% endif %}{% endif %} - + {{ 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 }} + {% endif %}{% endif %} +

{% if property.readonly %}

Read only

{% endif %} diff --git a/reference/application-passwords.md b/reference/application-passwords.md index 98939d5..c9d0660 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..89bebe8 100644 --- a/reference/block-directory-items.md +++ b/reference/block-directory-items.md @@ -10,148 +10,148 @@
- uuid
- - string, - uuid - + uuid

The unique identifier for the application password.

+

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

Read only

Context: view, edit, embed
- app_id
- - string, - uuid - + 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 + name

The name of the application password.

+

+ JSON data type: string

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

The generated password. Only available after adding an application.

+

+ JSON data type: string

Read only

Context: edit
- created
- - string, - datetime (details) - + 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) - + 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 - + 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..6d38a6b 100644 --- a/reference/block-pattern-categories.md +++ b/reference/block-pattern-categories.md @@ -10,36 +10,36 @@
- name
- - string + name

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

+

+ JSON data type: string

Context: view
- title
- - string + title

The block title, in human readable format.

+

+ JSON data type: string

Context: view
- description
- - string + description

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

+

+ JSON data type: string

Context: view
- id
- - string + id

The block slug.

+

+ JSON data type: string

Context: view
- rating
- - number + rating

The star rating of the block.

+

+ JSON data type: number

Context: view
- rating_count
- - integer + rating_count

The number of ratings.

+

+ JSON data type: integer

Context: view
- active_installs
- - integer + active_installs

The number sites that have activated this block.

+

+ JSON data type: integer

Context: view
- author_block_rating
- - number + author_block_rating

The average rating of blocks published by the same author.

+

+ JSON data type: number

Context: view
- author_block_count
- - integer + author_block_count

The number of blocks published by the same author.

+

+ JSON data type: integer

Context: view
- author
- - string + author

The WordPress.org username of the block author.

+

+ JSON data type: string

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

The block icon.

+

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

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

The date when the block was last updated.

+

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

Context: view
- humanized_updated
- - string + 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..295c080 100644 --- a/reference/block-patterns.md +++ b/reference/block-patterns.md @@ -10,136 +10,149 @@
- name
- - string + name

The category name.

+

+ JSON data type: string

Read only

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

The category label, in human readable format.

+

+ JSON data type: string

Read only

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

The category description, in human readable format.

+

+ JSON data type: string

Read only

Context: view, edit, embed

+ + + +
- name
- - string + name

The pattern name.

+

+ JSON data type: string

Read only

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

The pattern title, in human readable format.

+

+ JSON data type: string

Read only

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

The pattern content.

+

+ JSON data type: string

Read only

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

The pattern detailed description.

+

+ JSON data type: string

Read only

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

The pattern viewport width for inserter preview.

+

+ JSON data type: number

Read only

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

Determines whether the pattern is visible in inserter.

+

+ JSON data type: boolean

Read only

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

The pattern category slugs.

+

+ JSON data type: array

Read only

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

The pattern keywords.

+

+ JSON data type: array

Read only

Context: view, edit, embed
- block_types
- - array + 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 + 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 + 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..56bdd20 100644 --- a/reference/block-revisions.md +++ b/reference/block-revisions.md @@ -10,131 +10,131 @@ @@ -455,6 +455,14 @@ + + + +
- author
- - integer + author

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - + 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) - + date_gmt

The date the revision was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + modified_gmt

The date the revision was last modified, as GMT.

+

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

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

The ID for the parent of the revision.

+

+ JSON data type: integer

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

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

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

The title for the post.

+

+ JSON data type: object

Context: view, edit, embed
- content
- - object + 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..e2bbcad 100644 --- a/reference/block-types.md +++ b/reference/block-types.md @@ -10,336 +10,348 @@ + + + + diff --git a/reference/blocks.md b/reference/blocks.md index 7fbb2e2..df2e0d8 100644 --- a/reference/blocks.md +++ b/reference/blocks.md @@ -10,172 +10,183 @@
- api_version
- - integer + api_version

Version of block API.

+

+ JSON data type: integer

Read only

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

Title of block type.

+

+ JSON data type: string

Read only

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

Unique name identifying the block type.

+

+ JSON data type: string

Read only

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

Description of block type.

+

+ JSON data type: string

Read only

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

Icon of block type.

+

+ JSON data type: string or null

Read only

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

Block attributes.

+

+ JSON data type: object or null

Read only

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

Context provided by blocks of this type.

+

+ JSON data type: object

Read only

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

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

Read only

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

Block supports.

+

+ JSON data type: object

Read only

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

Block category.

+

+ JSON data type: string or null

Read only

Context: embed, view, edit
- is_dynamic
- - boolean + 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.

+

+ JSON data type: array

Read only

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

Public facing and editor script handles.

+

+ JSON data type: array

Read only

Context: embed, view, edit
- view_script_handles
- - array + 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.

+

+ JSON data type: array

Read only

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

Public facing and editor style handles.

+

+ JSON data type: array

Read only

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

Block style variations.

+

+ JSON data type: array

Read only

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

Block variations.

+

+ JSON data type: array

Read only

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

Public text domain.

+

+ JSON data type: string or null

Read only

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

Parent blocks.

+

+ JSON data type: array or null

Read only

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

Ancestor blocks.

+

+ JSON data type: array or null

Read only

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

Block keywords.

+

+ JSON data type: array

Read only

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

Block example.

+

+ JSON data type: object or null

Read only

Context: embed, view, edit
- editor_script
- - string or null + 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 + 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 + 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

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 + style

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

+

+ JSON data type: string or null

Read only

Context: embed, view, edit

+ + + + @@ -414,6 +425,14 @@ + + + + + + + +
- date
- - string or null, - datetime (details) - + 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) - + date_gmt

The date the post was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + 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 + slug

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

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

A named status for the post.

+

+ JSON data type: string

Context: view, edit

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

Type of post.

+

+ JSON data type: string

Read only

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

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
- title
- - object + title

The title for the post.

+

+ JSON data type: object

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

The content for the post.

+

+ JSON data type: object

+

Context: view, edit

+
+ meta + +

Meta fields.

+

+ JSON data type: object

Context: view, edit
- template
- - string + 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..7779760 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..eb6b541 100644 --- a/reference/comments.md +++ b/reference/comments.md @@ -10,204 +10,204 @@
- id
- - integer + id

Unique identifier for the term.

+

+ JSON data type: integer

Read only

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

Number of published posts for the term.

+

+ JSON data type: integer

Read only

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

HTML description of the term.

+

+ JSON data type: string

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

HTML title for the term.

+

+ JSON data type: string

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

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

Context: view, embed, edit
- taxonomy
- - string + 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 + parent

The parent term ID.

+

+ JSON data type: integer

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

Meta fields.

+

+ JSON data type: object

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

Unique identifier for the comment.

+

+ JSON data type: integer

Read only

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

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

+

+ JSON data type: integer

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

Email address for the comment author.

+

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

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

IP address for the comment author.

+

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

Context: edit
- author_name
- - string + author_name

Display name for the comment author.

+

+ JSON data type: string

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

URL for the comment author.

+

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

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

User agent for the comment author.

+

+ JSON data type: string

Context: edit
- content
- - object + content

The content for the comment.

+

+ JSON data type: object

Context: view, edit, embed
- date
- - string, - datetime (details) - + 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) - + date_gmt

The date the comment was published, as GMT.

+

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

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

The ID for the parent of the comment.

+

+ JSON data type: integer

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

The ID of the associated post object.

+

+ JSON data type: integer

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

State of the comment.

+

+ JSON data type: string

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

Type of the comment.

+

+ JSON data type: string

Read only

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

Avatar URLs for the comment author.

+

+ JSON data type: object

Read only

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

Meta fields.

+

+ JSON data type: object

Context: view, edit
diff --git a/reference/menu-locations.md b/reference/menu-locations.md index 9abd5af..97943d1 100644 --- a/reference/menu-locations.md +++ b/reference/menu-locations.md @@ -10,36 +10,36 @@
- date
- - string or null, - datetime (details) - + 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) - + date_gmt

The date the post was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + 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 + slug

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

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

A named status for the post.

+

+ JSON data type: string

Context: view, edit

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

Type of post.

+

+ JSON data type: string

Read only

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

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit
- title
- - object + title

The title for the post.

+

+ JSON data type: object

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

The ID for the author of the post.

+

+ JSON data type: integer

Context: view, edit, embed
- comment_status
- - string + 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 + ping_status

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

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

Meta fields.

+

+ JSON data type: object

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

The theme file to use to display the post.

+

+ JSON data type: string

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

Alternative text to display when attachment is not displayed.

+

+ JSON data type: string

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

The attachment caption.

+

+ JSON data type: object

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

The attachment description.

+

+ JSON data type: object

Context: view, edit
- media_type
- - string + 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 + mime_type

The attachment MIME type.

+

+ JSON data type: string

Read only

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

Details about the media file, specific to its type.

+

+ JSON data type: object

Read only

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

The ID for the associated post of the attachment.

+

+ JSON data type: integer

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

URL to the original attachment file.

+

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

Read only

Context: view, edit, embed
- missing_image_sizes
- - array + 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..dcc87db 100644 --- a/reference/nav_menu_item-revisions.md +++ b/reference/nav_menu_item-revisions.md @@ -10,132 +10,132 @@
- name
- - string + name

The name of the menu location.

+

+ JSON data type: string

Read only

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

The description of the menu location.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- menu
- - integer + 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..25e5d18 100644 --- a/reference/nav_menu_items.md +++ b/reference/nav_menu_items.md @@ -10,207 +10,207 @@
- author
- - integer + author

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - + 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) - + date_gmt

The date the revision was published, as GMT.

+

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

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

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

+

+ JSON data type: string

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

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + modified_gmt

The date the revision was last modified, as GMT.

+

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

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

The ID for the parent of the revision.

+

+ JSON data type: integer

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

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

Context: view, edit, embed
- title
- - string or 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..90beb23 100644 --- a/reference/nav_menus.md +++ b/reference/nav_menus.md @@ -10,79 +10,79 @@
- title
- - string or object + title

The title for the object.

+

+ JSON data type: string or object

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

Unique identifier for the object.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- type_label
- - string + 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 + 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 + status

A named status for the object.

+

+ JSON data type: string

Context: view, edit, embed

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

The ID for the parent of the object.

+

+ JSON data type: integer

Context: view, edit, embed
- attr_title
- - string + 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 + classes

Class names for the link element of this menu item.

+

+ JSON data type: array

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

The description of this menu item.

+

+ JSON data type: string

Context: view, edit, embed
- menu_order
- - integer + 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 + object

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

+

+ JSON data type: string

Context: view, edit, embed
- object_id
- - integer + 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 + 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 - + url

The URL to which this menu item points.

+

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

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

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

+

+ JSON data type: array

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

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

+

+ JSON data type: boolean

Read only

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

The terms assigned to the object in the nav_menu taxonomy.

+

+ JSON data type: integer

Context: view, edit
- meta
- - object + 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..62fc004 --- /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 + id

Unique identifier for the term.

+

+ JSON data type: integer

Read only

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

HTML description of the term.

+

+ JSON data type: string

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

HTML title for the term.

+

+ JSON data type: string

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

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

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

Meta fields.

+

+ JSON data type: object

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

The locations assigned to the menu.

+

+ JSON data type: array

Context: view, edit
- auto_add
- - boolean + 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..9f45333 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..0215628 100644 --- a/reference/pages.md +++ b/reference/pages.md @@ -10,286 +10,286 @@
- author
- - integer + author

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - + 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) - + date_gmt

The date the revision was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + modified_gmt

The date the revision was last modified, as GMT.

+

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

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

The ID for the parent of the revision.

+

+ JSON data type: integer

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

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

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

The title for the post.

+

+ JSON data type: object

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

The content for the post.

+

+ JSON data type: object

Context: view, edit
- excerpt
- - object + 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..7ddec50 100644 --- a/reference/pattern-directory-items.md +++ b/reference/pattern-directory-items.md @@ -10,89 +10,89 @@
- date
- - string or null, - datetime (details) - + 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) - + date_gmt

The date the post was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + 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 + slug

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

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

A named status for the post.

+

+ JSON data type: string

Context: view, edit

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

Type of post.

+

+ JSON data type: string

Read only

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

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
- generated_slug
- - string + generated_slug

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit
- parent
- - integer + parent

The ID for the parent of the post.

+

+ JSON data type: integer

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

The title for the post.

+

+ JSON data type: object

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

The content for the post.

+

+ JSON data type: object

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

The ID for the author of the post.

+

+ JSON data type: integer

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

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
- comment_status
- - string + 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 + ping_status

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

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

The order of the post in relation to other posts.

+

+ JSON data type: integer

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

Meta fields.

+

+ JSON data type: object

Context: view, edit
- template
- - string + 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..fa4aca0 100644 --- a/reference/plugins.md +++ b/reference/plugins.md @@ -10,148 +10,148 @@
- id
- - integer + id

The pattern ID.

+

+ JSON data type: integer

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

The pattern title, in human readable format.

+

+ JSON data type: string

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

The pattern content.

+

+ JSON data type: string

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

The pattern's category slugs.

+

+ JSON data type: array

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

The pattern's keywords.

+

+ JSON data type: array

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

A description of the pattern.

+

+ JSON data type: string

Context: view, edit, embed
- viewport_width
- - integer + 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 + 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..054f4ed 100644 --- a/reference/post-revisions.md +++ b/reference/post-revisions.md @@ -10,142 +10,142 @@
- plugin
- - string + plugin

The plugin file.

+

+ JSON data type: string

Read only

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

The plugin activation status.

+

+ JSON data type: string

Context: view, edit, embed

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

The plugin name.

+

+ JSON data type: string

Read only

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

The plugin's website address.

+

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

Read only

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

The plugin author.

+

+ JSON data type: object

Read only

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

Plugin author's website address.

+

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

Read only

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

The plugin description.

+

+ JSON data type: object

Read only

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

The plugin version number.

+

+ JSON data type: string

Read only

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

Whether the plugin can only be activated network-wide.

+

+ JSON data type: boolean

Read only

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

Minimum required version of WordPress.

+

+ JSON data type: string

Read only

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

Minimum required version of PHP.

+

+ JSON data type: string

Read only

Context: view, edit, embed
- textdomain
- - string + 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..000e27b 100644 --- a/reference/post-statuses.md +++ b/reference/post-statuses.md @@ -10,96 +10,96 @@
- author
- - integer + author

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - + 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) - + date_gmt

The date the revision was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + modified_gmt

The date the revision was last modified, as GMT.

+

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

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

The ID for the parent of the revision.

+

+ JSON data type: integer

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

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

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

The title for the post.

+

+ JSON data type: object

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

The content for the post.

+

+ JSON data type: object

Context: view, edit
- excerpt
- - object + 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..dd9dedb 100644 --- a/reference/post-types.md +++ b/reference/post-types.md @@ -10,168 +10,168 @@
- name
- - string + name

The title for the status.

+

+ JSON data type: string

Read only

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

Whether posts with this status should be private.

+

+ JSON data type: boolean

Read only

Context: edit
- protected
- - boolean + protected

Whether posts with this status should be protected.

+

+ JSON data type: boolean

Read only

Context: edit
- public
- - boolean + 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 + queryable

Whether posts with this status should be publicly-queryable.

+

+ JSON data type: boolean

Read only

Context: view, edit
- show_in_list
- - boolean + 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 + slug

An alphanumeric identifier for the status.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- date_floating
- - boolean + 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..42f840d 100644 --- a/reference/posts.md +++ b/reference/posts.md @@ -10,309 +10,309 @@
- capabilities
- - object + capabilities

All capabilities used by the post type.

+

+ JSON data type: object

Read only

Context: edit
- description
- - string + description

A human-readable description of the post type.

+

+ JSON data type: string

Read only

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

Whether or not the post type should have children.

+

+ JSON data type: boolean

Read only

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

Whether or not the post type can be viewed.

+

+ JSON data type: boolean

Read only

Context: edit
- labels
- - object + labels

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

+

+ JSON data type: object

Read only

Context: edit
- name
- - string + name

The title for the post type.

+

+ JSON data type: string

Read only

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

An alphanumeric identifier for the post type.

+

+ JSON data type: string

Read only

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

All features, supported by the post type.

+

+ JSON data type: object

Read only

Context: edit
- has_archive
- - string or boolean + 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

Taxonomies associated with post type.

+

+ JSON data type: array

Read only

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

REST base route for the post type.

+

+ JSON data type: string

Read only

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

REST route's namespace for the post type.

+

+ JSON data type: string

Read only

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

The visibility settings for the post type.

+

+ JSON data type: object

Read only

Context: edit
- icon
- - string or null + 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..1e466a5 100644 --- a/reference/rendered-blocks.md +++ b/reference/rendered-blocks.md @@ -10,12 +10,12 @@
- date
- - string or null, - datetime (details) - + 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) - + date_gmt

The date the post was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + 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 + slug

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

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

A named status for the post.

+

+ JSON data type: string

Context: view, edit

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

Type of post.

+

+ JSON data type: string

Read only

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

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
- generated_slug
- - string + generated_slug

Slug automatically generated from the post title.

+

+ JSON data type: string

Read only

Context: edit
- title
- - object + title

The title for the post.

+

+ JSON data type: object

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

The content for the post.

+

+ JSON data type: object

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

The ID for the author of the post.

+

+ JSON data type: integer

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

The excerpt for the post.

+

+ JSON data type: object

Context: view, edit, embed
- comment_status
- - string + 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 + ping_status

Whether or not the post can be pinged.

+

+ JSON data type: string

Context: view, edit

One of: open, closed
- format
- - string + 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

Meta fields.

+

+ JSON data type: object

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

Whether or not the post should be treated as sticky.

+

+ JSON data type: boolean

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

The theme file to use to display the post.

+

+ JSON data type: string

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

The terms assigned to the post in the category taxonomy.

+

+ JSON data type: array

Context: view, edit
- tags
- - array + 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..438fcc3 100644 --- a/reference/search-results.md +++ b/reference/search-results.md @@ -10,50 +10,50 @@
- rendered
- - string + rendered

The rendered block.

+

+ JSON data type: string

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

Unique identifier for the object.

+

+ JSON data type: integer or string

Read only

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

The title for the object.

+

+ JSON data type: string

Read only

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

URL to the object.

+

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

Read only

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

Object type.

+

+ JSON data type: string

Read only

Context: view, embed

One of: post, term, post-format

@@ -61,12 +61,12 @@
- subtype
- - string + 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..834bdd1 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..e925efe 100644 --- a/reference/sidebars.md +++ b/reference/sidebars.md @@ -10,108 +10,108 @@
- title
- - string + title

Site title.

+

+ JSON data type: string

Context:

- description
- - string + description

Site tagline.

+

+ JSON data type: string

Context:

- url
- - string, - uri - + url

Site URL.

+

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

Context:

- email
- - string, - email - + email

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

+

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

Context:

- timezone
- - string + timezone

A city in the same timezone as you.

+

+ JSON data type: string

Context:

- date_format
- - string + date_format

A date format for all date strings.

+

+ JSON data type: string

Context:

- time_format
- - string + time_format

A time format for all time strings.

+

+ JSON data type: string

Context:

- start_of_week
- - integer + start_of_week

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

+

+ JSON data type: integer

Context:

- language
- - string + language

WordPress locale code.

+

+ JSON data type: string

Context:

- use_smilies
- - boolean + use_smilies

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

+

+ JSON data type: boolean

Context:

- default_category
- - integer + default_category

Default post category.

+

+ JSON data type: integer

Context:

- default_post_format
- - string + default_post_format

Default post format.

+

+ JSON data type: string

Context:

- posts_per_page
- - integer + posts_per_page

Blog pages show at most.

+

+ JSON data type: integer

Context:

- show_on_front
- - string + show_on_front

What to show on the front page

+

+ JSON data type: string

Context:

- page_on_front
- - integer + 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 + page_for_posts

The ID of the page that should display the latest posts

+

+ JSON data type: integer

Context:

- default_ping_status
- - string + 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 + 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.

+

+ JSON data type: integer

Context:

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

ID of sidebar.

+

+ JSON data type: string

Read only

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

Unique name identifying the sidebar.

+

+ JSON data type: string

Read only

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

Description of sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit
- class
- - string + 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 + 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 + 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 + 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 + 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

Status of sidebar.

+

+ JSON data type: string

Read only

Context: embed, view, edit

One of: active, inactive

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

Nested widgets.

+

+ JSON data type: array

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

Unique identifier for the term.

+

+ JSON data type: integer

Read only

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

Number of published posts for the term.

+

+ JSON data type: integer

Read only

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

HTML description of the term.

+

+ JSON data type: string

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

HTML title for the term.

+

+ JSON data type: string

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

An alphanumeric identifier for the term unique to its type.

+

+ JSON data type: string

Context: view, embed, edit
- taxonomy
- - string + 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

Meta fields.

+

+ JSON data type: object

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

All capabilities used by the taxonomy.

+

+ JSON data type: object

Read only

Context: edit
- description
- - string + description

A human-readable description of the taxonomy.

+

+ JSON data type: string

Read only

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

Whether or not the taxonomy should have children.

+

+ JSON data type: boolean

Read only

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

Human-readable labels for the taxonomy for various contexts.

+

+ JSON data type: object

Read only

Context: edit
- name
- - string + name

The title for the taxonomy.

+

+ JSON data type: string

Read only

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

An alphanumeric identifier for the taxonomy.

+

+ JSON data type: string

Read only

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

Whether or not the term cloud should be displayed.

+

+ JSON data type: boolean

Read only

Context: edit
- types
- - array + types

Types associated with the taxonomy.

+

+ JSON data type: array

Read only

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

REST base route for the taxonomy.

+

+ JSON data type: string

Read only

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

REST namespace route for the taxonomy.

+

+ JSON data type: string

Read only

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

The visibility settings for the taxonomy.

+

+ JSON data type: object

Read only

Context: edit

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

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

+

+ JSON data type: string

Read only

Context:

- template
- - string + 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 + author

The theme author.

+

+ JSON data type: object

Read only

Context:

- author_uri
- - object + author_uri

The website of the theme author.

+

+ JSON data type: object

Read only

Context:

- description
- - object + description

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

Read only

Context:

- name
- - object + name

The name of the theme.

+

+ JSON data type: object

Read only

Context:

- requires_php
- - string + requires_php

The minimum PHP version required for the theme to work.

+

+ JSON data type: string

Read only

Context:

- requires_wp
- - string + requires_wp

The minimum WordPress version required for the theme to work.

+

+ JSON data type: string

Read only

Context:

- screenshot
- - string, - uri - + screenshot

The theme's screenshot URL.

+

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

Read only

Context:

- tags
- - object + tags

Tags indicating styles and features of the theme.

+

+ JSON data type: object

Read only

Context:

- textdomain
- - string + textdomain

The theme's text domain.

+

+ JSON data type: string

Read only

Context:

- theme_supports
- - object + theme_supports

Features supported by this theme.

+

+ JSON data type: object

Read only

Context:

- theme_uri
- - object + theme_uri

The URI of the theme's webpage.

+

+ JSON data type: object

Read only

Context:

- version
- - string + version

The theme's current version.

+

+ JSON data type: string

Read only

Context:

- status
- - string + 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..5077952 100644 --- a/reference/widget-types.md +++ b/reference/widget-types.md @@ -10,59 +10,59 @@
- id
- - integer + id

Unique identifier for the user.

+

+ JSON data type: integer

Read only

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

Login name for the user.

+

+ JSON data type: string

Context: edit
- name
- - string + name

Display name for the user.

+

+ JSON data type: string

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

First name for the user.

+

+ JSON data type: string

Context: edit
- last_name
- - string + last_name

Last name for the user.

+

+ JSON data type: string

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

The email address for the user.

+

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

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

URL of the user.

+

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

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

Description of the user.

+

+ JSON data type: string

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

Locale for the user.

+

+ JSON data type: string

Context: edit

-

One of: , en_US, de_DE

+

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

The nickname for the user.

+

+ JSON data type: string

Context: edit
- slug
- - string + slug

An alphanumeric identifier for the user.

+

+ JSON data type: string

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

Registration date for the user.

+

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

Read only

Context: edit
- roles
- - array + roles

Roles assigned to the user.

+

+ JSON data type: array

Context: edit
- password
- - string + password

Password for the user (never included).

+

+ JSON data type: string

Context:

- capabilities
- - object + capabilities

All capabilities assigned to the user.

+

+ JSON data type: object

Read only

Context: edit
- extra_capabilities
- - object + extra_capabilities

Any extra capabilities assigned to the user.

+

+ JSON data type: object

Read only

Context: edit
- avatar_urls
- - object + avatar_urls

Avatar URLs for the user.

+

+ JSON data type: object

Read only

Context: embed, view, edit
- meta
- - object + 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..66d85c7 100644 --- a/reference/widgets.md +++ b/reference/widgets.md @@ -10,80 +10,80 @@
- id
- - string + id

Unique slug identifying the widget type.

+

+ JSON data type: string

Read only

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

Human-readable name identifying the widget type.

+

+ JSON data type: string

Read only

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

Description of the widget.

+

+ JSON data type: string

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

Whether the widget supports multiple instances

+

+ JSON data type: boolean

Read only

Context: view, edit, embed
- classname
- - string + 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..c051a63 100644 --- a/reference/wp-site-health-tests.md +++ b/reference/wp-site-health-tests.md @@ -10,36 +10,36 @@
- id
- - string + id

Unique identifier for the widget.

+

+ JSON data type: string

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

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

+

+ JSON data type: string

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

The sidebar the widget belongs to.

+

+ JSON data type: string

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

HTML representation of the widget.

+

+ JSON data type: string

Read only

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

HTML representation of the widget admin form.

+

+ JSON data type: string

Read only

Context: edit
- instance
- - object + instance

Instance settings of the widget, if supported.

+

+ JSON data type: object

Context: edit
- form_data
- - string + 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..c83567c --- /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 + test

The name of the test being run.

+

+ JSON data type: string

Read only

Context:

- label
- - string + label

A label describing the test.

+

+ JSON data type: string

Read only

Context:

- status
- - string + status

The status of the test.

+

+ JSON data type: string

Read only

Context:

One of: good, recommended, critical

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

The category this test is grouped in.

+

+ JSON data type: object

Read only

Context:

- description
- - string + 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 + 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..d06e1e7 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..8debdbc 100644 --- a/reference/wp_navigation-revisions.md +++ b/reference/wp_navigation-revisions.md @@ -10,132 +10,132 @@
- id
- - string + id

ID of global styles config.

+

+ JSON data type: string

Read only

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

Global styles.

+

+ JSON data type: object

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

Global settings.

+

+ JSON data type: object

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

Title of the global styles variation.

+

+ JSON data type: object or string

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

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - + 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) - + date_gmt

The date the revision was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + modified_gmt

The date the revision was last modified, as GMT.

+

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

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

The ID for the parent of the revision.

+

+ JSON data type: integer

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

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

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

The title for the post.

+

+ JSON data type: object

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

The content for the post.

-

Context: view, edit

+

+ JSON data type: object

+

Context: view, edit, embed
diff --git a/reference/wp_navigations.md b/reference/wp_navigations.md index 23dc6aa..59a2362 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..786cb04 100644 --- a/reference/wp_template-revisions.md +++ b/reference/wp_template-revisions.md @@ -10,130 +10,130 @@
- date
- - string or null, - datetime (details) - + 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) - + date_gmt

The date the post was published, as GMT.

+

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

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

The globally unique identifier for the post.

+

+ JSON data type: object

Read only

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

Unique identifier for the post.

+

+ JSON data type: integer

Read only

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + 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 + slug

An alphanumeric identifier for the post unique to its type.

+

+ JSON data type: string

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

A named status for the post.

-

Context: view, edit

+

+ JSON data type: string

+

Context: view, edit, embed

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

Type of post.

+

+ JSON data type: string

Read only

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

A password to protect access to the content and excerpt.

+

+ JSON data type: string

Context: edit
- title
- - object + title

The title for the post.

+

+ JSON data type: object

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

The content for the post.

-

Context: view, edit

+

+ JSON data type: object

+

Context: view, edit, embed
- template
- - string + 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..79df84d 100644 --- a/reference/wp_template_part-revisions.md +++ b/reference/wp_template_part-revisions.md @@ -10,130 +10,130 @@
- author
- - integer + author

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - + 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) - + date_gmt

The date the revision was published, as GMT.

+

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

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

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

+

+ JSON data type: string

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

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + modified_gmt

The date the revision was last modified, as GMT.

+

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

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

The ID for the parent of the revision.

+

+ JSON data type: integer

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

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

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

Title of template.

+

+ JSON data type: object or string

Context: embed, view, edit
- content
- - object or string + 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..1fe738b 100644 --- a/reference/wp_template_parts.md +++ b/reference/wp_template_parts.md @@ -10,161 +10,175 @@
- author
- - integer + author

The ID for the author of the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- date
- - string, - datetime (details) - + 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) - + date_gmt

The date the revision was published, as GMT.

+

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

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

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

+

+ JSON data type: string

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

Unique identifier for the revision.

+

+ JSON data type: integer

Context: view, edit, embed
- modified
- - string, - datetime (details) - + 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) - + modified_gmt

The date the revision was last modified, as GMT.

+

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

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

The ID for the parent of the revision.

+

+ JSON data type: integer

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

An alphanumeric identifier for the revision unique to its type.

+

+ JSON data type: string

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

Title of template.

+

+ JSON data type: object or string

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

Content of template.

+

+ JSON data type: object or string

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

ID of template.

+

+ JSON data type: string

Read only

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

Unique slug identifying the template.

+

+ JSON data type: string

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

Theme identifier for the template.

+

+ JSON data type: string

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

Type of template.

+

+ JSON data type: string

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

Source of template

+

+ JSON data type: string

Read only

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

Source of a customized template

+

+ JSON data type: string

Read only

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

Content of template.

+

+ JSON data type: object or string

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

Title of template.

+

+ JSON data type: object or string

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

Description of template.

+

+ JSON data type: string

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

Status of template.

+

+ JSON data type: string

Context: embed, view, edit

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

Post ID.

+

+ JSON data type: integer

Read only

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

Theme file exists.

+

+ JSON data type: bool

Read only

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

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) +

+

Read only

+

Context: view, edit

+
- area
- - string + area

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

+

+ JSON data type: string

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

ID of template.

+

+ JSON data type: string

Read only

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

Unique slug identifying the template.

+

+ JSON data type: string

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

Theme identifier for the template.

+

+ JSON data type: string

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

Type of template.

+

+ JSON data type: string

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

Source of template

+

+ JSON data type: string

Read only

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

Source of a customized template

+

+ JSON data type: string

Read only

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

Content of template.

+

+ JSON data type: object or string

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

Title of template.

+

+ JSON data type: object or string

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

Description of template.

+

+ JSON data type: string

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

Status of template.

+

+ JSON data type: string

Context: embed, view, edit

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

Post ID.

+

+ JSON data type: integer

Read only

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

Theme file exists.

+

+ JSON data type: bool

Read only

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

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) +

+

Read only

+

Context: view, edit

+
- is_custom
- - bool + is_custom

Whether a template is a custom template.

+

+ JSON data type: bool

Read only

Context: embed, view, edit