wordpress插件WP Rest API接口文档说明

快来打我* 2023-01-06 11:42 182阅读 0赞

详细说明请看说明手册：  
[https://developer.wordpress.org/rest-api/reference/][https_developer.wordpress.org_rest-api_reference]

<table> 
 <tbody> 
  <tr> 
   <th> 资源资源 </th> 
   <th> 基本路线 </th> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/posts/" rel="nofollow"> 帖子 </a></td> 
   <td> /wp/v2/posts</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/post-revisions/" rel="nofollow"> 发布修订 </a></td> 
   <td> /wp/v2/posts/&lt;id&gt;/revisions</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/categories/" rel="nofollow"> 分类目录 </a></td> 
   <td> /wp/v2/categories</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/tags/" rel="nofollow"> 标签 </a></td> 
   <td> /wp/v2/tags</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/pages/" rel="nofollow"> 页数 </a></td> 
   <td> /wp/v2/pages</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/page-revisions/" rel="nofollow"> 页面修订 </a></td> 
   <td> /wp/v2/pages/&lt;id&gt;/revisions</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/comments/" rel="nofollow"> 评论 </a></td> 
   <td> /wp/v2/comments</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/taxonomies/" rel="nofollow"> 分类法 </a></td> 
   <td> /wp/v2/taxonomies</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/media/" rel="nofollow"> 媒体 </a></td> 
   <td> /wp/v2/media</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/users/" rel="nofollow"> 用户数 </a></td> 
   <td> /wp/v2/users</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/post-types/" rel="nofollow"> 帖子类型 </a></td> 
   <td> /wp/v2/types</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/post-statuses/" rel="nofollow"> 发布状态 </a></td> 
   <td> /wp/v2/statuses</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/settings/" rel="nofollow"> 设定值 </a></td> 
   <td> /wp/v2/settings</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/themes/" rel="nofollow"> 主题 </a></td> 
   <td> /wp/v2/themes</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/search-results/" rel="nofollow"> 搜索 </a></td> 
   <td> /wp/v2/search</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/block-types/" rel="nofollow"> 块类型 </a></td> 
   <td> /wp/v2/block-types</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/blocks/" rel="nofollow"> 积木 </a></td> 
   <td> /wp/v2/blocks</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/block-revisions/" rel="nofollow"> 块修订 </a></td> 
   <td> /wp/v2/blocks/&lt;id&gt;/autosaves/</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/rendered-blocks/" rel="nofollow"> 块渲染器 </a></td> 
   <td> /wp/v2/block-renderer</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/block-directory-items/" rel="nofollow"> 阻止目录项 </a></td> 
   <td> /wp/v2/block-directory/search</td> 
  </tr> 
  <tr> 
   <td><a href="https://developer.wordpress.org/rest-api/reference/plugins/" rel="nofollow"> 外挂程式 </a></td> 
   <td> /wp/v2/plugins</td> 
  </tr> 
 </tbody> 
</table>

> 常用WP REST API 接口使用介绍（获取数据）

此段介绍WP REST API 常用的获取数据（GET）的接口

### **1、文章** ###

#### （1）获取最新文章（默认获取到最新的10篇文章） ####

**http://www.website.com/wp-json/wp/v2/posts**

与

**http://www.website.com/wp-json/wp/v2/posts?page=1**

效果相同，page用于指定页数，WP REST API 默认返回10条数据，用page指定数据获取的游标。如

**http://www.website.com/wp-json/wp/v2/posts?page=2**

可取回最新的第11条数据到第20条数据，以此类推。

#### （2）设置获取的每页文章数量及分页 ####

**http://www.website.com/wp-json/wp/v2/posts?filter\[posts\_per\_page\]=5**

filter\[posts\_per\_page\]=5 用于指定返回文章每页的数量，这里指定每页数量为5篇。

filter\[posts\_per\_page\]与page联合使用：

**http://www.website.com/wp-json/wp/v2/posts?filter\[posts\_per\_page\]=5&page=2**

#### （3）获取指定分类的文章 ####

**http://www.website.com/wp-json/wp/v2/posts?filter\[cat\]=2**

filter\[cat\]=2 指定分类ID为2 ，返回分类ID为2的文章。

分类ID是每个分类目录在创建时自动生成的ID，在wordpress后台“文章”==》“分类目录”中，把鼠标放在分类名称上面，页面下方会出现一个网址，网址中的参数tag\_ID=2就是这个分类名称的分类ID。如果没有出现网址，可以点击分类名称下的“编辑”，然后查看网页地址栏，同样可以得到tag\_ID=2。下面的标签ID的获得方法也一样。

#### （4）获取指定标签的文章 ####

**http://www.website.com/wp-json/wp/v2/posts?filter\[tag\]=library**

filter\[tag\]=library 指定标签名为“library”的文章

#### （5）获取指定分类和有指定标签的文章 ####

**http://www.website.com/wp-json/wp/v2/posts?filter\[cat\]=2&filter\[tag\]=library**

上面两个结合一起，可以得到更具体精确的文章。

#### （6）获取指定日期的文章 ####

**http://www.website.com/wp-json/wp/v2/posts?filter\[year\]=2016&filter\[monthnum\]=03**

filter\[year\]=2016&filter\[monthnum\]=03 设置指定的日期

#### （7）获取指定作者的文章 ####

**http://www.website.com/wp-json/wp/v2/posts?filter\[author\_name\]=jinyun**

filter\[author\_name\]=jinyun设置指定作者名字

#### （8）按关键词搜索文章 ####

**http://www.website.com/wp-json/wp/v2/posts?filter\[s\]=金云**

filter\[s\]=金云 ：按给定的关键词搜索文章，返回包含“金云”关键词的文章。

#### （9）获取随机文章 ####

**http://www.website.com/wp-json/wp/v2/posts?filter\[orderby\]=rand**

其中orderby还可以为指定的字段排序

#### （10）获取相关文章 ####

在网站中，在做SEO优化和页面内容布局时，获取相关文章是比较常见的，可以通过以上几个条件组合来达到获取相关文章的效果。

**按标签获取相关文章：**

**http://www.website.com/wp-json/wp/v2/posts?filter\[orderby\]=rand&filter\[tag\]=library&filter\[posts\_per\_page\]=6**

**按分类获取相关文章：**

**http://www.website.com/wp-json/wp/v2/posts?filter\[orderby\]=rand&filter\[cat\]=2&filter\[posts\_per\_page\]=6**

#### （11）获取指定文章的数据 ####

**http://www.website.com/wp-json/wp/v2/posts/189**

得到ID为189的文章数据

### **2、分类和标签** ###

#### （1）获取所有的分类 ####

**http://www.website.com/wp-json/wp/v2/categories**

#### （2）获取指定分类ID的分类信息 ####

**http://www.website.com/wp-json/wp/v2/categories/2**

#### （3）获取所有的标签 ####

**http://www.website.com/wp-json/wp/v2/tags**

#### （4）获取指定标签ID的标签信息 ####

**http://www.website.com/wp-json/wp/v2/tags/3**

### **3、媒体文件** ###

#### （1）获取所有的媒体信息 ####

**http://www.website.com/wp-json/wp/v2/media**

#### （2）获取指定媒体ID的媒体信息 ####

**http://www.website.com/wp-json/wp/v2/media/17**

### **4、页面** ###

#### （1）获取所有的页面信息 ####

**http://www.website.com/wp-json/wp/v2/pages**

#### （2）获取指定页面ID的页面信息 ####

**http://www.website.com/wp-json/wp/v2/pages/289**

### **5、类型** ###

#### （1）获取当前wordpress所有的内容类型 ####

**http://www.website.com/wp-json/wp/v2/types**

一般情况下会返回post,page和attachment三种类型

#### （2）获取指定类型 ####

**http://www.website.com/wp-json/wp/v2/types/post**

### **6、评论** ###

#### （1）获取所有评论信息 ####

**http://www.website.com/wp-json/wp/v2/comments**

#### （2）获取指定评论ID的单条评论信息 ####

**http://www.website.com/wp-json/wp/v2/comments/2**

### **7、用户** ###

#### （1）获取所有的用户信息 ####

**http://www.website.com/wp-json/wp/v2/users**

#### （2）获取指定用户ID的用户信息 ####

**http://www.website.com/wp-json/wp/v2/users/1**

以上即是WP REST API 内置API接口最为常用的接口数据获取方法。

[https_developer.wordpress.org_rest-api_reference]: https://developer.wordpress.org/rest-api/reference/

wordpress插件WP Rest API接口文档说明

发表评论取消回复

还没有评论，来说两句吧...

相关阅读

相关 wordpress插件WP Rest API接口文档说明

相关 wordpress插件_如何制作有用的WordPress插件

相关 wordpress插件_什么是WordPress MU插件？

相关 wordpress插件_WordPress插件以正确的方式更新

相关 wordpress插件_如何使用Weglot插件翻译WordPress网站

相关 wp rest api_WP API-使用WordPress REST API

相关 jQuery formvalidator插件 API帮助文档

相关 CodeIgniter+swagger实现 PHP API接口文档自动生成功能自动生成ci RESTFUL api接口文档

相关 Eureka Rest接口文档

相关 WordPress自定义查询WP_Query参数使用说明