Git Product home page Git Product logo

rest-filter-response-fields's Introduction

NOTE: This plugin was created to test a feature which has since landed in WordPress core. To request specific fields with your REST API response, you may use the _fields query parameter introduced in WordPress 4.9.

Usage:

Example Query Result
/wp/v2/posts?_fields=id,title Return a posts collection where each post includes only the id property and title object.
/wp/v2/media?_fields=source_url Return a media collection where each object includes only the source_url.
/wp/v2/tags?_fields[]=slug&_fields[]=id Return tag objects with only the id and slug properties.

As noted in the above examples, the core implementation supports using query parameter array syntax or a comma-separated list.

Legacy plugin README below, for posterity.


REST Filter Response Fields

Specify fields for the response JSON. See https://core.trac.wordpress.org/ticket/38131.

Use by specifying the fields you want as part of the request as a comma delimited list: ?fields=title,excerpt.

rest-filter-response-fields's People

Contributors

kadamwhite avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.