bueltge/wp-rest-api-filter-items

根据您的请求从 WP API 响应中移除内容。

安装: 35

依赖: 0

建议者: 0

安全: 0

星标: 63

关注者: 6

分支: 14

开放问题: 2

类型:wordpress-plugin

1.0.0 2019-06-11 09:24 UTC

This package is auto-updated.

Last update: 2024-09-06 04:32:01 UTC


README

Unit Tests Build Status Code Climate License

一个用于过滤您请求的 WordPress REST API 项目的 WordPress 插件。它会在您的请求中移除 WP API 响应中的键和值。

描述

默认情况下,通过 WordPress REST API 发送的文章会从 wp-json/wp/v2/posts 获取所有数据。出于许多原因,您可能希望在特定情况下从 WP API 响应中排除某些字段。此插件允许您过滤所需字段的请求。在 URL 的 GET 属性上添加项目,例如,要获取仅相应字段值,请使用 wp-json/wp/v2/posts?items=id,title,content

此插件目前支持过滤文章、分类和评论。

WP-API 版本

  • 如果您使用 WP-API 版本 1,请使用分支 wp-api-v1
  • master 分支 用于开发,目前已准备好,并对外开放 WP API 版本 2 的功能请求。

安装

通过下载安装静态文件、克隆仓库或使用 Composer 进行依赖管理

composer require bueltge/wp-rest-api-filter-items

示例

文章的结果:wp-json/wp/v2/posts?_wp_json_nonce=4355d0c4b3&items=id,title,content

[
	{
		"id": 1,
		"title": {
			"rendered": "Hello world!"
		},
		"content": {
			"rendered": "<p>Welcome to <a href=\"http://localhost/wpbeta/\">WP Beta Dev Sites</a>. This is your first post. Edit or delete it, then start blogging!</p>\n"
		}
	}
]

分类的结果:wp-json/wp/v2/taxonomies/category?_wp_json_nonce=4355d0c4b3&items=name,slug,types

{
	"name": "Categories",
	"slug": "category",
	"types": [
		"post",
		"archiv"
	]
}

评论的结果:wp-json/wp/v2/comments?items=id,author_name

[
	{
		"id": 1,
		"author_name": "Mr WordPress"
	},
	{
		"id": 2,
		"author_name": "admin"
	}
]

要求

  • PHP 5.4
  • WordPress 4.*
  • WP REST API

致谢

感谢 @dnaber-de,他的 模块化、可扩展的 PHP 自动加载器