https://github.com/manton/jsonfeed-wp

WordPress plugin to add a JSON Feed to your site.
https://github.com/manton/jsonfeed-wp

Last synced: 3 months ago
JSON representation

WordPress plugin to add a JSON Feed to your site.

• Host: GitHub
• URL: https://github.com/manton/jsonfeed-wp
• Owner: manton
• License: gpl-2.0
• Created: 2017-05-15T16:51:21.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T13:41:04.000Z (7 months ago)
• Last Synced: 2024-04-24T18:26:14.898Z (7 months ago)
• Language: PHP
• Homepage: https://jsonfeed.org/
• Size: 101 KB
• Stars: 187
• Watchers: 20
• Forks: 33
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html

Adds feeds in JSON Feed format.

## Description

Adds a JSON Feed to your WordPress site by adding `/feed/json` to any URL.

The JSON Feed format is a pragmatic syndication format, like RSS and Atom, but with one big difference: it's JSON instead of XML. Learn more at [jsonfeed.org](http://jsonfeed.org/).

## Installation

1. Upload the plugin files to the `/wp-content/plugins/jsonfeed` directory, or install the plugin through the WordPress plugins screen directly.

1. Activate the plugin through the 'Plugins' screen in WordPress

## Frequently Asked Questions

### What is JSONFeed?

JSON Feed, a format similar to RSS and Atom but in JSON. JSON has become the developers’ choice for APIs, and that developers will often go out of their way to avoid XML.

JSON is simpler to read and write, and it’s less prone to bugs.

### Can I add other fields to the feed?

Yes you can! There is a filter, `json_feed_item`, that allows you to modify the items in the feed just before they're inserted into the feed itself. For example, if you want to add a link to a post author's archive page to the respective item in the feed, you can use the following code:

```

function wp_custom_json_feed_fields( $feed_item, $post ){

    $feed_item['author']['archive_link'] = get_author_posts_url( $post->post_author );

    return $feed_item;

}

add_filter( 'json_feed_item', 'wp_custom_json_feed_fields', 10, 2);

```

### Can I write information to my posts?

This is a syndication format, which means it only represents your posts and comments as feed elements. This is read only, similar to RSS or Atom. It is not an API.

## Changelog

### 1.4.5

* Sanity check on $max_page

* Add filter `jsonfeed_comments_feed_enable`, which if set to false will disable the comments feed header.

* Add mime type for jsonfeed to filter for W3C Cache Plugin per GitHub issue 67. 

### 1.4.4

* Fix declaration error

### 1.4.3

* Add next_url

* Add CORS header

### 1.4.2

* Update WebSub support

### 1.4.1

* Added author field back for compatibility with JSON Feed 1.0.

### 1.4.0

* Switch to using GUID for the ID

* Update to the JSONFeed 1.1 standard

* Use the RSS versions of title functions to allow these filters to be used

### 1.3.1

* Fix attachment array

* Replace custom function with backcompat of function introduced into Core

### 1.3.0

* Add comments template

* JSONFeed icon now part of repo

* Allow for multiple attachments

* Respect summary setting

* Add support for extra feeds in header

### 1.2.0

* dshanske added as a contributor/maintainer

* Add featured image if set

* Add site icon if set

* home_page_url now actually returns the correct URL instead of always returning the homepage of the site

* Add avatar and URL to author

* Include site name in feed name in the discovery title

* Fix issue with timezone not reflecting on date

### 1.1.2

### 1.1.1

### 1.0

* Initial release