bueltge / wp-rest-api-filter-items Goto Github PK

A WordPress plugin that filters WP REST API items to your requirement.

License: GNU General Public License v2.0

PHP 100.00%

wp-api wordpress-plugin wordpress rest-api

wp-rest-api-filter-items's Introduction

WP REST API Filter Items

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.

wp-rest-api-filter-items's People

Contributors

Stargazers

Watchers

Forkers

birgire chmod-777 beyondi jaydeepjivani huilang-me hugocalderon aikusuma irajul saberonline zaraza325632 lipsworld wordpress-tool oligoform beastycoding-forks

wp-rest-api-filter-items's Issues

Switch to Composer autoload

The plugin use currently a custom autoload and should switch to the Composer way via composer.json configuration. In this context the composer.json needs an update.

Not working in Woocommerce

Query:
site.com/wp-json/wc/v3/products?items=id,name
just outputs all fields.

This query is working:
site.com/wp-json/wp/v2/comments?items=id,author_name

Is there a way to fix it?

Refactoring for WP API 2.0

About the new version:
https://make.wordpress.org/core/2015/05/28/wp-rest-api-version-2-0-beta-2/

Maybe helpful - class WP_REST_Posts_Terms_Controller

Add endpoints for viewing, creating, updating, and deleting Terms for a Post.
The new WP_REST_Posts_Terms_Controller class controller supports routes for
Terms that belong to a Post. You can now remove and add terms on posts (finally!)

Not working for custom post types

Hello,
It is not working for custom post types while the Wordpress API itself works for it naturally.

Update phpunit for php7*

Update composer requirements
Update tests, so that it also run in PHP 7

Examples in Readme

The current Readme shows this as an example:

Result for post, `wp-json/posts?items=ID,title,content`

[
  {
    "ID": 1,
    "title": "Hello world!",
    "content": "<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",
    "author": {...},
    "featured_image": null,
    "terms": {...}
  }
]

But the fields author, featured_image and terms should not appear in the example output, shouldn't they?