WP-API JSON Feed

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

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. Please stick to the contributing guidelines.

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