WP-API JSON Feed

Description

  • Adds JSON feeds following the official version 1 spec.
  • Places a link tag to the posts feed inside the HTML head tag.
  • Adds a new namespace feed/v1 to the REST API.
  • Allows adding individual endpoints per post type, simply by specifying an additional argument when registering the post type. By default a feed is only added for regular posts (posts of the post post type).
  • Uses a proper REST API controller including schema for the endpoints.
  • Contains several filters to modify the feed responses as necessary.

Screenshots

  • Example JSON feed response generated by the plugin

Installation

  1. Upload the entire wp-api-json-feed folder to the /wp-content/plugins/ directory or download it through the WordPress backend.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.

Once the plugin is activated, it will work out of the box and provide a JSON feed for posts. If you want to provide JSON feeds for further post types, you need to specify an additional argument show_json_feed when registering the post type, and set it to a boolean true. You may also specify a json_feed_base argument being a string identifier that should be used in the feed URL. If no string identifier is provided, the post type slug will be used.

FAQ

Installation Instructions
  1. Upload the entire wp-api-json-feed folder to the /wp-content/plugins/ directory or download it through the WordPress backend.
  2. Activate the plugin through the ‘Plugins’ menu in WordPress.

Once the plugin is activated, it will work out of the box and provide a JSON feed for posts. If you want to provide JSON feeds for further post types, you need to specify an additional argument show_json_feed when registering the post type, and set it to a boolean true. You may also specify a json_feed_base argument being a string identifier that should be used in the feed URL. If no string identifier is provided, the post type slug will be used.

How can I add a feed for my custom post type?

If you want to provide a JSON feed for your custom post type, you need to specify an additional argument show_json_feed when registering the post type, and set it to a boolean true. You may also specify a json_feed_base argument being a string identifier that should be used in the feed URL. If no string identifier is provided, the post type slug will be used.

Where should I submit my support request?

I preferably take support requests as issues on Github, so I would appreciate if you created an issue for your request there. However, if you don’t have an account there and do not want to sign up, you can of course use the wordpress.org support forums as well.

How can I contribute to the plugin?

If you’re a developer and you have some ideas to improve the plugin or to solve a bug, feel free to raise an issue or submit a pull request in the Github repository for the plugin.

You can also contribute to the plugin by translating it. Simply visit translate.wordpress.org to get started.

Contributors & Developers

“WP-API JSON Feed” is open source software. The following people have contributed to this plugin.

Contributors

Translate “WP-API JSON Feed” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.0.0

  • First stable version