bueltge/wp-rest-api-filter-items

Removing Content From WP API Response on your request.

Installs: 34

Dependents: 0

Suggesters: 0

Security: 0

Stars: 60

Watchers: 5

Forks: 13

Type:wordpress-plugin

1.0.0 2019-06-11 09:24 UTC

This package is auto-updated.

Last update: 2022-01-05 22:36:50 UTC


README

Unit Tests Build Status Code Climate License

A WordPress plugin to filters WordPress REST API items for your request. Its removing key and values from WP API response on your request.

Description

Per default, a post via WordPress REST API would fetch all data in wp-json/wp/v2/posts. For many reasons, you might want to exclude certain fields from WP API response in certain circumstances. This plugin enables you to filter your request for fields you require. Add items to the GET attribute on the url, like wp-json/wp/v2/posts?items=id,title,content in order to get only according field values.

The plugin currently supports the filtering of post, taxonomy and comments.

WP-API Versions

  • Use the branch wp-api-v1 if you use WP-API Version 1.
  • The master branch is for development, currently ready and open for feature requests for the WP API Version 2.

Installation

Install static via download, clone the repository or use dependency management via Composer

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

Examples

Result for post: 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"
		}
	}
]

Result for taxonomy: p-json/wp/v2/taxonomies/category?_wp_json_nonce=4355d0c4b3&items=name,slug,types.

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

Result for comments: wp-json/wp/v2/comments?items=id,author_name

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

Requirements

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

Kudos

Thanks @dnaber-de for his modular, extendable PHP autoloader.