Title: WP-API JSON Feed
Author: Felix Arntz
Published: <strong>May 22, 2017</strong>
Last modified: November 24, 2025

---

Search plugins

![](https://ps.w.org/wp-api-json-feed/assets/banner-772x250.png?rev=2982096)

![](https://ps.w.org/wp-api-json-feed/assets/icon-256x256.png?rev=2982096)

# WP-API JSON Feed

 By [Felix Arntz](https://profiles.wordpress.org/flixos90/)

[Download](https://downloads.wordpress.org/plugin/wp-api-json-feed.1.1.0.zip)

 * [Details](https://kea.wordpress.org/plugins/wp-api-json-feed/#description)
 * [Reviews](https://kea.wordpress.org/plugins/wp-api-json-feed/#reviews)
 *  [Installation](https://kea.wordpress.org/plugins/wp-api-json-feed/#installation)
 * [Development](https://kea.wordpress.org/plugins/wp-api-json-feed/#developers)

 [Support](https://wordpress.org/support/plugin/wp-api-json-feed/)

## Description

Implements JSON feeds following the official JSON feed specification by using the
WordPress REST API. By default, only a JSON feed for regular posts is added. This
can be easily customized to also provide JSON feeds for e.g. certain custom post
types.

 * Adds JSON feeds following the official [version 1.1 spec](https://jsonfeed.org/version/1.1).
 * Adds a JSON feed for posts to the REST API by default (e.g. at `/wp-json/feed/
   v1/posts`).
 * Allows adding JSON feeds for other post types by using a `show_json_feed` argument
   when registering the post type.
 * Places a link tag to the current feed inside the HTML head tag.
 * Maintains backward compatibility with the previous JSON feed [version 1 spec](https://www.jsonfeed.org/version/1/).
 * Contains extensive 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.

#### Administration

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

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

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 optionally 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.

Here is an example, supporting a JSON feed for a custom post type “article” and 
setting its feed base to “articles” so that the feed will appear at `{restURL}/feed/
v1/articles`.

    ```
    <?php

    add_filter(
        'register_post_type_args',
        function ( $args, $post_type ) {
            if ( 'article' === $post_type ) {
                $args['show_json_feed'] = true;
                $args['json_feed_base'] = 'articles';
            }
            return $args;
        },
        10,
        2
    );
    ```

### Why does the JSON feed contain fields which are not part of the schema?

Since the JSON feed schema is always future compatible, by default the plugin preserves
backward compatibility with older JSON feed readers by maintaining deprecated fields
such as `author`. You can skip this backward compatibility behavior by using the`
wp_api_json_feed_skip_backward_compatibility` filter and returning `true`.

### Where should I submit my support request?

For regular support requests, please use the [wordpress.org support forums](https://wordpress.org/support/plugin/wp-api-json-feed).
If you have a technical issue with the plugin where you already have more insight
on how to fix it, you can also [open an issue on GitHub instead](https://github.com/felixarntz/wp-api-json-feed/issues).

### How can I contribute to the plugin?

If you have 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](https://github.com/felixarntz/wp-api-json-feed).
Please stick to the [contributing guidelines](https://github.com/felixarntz/wp-api-json-feed/blob/main/CONTRIBUTING.md).

You can also contribute to the plugin by translating it. Simply visit [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/wp-api-json-feed)
to get started.

## Reviews

There are no reviews for this plugin.

## Contributors & Developers

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

Contributors

 *   [ Felix Arntz ](https://profiles.wordpress.org/flixos90/)

[Translate “WP-API JSON Feed” into your language.](https://translate.wordpress.org/projects/wp-plugins/wp-api-json-feed)

### Interested in development?

[Browse the code](https://plugins.trac.wordpress.org/browser/wp-api-json-feed/),
check out the [SVN repository](https://plugins.svn.wordpress.org/wp-api-json-feed/),
or subscribe to the [development log](https://plugins.trac.wordpress.org/log/wp-api-json-feed/)
by [RSS](https://plugins.trac.wordpress.org/log/wp-api-json-feed/?limit=100&mode=stop_on_copy&format=rss).

## Changelog

#### 1.1.0

 * Added: Add support for the [JSON feed 1.1 spec](https://jsonfeed.org/version/1.1).
 * Added: Introduce filter `wp_api_json_feed_skip_backward_compatibility` to optionally
   skip JSON feed fields included for backward compatibility with [JSON feed 1.0 spec](https://jsonfeed.org/version/1).
 * Enhanced: Include a `<link>` tag for the most relevant JSON feed based on the
   current content, in addition to the general posts JSON feed.
 * Enhanced: Include a `user_comment` field in the JSON feeds.
 * Tweaked: Bump the minimum required WordPress and PHP versions.
 * Tweaked: Use modern test infrastructure including revised PHPUnit tests, and 
   GitHub Actions to ensure long-term stability.
 * Fixed: Remove unnecessary call to `load_plugin_textdomain()`.

#### 1.0.0

 * First stable version

## Meta

 *  Version **1.1.0**
 *  Last updated **4 months ago**
 *  Active installations **40+**
 *  WordPress version ** 5.4 or higher **
 *  Tested up to **6.9.4**
 *  PHP version ** 5.6 or higher **
 *  Language
 * [English (US)](https://wordpress.org/plugins/wp-api-json-feed/)
 * Tags
 * [feed](https://kea.wordpress.org/plugins/tags/feed/)[json feed](https://kea.wordpress.org/plugins/tags/json-feed/)
   [rest-api](https://kea.wordpress.org/plugins/tags/rest-api/)
 *  [Advanced View](https://kea.wordpress.org/plugins/wp-api-json-feed/advanced/)

## Ratings

No reviews have been submitted yet.

[Add my review](https://wordpress.org/support/plugin/wp-api-json-feed/reviews/#new-post)

[See all reviews](https://wordpress.org/support/plugin/wp-api-json-feed/reviews/)

## Contributors

 *   [ Felix Arntz ](https://profiles.wordpress.org/flixos90/)

## Support

Got something to say? Need help?

 [View support forum](https://wordpress.org/support/plugin/wp-api-json-feed/)

## Donate

Would you like to support the advancement of this plugin?

 [ Donate to this plugin ](https://felix-arntz.me/wordpress-plugins/)