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.<\/p>\n\n
\/wp-json\/feed\/v1\/posts<\/code>).<\/li>\n- Allows adding JSON feeds for other post types by using a
show_json_feed<\/code> argument when registering the post type.<\/li>\n- Places a link tag to the current feed inside the HTML head tag.<\/li>\n
- Maintains backward compatibility with the previous JSON feed version 1 spec<\/a>.<\/li>\n
- Contains extensive filters to modify the feed responses as necessary.<\/li>\n<\/ul>\n\n\n
\n- Upload the entire
wp-api-json-feed<\/code> folder to the \/wp-content\/plugins\/<\/code> directory or download it through the WordPress backend.<\/li>\n- Activate the plugin through the 'Plugins' menu in WordPress.<\/li>\n<\/ol>\n\n
Administration<\/h4>\n\n
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<\/code> when registering the post type, and set it to a boolean true<\/code>. You may also specify a json_feed_base<\/code> 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.<\/p>\n\n\n\nHow can I add a feed for my custom post type?<\/h3><\/dt>\nTo provide a JSON feed for your custom post type, you need to specify an additional argument show_json_feed<\/code> when registering the post type, and set it to a boolean true<\/code>. You may optionally specify a json_feed_base<\/code> 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.<\/p>\n\nHere 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<\/code>.<\/p>\n\n<?php\n\nadd_filter(\n 'register_post_type_args',\n function ( $args, $post_type ) {\n if ( 'article' === $post_type ) {\n $args['show_json_feed'] = true;\n $args['json_feed_base'] = 'articles';\n }\n return $args;\n },\n 10,\n 2\n);\n<\/code><\/pre><\/dd>\nWhy does the JSON feed contain fields which are not part of the schema?<\/h3><\/dt>\nSince 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<\/code>. You can skip this backward compatibility behavior by using the wp_api_json_feed_skip_backward_compatibility<\/code> filter and returning true<\/code>.<\/p><\/dd>\nWhere should I submit my support request?<\/h3><\/dt>\nFor regular support requests, please use the wordpress.org support forums<\/a>. 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<\/a>.<\/p><\/dd>\nHow can I contribute to the plugin?<\/h3><\/dt>\nIf 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<\/a>. Please stick to the contributing guidelines<\/a>.<\/p>\n\nYou can also contribute to the plugin by translating it. Simply visit translate.wordpress.org<\/a> to get started.<\/p><\/dd>\n\n<\/dl>\n\n\n1.1.0<\/h4>\n\n\n- Added: Add support for the JSON feed 1.1 spec<\/a>.<\/li>\n
- Added: Introduce filter
wp_api_json_feed_skip_backward_compatibility<\/code> to optionally skip JSON feed fields included for backward compatibility with JSON feed 1.0 spec<\/a>.<\/li>\n- Enhanced: Include a
<link><\/code> tag for the most relevant JSON feed based on the current content, in addition to the general posts JSON feed.<\/li>\n- Enhanced: Include a
user_comment<\/code> field in the JSON feeds.<\/li>\n- Tweaked: Bump the minimum required WordPress and PHP versions.<\/li>\n
- Tweaked: Use modern test infrastructure including revised PHPUnit tests, and GitHub Actions to ensure long-term stability.<\/li>\n
- Fixed: Remove unnecessary call to
load_plugin_textdomain()<\/code>.<\/li>\n<\/ul>\n\n1.0.0<\/h4>\n\n\n- First stable version<\/li>\n<\/ul>","raw_excerpt":"Implements JSON feeds following the official JSON feed specification by using the WordPress REST API.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/69077","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=69077"}],"author":[{"embeddable":true,"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/flixos90"}],"wp:attachment":[{"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=69077"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=69077"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=69077"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=69077"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=69077"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/test.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=69077"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}