{"id":39764,"date":"2015-10-29T10:40:29","date_gmt":"2015-10-29T10:40:29","guid":{"rendered":"https:\/\/wordpress.org\/plugins-wp\/rest-api-filter-fields\/"},"modified":"2020-06-29T19:24:31","modified_gmt":"2020-06-29T19:24:31","slug":"rest-api-filter-fields","status":"closed","type":"plugin","link":"https:\/\/tl.wordpress.org\/plugins\/rest-api-filter-fields\/","author":14653621,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","version":"1.0.8","stable_tag":"1.0.8","tested":"5.4.19","requires":"4.4","requires_php":"","requires_plugins":"","header_name":"WP REST API - filter fields","header_author":"Stephan van Rooij","header_description":"","assets_banners_color":"","last_updated":"2020-06-29 19:24:31","external_support_url":"","external_repository_url":"","donate_link":"https:\/\/github.com\/sponsors\/svrooij","header_plugin_uri":"https:\/\/github.com\/svrooij\/rest-api-filter-fields","header_author_uri":"https:\/\/svrooij.io","rating":5,"author_block_rating":0,"active_installs":300,"downloads":33439,"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":[],"upgrade_notice":[],"ratings":{"1":0,"2":0,"3":0,"4":0,"5":"10"},"assets_icons":[],"assets_banners":[],"assets_blueprints":{},"all_blocks":[],"tagged_versions":["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"],"block_files":[],"assets_screenshots":[],"screenshots":[],"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[1556,1118,2299,23853],"plugin_category":[],"plugin_contributors":[86679],"plugin_business_model":[],"class_list":["post-39764","plugin","type-plugin","status-closed","hentry","plugin_tags-api","plugin_tags-json","plugin_tags-rest","plugin_tags-rest-api","plugin_contributors-svrooij","plugin_committers-svrooij"],"banners":[],"icons":{"svg":false,"icon":"https:\/\/s.w.org\/plugins\/geopattern-icon\/rest-api-filter-fields.svg","icon_2x":false,"generated":true},"screenshots":[],"raw_content":"\n

Since wordpress version 4.9.? wordpress includes the functionality provided by this plugin in the core of wordpress.<\/p>\n\n

Checkout https:\/\/developer.wordpress.org\/rest-api\/using-the-rest-api\/global-parameters\/#_fields for functionality included in the wordpress core,\nthey made it even better by filtering the amount of data pulled from the database.<\/p>\n\n

This plugin will no longer be maintained since it has been superseded by the core functionality.<\/p>\n\n

The wp-rest-api-v2<\/a> returns a lot of properties.\nIt could be very useful (or mobile-data-friendly) to only return the properties needed by the application.<\/p>\n\n

If you only want titles and links of some articles it doesn't make sense to return the content or the excerpt.<\/p>\n\n

This isn't limited to posts, it also works on custom posttypes, categories, pages, terms, taxonomies and comments.<\/p>\n\n

Instead of returning:<\/p>\n\n

{\n  \"id\": 2138,\n  \"date\": \"2015-10-25T15:31:03\",\n  \"guid\": {\n    \"rendered\": \"http:\/\/worldofict.nl\/?p=2138\"\n  },\n  \"modified\": \"2015-10-25T15:31:03\",\n  \"modified_gmt\": \"2015-10-25T14:31:03\",\n  \"slug\": \"rechtenvrije-fotos\",\n  \"type\": \"post\",\n  \"link\": \"http:\/\/worldofict.nl\/tip\/2138-rechtenvrije-fotos\/\",\n  \"title\": {\n    \"rendered\": \"Rechtenvrije foto’s\"\n  },\n  \"content\": {\n    \"rendered\": \".. A lot of content .. \"\n  },\n  \"excerpt\": {\n    \"rendered\": \" .. A lot of content ...\"\n  },\n  \"author\": 2,\n  \"featured_image\": 2139,\n  \"comment_status\": \"open\",\n  \"ping_status\": \"open\",\n  \"sticky\": false,\n  \"format\": \"standard\",\n  \/\/.. even more tags ....\n}\n<\/code><\/pre>\n\n
It can return (with fields=id,title.rendered,link<\/code> as GET parameter)<\/p>\n\n
{\n  \"id\": 2138,\n  \"link\": \"http:\/\/worldofict.nl\/tip\/2138-rechtenvrije-fotos\/\",\n  \"title\": {\n    \"rendered\": \"Rechtenvrije foto’s\"\n  }\n}\n<\/code><\/pre>\n\n
Notes<\/h4>\n\n
    \n
  1. If you specify fields so it wouldn't return data the default response is send back to the client.<\/li>\n
  2. (for developers) something wrong with this plugin? Github<\/a><\/li>\n
  3. If you liked the plugin consider sponsoring me<\/a><\/li>\n<\/ol>\n\n\n
    Installing this plugin is really easy.<\/p>\n\n
    Just search the plugin directory for rest api filter fields<\/code> and press install.\nOr download it right from Github<\/a> and copy the rest-api-filter-fields<\/code> directory in the archive to wp-content\/plugins\/<\/code>.<\/p>\n\n\n
    \n
    Do you add data to the response?<\/h3><\/dt>\n
    No, this plugin only removes entries.\nWhen you want to add featured_images<\/a>, I recommend using better-rest-api-featured-images<\/a><\/p><\/dd>\n
    How about nested propterties?<\/h3><\/dt>\n
    You can filter on nested properties with a '.' like 'title.rendered'. Not sure if this also works on arrays. Existing issues<\/a> or Submit issue<\/a><\/p><\/dd>\n
    Does this also work for my custom posttype?<\/h3><\/dt>\n
    Yes, we picked 20 as priority (default = 10) for activating.\nThis mean this plugin is probably activated last, so all custom post types should already be loaded.\nBut this only works if you made it public for the api.\nSee Adding REST API Support for Custom Content Types<\/a> for more information.<\/p><\/dd>\n
    I found a bug, what should I do?<\/h3><\/dt>\n
    All the bugs\/issues are maintained on github.com\/svrooij\/rest-api-filter-fields<\/a>\nso please create an issue (or a pull request with a fix) there.<\/p><\/dd>\n\n<\/dl>\n\n\n
    1.0.8<\/h4>\n\n