Linux 软件免费装

REST API - Filter Fields

开发者 svrooij
更新时间 2020年6月30日 03:24
捐献地址: 去捐款
PHP版本: 4.4 及以上
WordPress版本: 5.4.2
版权: MIT
版权网址: 版权信息

标签

json api rest rest-api

下载

1.0.0 1.0.1 1.0.2 1.0.3 1.0.4 1.0.5 1.0.6 1.0.7 1.0.8

详情介绍:

Since wordpress version 4.9.? wordpress includes the functionality provided by this plugin in the core of wordpress. Checkout https://developer.wordpress.org/rest-api/using-the-rest-api/global-parameters/#_fields for functionality included in the wordpress core, they made it even better by filtering the amount of data pulled from the database. This plugin will no longer be maintained since it has been superseded by the core functionality. The wp-rest-api-v2 returns a lot of properties. It could be very useful (or mobile-data-friendly) to only return the properties needed by the application. If you only want titles and links of some articles it doesn't make sense to return the content or the excerpt. This isn't limited to posts, it also works on custom posttypes, categories, pages, terms, taxonomies and comments. Instead of returning: { "id": 2138, "date": "2015-10-25T15:31:03", "guid": { "rendered": "http://worldofict.nl/?p=2138" }, "modified": "2015-10-25T15:31:03", "modified_gmt": "2015-10-25T14:31:03", "slug": "rechtenvrije-fotos", "type": "post", "link": "http://worldofict.nl/tip/2138-rechtenvrije-fotos/", "title": { "rendered": "Rechtenvrije foto’s" }, "content": { "rendered": ".. A lot of content .. " }, "excerpt": { "rendered": " .. A lot of content ..." }, "author": 2, "featured_image": 2139, "comment_status": "open", "ping_status": "open", "sticky": false, "format": "standard", //.. even more tags .... } It can return (with fields=id,title.rendered,link as GET parameter) { "id": 2138, "link": "http://worldofict.nl/tip/2138-rechtenvrije-fotos/", "title": { "rendered": "Rechtenvrije foto’s" } } 笔记
  1. If you specify fields so it wouldn't return data the default response is send back to the client.
  2. (for developers) something wrong with this plugin? Github
  3. If you liked the plugin consider sponsoring me

安装:

Installing this plugin is really easy. Just search the plugin directory for rest api filter fields and press install. Or download it right from Github and copy the rest-api-filter-fields directory in the archive to wp-content/plugins/.

常见问题:

Do you add data to the response?

No, this plugin only removes entries. When you want to add featured_images, I recommend using better-rest-api-featured-images

How about nested propterties?

You can filter on nested properties with a '.' like 'title.rendered'. Not sure if this also works on arrays. Existing issues or Submit issue

Does this also work for my custom posttype?

Yes, we picked 20 as priority (default = 10) for activating. This mean this plugin is probably activated last, so all custom post types should already be loaded. But this only works if you made it public for the api. See Adding REST API Support for Custom Content Types for more information.

I found a bug, what should I do?

All the bugs/issues are maintained on github.com/svrooij/rest-api-filter-fields so please create an issue (or a pull request with a fix) there.

更新日志:

1.0.8 1.0.7 1.0.6 1.0.5 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0