Navigations Edit

Topics

Schema
List Navigations
Create a Navigation
- Arguments
- Definition
Retrieve a Navigation
- Definition & Example Request
- Arguments
Update a Navigation
Delete a Navigation

Schema

The schema defines all the fields that exist within a navigation 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.

`date` string or null, datetime (details)	The date the post was published, in the site's timezone. Context: `view`, `edit`, `embed`
`date_gmt` string or null, datetime (details)	The date the post was published, as GMT. Context: `view`, `edit`
`guid` object	The globally unique identifier for the post. Read only Context: `view`, `edit`
`id` integer	Unique identifier for the post. Read only Context: `view`, `edit`, `embed`
`link` string, uri	URL to the post. Read only Context: `view`, `edit`, `embed`
`modified` string, datetime (details)	The date the post was last modified, in the site's timezone. Read only Context: `view`, `edit`
`modified_gmt` string, datetime (details)	The date the post was last modified, as GMT. Read only Context: `view`, `edit`
`slug` string	An alphanumeric identifier for the post unique to its type. Context: `view`, `edit`, `embed`
`status` string	A named status for the post. Context: `view`, `edit` One of: `publish`, `future`, `draft`, `pending`, `private`
`type` string	Type of post. Read only Context: `view`, `edit`, `embed`
`password` string	A password to protect access to the content and excerpt. Context: `edit`
`title` object	The title for the post. Context: `view`, `edit`, `embed`
`content` object	The content for the post. Context: `view`, `edit`
`template` string	The theme file to use to display the post. Context: `view`, `edit`

Top ↑

List Navigations

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

Top ↑

Definition

GET /wp/v2/navigation

Top ↑

Example Request

$ curl https://example.com/wp-json/wp/v2/navigation

Top ↑

Arguments

`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. Default: `10`
`search`	Limit results to those matching a string.
`after`	Limit response to posts published after a given ISO8601 compliant date.
`modified_after`	Limit response to posts modified after a given ISO8601 compliant date.
`before`	Limit response to posts published before a given ISO8601 compliant date.
`modified_before`	Limit response to posts modified before a given ISO8601 compliant date.
`exclude`	Ensure result set excludes specific IDs.
`include`	Limit result set to specific IDs.
`offset`	Offset the result set by a specific number of items.
`order`	Order sort attribute ascending or descending. Default: `desc` One of: `asc`, `desc`
`orderby`	Sort collection by post attribute. Default: `date` One of: `author`, `date`, `id`, `include`, `modified`, `parent`, `relevance`, `slug`, `include_slugs`, `title`
`search_columns`	Array of column names to be searched.
`slug`	Limit result set to posts with one or more specific slugs.
`status`	Limit result set to posts assigned one or more statuses. Default: `publish`

Top ↑

Arguments

`date`	The date the post was published, in the site's timezone.
`date_gmt`	The date the post was published, as GMT.
`slug`	An alphanumeric identifier for the post unique to its type.
`status`	A named status for the post. One of: `publish`, `future`, `draft`, `pending`, `private`
`password`	A password to protect access to the content and excerpt.
`title`	The title for the post.
`content`	The content for the post.
`template`	The theme file to use to display the post.

Top ↑

Definition

POST /wp/v2/navigation

Top ↑

Definition & Example Request

GET /wp/v2/navigation/<id>

Query this endpoint to retrieve a specific navigation record.

$ curl https://example.com/wp-json/wp/v2/navigation/<id>

Top ↑

Arguments

id Unique identifier for the post.

context

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

Default: view

One of: view, embed, edit

password The password for the post if it is password protected.

Top ↑

Arguments

`id`	Unique identifier for the post.
`date`	The date the post was published, in the site's timezone.
`date_gmt`	The date the post was published, as GMT.
`slug`	An alphanumeric identifier for the post unique to its type.
`status`	A named status for the post. One of: `publish`, `future`, `draft`, `pending`, `private`
`password`	A password to protect access to the content and excerpt.
`title`	The title for the post.
`content`	The content for the post.
`template`	The theme file to use to display the post.