云策 WordPress 开发者社区

REST API 文档

Navigations

查看官方原文 ↗
💡 云策文档标注

概述

本文档详细介绍了 WordPress REST API 中导航（Navigation）端点的架构和使用方法。涵盖导航记录的 Schema 定义、CRUD 操作（列表、创建、检索、更新、删除）及其相关参数，为开发者提供完整的 API 参考。

关键要点

  • Schema 定义了导航记录的字段，包括 date、guid、id、link、modified、slug、status、type、password、title、content、template 等，每个字段包含 JSON 数据类型、格式、只读属性和上下文（如 view、edit、embed）。
  • 支持通过 GET /wp/v2/navigation 列出导航，可使用 context、page、per_page、search、order、orderby 等查询参数进行过滤和分页。
  • 创建导航使用 POST /wp/v2/navigation，参数包括 date、slug、status、title、content 等，遵循 Schema 定义。
  • 检索特定导航使用 GET /wp/v2/navigation/<id>，参数包括 id 和 context。
  • 更新导航使用 POST /wp/v2/navigation/<id>，参数与创建类似，允许修改字段如 date、title、content 等。
  • 删除导航使用 DELETE /wp/v2/navigation/<id>，参数包括 id 和 force（用于强制删除）。

代码示例

// 列出导航的示例请求
$ curl https://example.com/wp-json/wp/v2/navigation

// 检索特定导航的示例请求
$ curl https://example.com/wp-json/wp/v2/navigation/<id>

// 删除导航的示例请求
$ curl -X DELETE https://example.com/wp-json/wp/v2/navigation/<id>
📄 原文内容

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

Context: view, edit
guid 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

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)

Read only

Context: view, edit
modified_gmt 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

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

Read only

Context: view, edit, embed
password 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

Context: view, edit, embed
content 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

Context: view, edit

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.

Definition

GET /wp/v2/navigation

Example Request

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

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

Create a Navigation

Arguments

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

Definition

POST /wp/v2/navigation

Retrieve a Navigation

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>

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.

Update a Navigation

Arguments

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

Definition

POST /wp/v2/navigation/<id>

Example Request

Delete a Navigation

Arguments

id Unique identifier for the post.
force Whether to bypass Trash and force deletion.

Definition

DELETE /wp/v2/navigation/<id>

Example Request

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