Changeset 1950873

Timestamp:

10/03/2018 01:36:27 PM (7 years ago)

Author:

mantonr

Message:

Updated with version 1.2 changes.

Location:

jsonfeed/trunk

Files:

• LICENSE (added)
• README.md (modified) (1 diff)
• composer.json (added)
• feed-template.php (modified) (3 diffs)
• jsonfeed-wp.php (modified) (2 diffs)
• phpcs.xml (added)
• readme.txt (modified) (2 diffs)

jsonfeed/trunk/README.md

@@ -1 @@
-# JSON Feed plugin for WordPress
 
-Adds a `/feed/json` URL to your WordPress site. Drop the plugin folder in /wp-content/plugins and activate under WP Admin → Plugins.
+Adds a feed of recent posts in JSON Feed format.
+
+
+## Description 
+
+Adds a `/feed/json` URL to your WordPress site.
 
 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.
+
+
+## Changelog 
+
+
+### 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
+

jsonfeed/trunk/feed-template.php

@@ -1 +1 @@
 <?php
 
-//via http://www.tequilafish.com/2009/02/10/php-how-to-capture-output-of-echo-into-a-local-variable/
-ob_start();
-self_link();
-$self_link = ob_get_contents();
-ob_end_clean();
+
+// Reproduction of self_link with a return and without URL escaping
+function get_json_self_link() {
+    $host = wp_parse_url( home_url() );
+    return apply_filters( 'self_link', set_url_scheme( 'http://' . $host['host'] . wp_unslash( $_SERVER['REQUEST_URI'] ) ) );
+}
 
 function get_attachment_json_info() {
-    if ( post_password_required() )
+    if ( post_password_required() ) {
         return null;
+    }
 
     foreach ( (array) get_post_custom() as $key => $val ) {
-        if ($key == 'enclosure') {
+        if ( 'enclosure' === $key ) {
             foreach ( (array) $val as $enc ) {
-                $enclosure = explode("\n", $enc);
+                $enclosure = explode( "\n", $enc );
 
                 // only get the first element, e.g. audio/mpeg from 'audio/mpeg mpga mp2 mp3'
-                $t = preg_split('/[ \t]/', trim($enclosure[2]) );
+                $t    = preg_split( '/[ \t]/', trim( $enclosure[2] ) );
                 $type = $t[0];
 
                 return array(
-                    'url' => trim( $enclosure[0] ),
-                    'mime_type' => $type,
-                    'size_in_bytes' => (int)$enclosure[1]
+                    'url'           => trim( $enclosure[0] ),
+                    'mime_type'     => $type,
+                    'size_in_bytes' => (int) $enclosure[1],
                 );
             }
         }
     }
+}
+
+function get_link_from_json_feed( $link ) {
+    global $wp_rewrite;
+    $arg = $wp_rewrite->get_feed_permastruct();
+    // If empty this site does not have pretty permalinks enabled
+    if ( empty( $arg ) ) {
+        wp_parse_str( wp_parse_url( $link, PHP_URL_QUERY ), $query_args );
+        unset( $query_args['feed'] );
+        return add_query_arg( $query_args, home_url( '/' ) );
+    } else {
+        $arg  = str_replace( '%feed%', 'json', $arg );
+        $arg  = preg_replace( '#/+#', '/', "/$arg" );
+        $link = str_replace( $arg, '', $link );
+    }
+    return $link;
+}
+
+function json_get_merged_tags( $post_id = null ) {
+    $post       = get_post( $post_id );
+    $tags       = get_the_terms( $post, 'post_tag' );
+    $categories = get_the_terms( $post, 'category' );
+    $tags       = is_array( $tags ) ? $tags : array();
+    $categories = is_array( $categories ) ? $categories : array();
+    // $tags = array_merge( $tags, $categories );
+    $return = array();
+    foreach ( $tags as $tag ) {
+        if ( 'uncategorized' !== $tag->slug ) {
+            $return[] = $tag->name;
+        }
+    }
+    return $return;
 }
 
@@ -36 +70 @@
 
     $feed_item = array(
-        'id' => get_permalink(),
-        'url' => get_permalink(),
-        'title' => get_the_title(),
-        'content_html' => get_the_content_feed( 'json' ),
-        'date_published' => get_gmt_from_date( get_the_date( 'Y-m-d H:i:s' ), 'c' ),
-        'date_modified' => get_gmt_from_date( get_the_modified_date( 'Y-m-d H:i:s' ), 'c' ),
-        'author' => array(
-            'name' => get_the_author(),
+        'id'             => get_permalink(),
+        'url'            => get_permalink(),
+        'title'          => html_entity_decode( get_the_title() ),
+        'content_html'   => get_the_content_feed( 'json' ),
+        'content_text'   => wp_strip_all_tags( get_the_content_feed( 'json' ) ),
+        'date_published' => get_the_date( 'Y-m-d\TH:i:sP' ),
+        'date_modified'  => get_the_modified_date( 'Y-m-d\TH:i:sP' ),
+        'author'         => array(
+            'name'   => get_the_author(),
+            'url'    => get_author_posts_url( get_the_author_meta( 'ID' ) ),
+            'avatar' => get_avatar_url( get_the_author_meta( 'ID' ), array( 'size' => 512 ) ),
         ),
+        'image'          => get_the_post_thumbnail_url( null, 'full' ), // If there is a set featured image
+        'tags'           => json_get_merged_tags(), // Tags is a merge of the category and the tags names
     );
-    
+    // Only add custom excerpts not generated ones
+    if ( has_excerpt() ) {
+        $feed_item['summary'] = get_the_excerpt();
+    }
+    // If anything is an empty string or null then remove it
+    $feed_item = array_filter( $feed_item );
+
     $attachment = get_attachment_json_info();
-    if ( $attachment != null ) {
-        $feed_item["attachments"] = array(
-            $attachment
+    if ( null !== $attachment ) {
+        $feed_item['attachments'] = array(
+            $attachment,
         );
     }
@@ -58 +103 @@
 
 $feed_json = array(
-    'version' => 'https://jsonfeed.org/version/1',
-    'user_comment' => 'This feed allows you to read the posts from this site in any feed reader that supports the JSON Feed format. To add this feed to your reader, copy the following URL -- ' . $self_link . ' -- and add it your reader.',
-    'home_page_url' => get_home_url(),
-    'feed_url' => $self_link,
-    'title' => get_bloginfo( 'name' ),
-    'description' => get_bloginfo( 'description' ),
-    'items' => $feed_items,
+    'version'       => 'https://jsonfeed.org/version/1',
+    'user_comment'  => 'This feed allows you to read the posts from this site in any feed reader that supports the JSON Feed format. To add this feed to your reader, copy the following URL -- ' . get_json_self_link() . ' -- and add it your reader.',
+    'home_page_url' => get_link_from_json_feed( get_json_self_link() ),
+    'feed_url'      => get_json_self_link(),
+    'title'         => get_bloginfo( 'name' ),
+    'description'   => get_bloginfo( 'description' ),
+    'items'         => $feed_items,
 );
+
+$icon = get_site_icon_url();
+
+// Only add icon if icon is set
+if ( $icon ) {
+    $feed_json['icon'] = $icon;
+}
 
 $feed_json = apply_filters( 'json_feed_feed', $feed_json );
 
+// The JSON_PRETTY_PRINT and JSON_UNESCAPED slashes make the minimum version requirement on this PHP5.4
 echo wp_json_encode( $feed_json, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES );

jsonfeed/trunk/jsonfeed-wp.php

@@ -1 +1 @@
 <?php
 /*
-Plugin Name: JSON Feed (jsonfeed.org)
-Plugin URI: http://jsonfeed.org
+Plugin Name: JSON Feed
+Plugin URI: https://github.com/manton/jsonfeed-wp/
 Description: Adds a feed of recent posts in JSON Feed format.
-Version: 1.1.2
+Version: 1.2.0
 Author: Manton Reece and Daniel Jalkut
 Text Domain: jsonfeed
-License: GPL2+
+License: GPL2.0+
+License URI: http://www.gnu.org/licenses/gpl-2.0.txt
 */
 
-defined( 'ABSPATH' ) or die( "WordPress plugin can't be loaded directly." );
+defined( 'ABSPATH' ) || die( "WordPress plugin can't be loaded directly." );
 
 // Flush the rewrite rules to enable the json feed permalink
@@ -39 +40 @@
 function json_feed_link() {
     printf(
-        '<link rel="alternate" type="application/json" title="JSON Feed" href="%s" />',
+        '<link rel="alternate" type="application/json" title="%s &raquo; JSON Feed" href="%s" />',
+        esc_attr( get_bloginfo( 'name' ) ),
         esc_url( get_feed_link( 'json' ) )
     );
 }
+
+add_filter( 'pubsubhubbub_feed_urls', 'json_feed_websub' );
+function json_feed_websub( $feeds ) {
+    $feeds[] = get_feed_link( 'json' );
+    return $feeds;
+}

jsonfeed/trunk/readme.txt

@@ -1 +1 @@
 === JSON Feed (jsonfeed.org) ===
-Contributors: mantonr, redsweater
-Plugin Name: JSON Feed (jsonfeed.org)
-Plugin URI: https://github.com/manton/jsonfeed-wp
+Contributors: mantonr, redsweater, dshanske
 Tags: jsonfeed, json, feed, feeds
-Version: 1.1.2
 Requires at least: 4.0
-Tested up to: 4.7.5
-Stable tag: trunk
-License: GPL2+
+Tested up to: 4.9.8
+Requires PHP: 5.4
+Stable tag: 1.2.0
+License: GPL-2.0+
+License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
 Adds a feed of recent posts in JSON Feed format.
@@ -17 +16 @@
 
 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.
+
+== Changelog ==
+
+= 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