Changeset 1335458

Timestamp:

01/25/2016 11:49:28 AM (10 years ago)

Author:

Braad

Message:

Version 1.1.0, now with a better_rest_api_featured_image filter

Location:

better-rest-api-featured-images

Files:

• tags/1.1.0 (added)
• tags/1.1.0/Gruntfile.js (added)
• tags/1.1.0/better-rest-api-featured-images.php (added)
• tags/1.1.0/languages (added)
• tags/1.1.0/languages/better-rest-api-featured-images.pot (added)
• tags/1.1.0/package.json (added)
• tags/1.1.0/readme.md (added)
• tags/1.1.0/readme.txt (added)
• trunk/better-rest-api-featured-images.php (modified) (2 diffs)
• trunk/languages/better-rest-api-featured-images.pot (modified) (1 diff)
• trunk/readme.md (modified) (4 diffs)
• trunk/readme.txt (modified) (4 diffs)

better-rest-api-featured-images/trunk/better-rest-api-featured-images.php

@@ -11 +11 @@
  * Plugin URI:          https://wordpress.org/plugins/better-rest-api-featured-images/
  * Description:         Enhances the featured image data returned on the post object by the REST API to include urls for all available sizes and other useful image data.
- * Version:             1.0.2
+ * Version:             1.1.0
  * Author:              Braad Martin
  * Author URI:          http://braadmartin.com
@@ -110 +110 @@
     }
 
-    return $featured_image;
+    return apply_filters( 'better_rest_api_featured_image', $featured_image, $image_id );
 }

better-rest-api-featured-images/trunk/languages/better-rest-api-featured-images.pot

@@ -1 @@
-# Copyright (C) 2015 Braad Martin
+# Copyright (C) 2016 Braad Martin
 # This file is distributed under the GPL-2.0+.
 msgid ""
 msgstr ""
-"Project-Id-Version: Better REST API Featured Images 1.0.1\n"
+"Project-Id-Version: Better REST API Featured Images 1.1.0\n"
 "Report-Msgid-Bugs-To: "
 "https://wordpress.org/support/plugin/better-rest-api-featured-images\n"
-"POT-Creation-Date: 2015-10-27 15:40:55+00:00\n"
+"POT-Creation-Date: 2016-01-25 11:33:53+00:00\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"PO-Revision-Date: 2015-MO-DA HO:MI+ZONE\n"
+"PO-Revision-Date: 2016-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"

better-rest-api-featured-images/trunk/readme.md

@@ -5 +5 @@
 **Requires at least:** 4.0  
 **Tested up to:** 4.4  
-**Stable tag:** 1.0.2  
+**Stable tag:** 1.1.0  
 **License:** GPLv2 or later  
 **License URI:** http://www.gnu.org/licenses/gpl-2.0.html  
@@ -90 +90 @@
 I've done some basic performance tests that indicate the difference in response times with and without this plugin to be about 10-15ms for a collection of 10 posts and 0-5ms for a single post. For me this is much faster than making a second request to `/media/`, especially for multiple posts.
 
+As of version 1.1.0, there is a filter `better_rest_api_featured_image` that allows you to add custom data to the better_featured_image field. The filter is directly on the return value of the function that returns the better_featured_image field. This can be used to do things like add custom image meta or an SVG version of the image to the response. Here's an example of how you might use it:
+
+
+    add_filter( 'better_rest_api_featured_image', 'xxx_modify_rest_api_featured_image', 10, 2 );
+    /**
+     * Modify the Better REST API Featured Image response.
+     *
+     * @param   array  $featured_image  The array of image data.
+     * @param   int    $image_id        The image ID.
+     *
+     * @return  array                   The modified image data.
+     */
+    function xxx_modify_rest_api_featured_image( $featured_image, $image_id ) {
+    
+      // Add an extra_data_string field with a string value.
+      $featured_image['extra_data_string'] = 'A custom value.';
+    
+      // Add an extra_data_array field with an array value.
+      $featured_image['extra_data_array'] = array(
+        'custom_key' => 'A custom value.',
+      );
+    
+      return $featured_image;
+    }
+
+
 This plugin is on [on Github](https://github.com/BraadMartin/better-rest-api-featured-images "Better REST API Featured Images") and pull requests are always welcome. :)
 
@@ -120 +146 @@
 ## Changelog ##
 
+### 1.1.0 ###
+* Add a better_rest_api_featured_image filter for adding custom data to the response. Props: avishayil
+
 ### 1.0.2 ###
 * Change register_api_field to register_rest_field for compatibility with the REST API v2 beta 9. Props: Soean
@@ -131 +160 @@
 ## Upgrade Notice ##
 
+### 1.1.0 ###
+* Add a better_rest_api_featured_image filter for adding custom data to the response. Props: avishayil
+
 ### 1.0.2 ###
 * Change register_api_field to register_rest_field for compatibility with the REST API v2 beta 9. Props: Soean

better-rest-api-featured-images/trunk/readme.txt

@@ -5 +5 @@
 Requires at least: 4.0
 Tested up to: 4.4
-Stable tag: 1.0.2
+Stable tag: 1.1.0
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
@@ -90 +90 @@
 I've done some basic performance tests that indicate the difference in response times with and without this plugin to be about 10-15ms for a collection of 10 posts and 0-5ms for a single post. For me this is much faster than making a second request to `/media/`, especially for multiple posts.
 
+As of version 1.1.0, there is a filter `better_rest_api_featured_image` that allows you to add custom data to the better_featured_image field. The filter is directly on the return value of the function that returns the better_featured_image field. This can be used to do things like add custom image meta or an SVG version of the image to the response. Here's an example of how you might use it:
+
+`
+add_filter( 'better_rest_api_featured_image', 'xxx_modify_rest_api_featured_image', 10, 2 );
+/**
+ * Modify the Better REST API Featured Image response.
+ *
+ * @param   array  $featured_image  The array of image data.
+ * @param   int    $image_id        The image ID.
+ *
+ * @return  array                   The modified image data.
+ */
+function xxx_modify_rest_api_featured_image( $featured_image, $image_id ) {
+
+  // Add an extra_data_string field with a string value.
+  $featured_image['extra_data_string'] = 'A custom value.';
+
+  // Add an extra_data_array field with an array value.
+  $featured_image['extra_data_array'] = array(
+    'custom_key' => 'A custom value.',
+  );
+
+  return $featured_image;
+}
+`
+
 This plugin is on [on Github](https://github.com/BraadMartin/better-rest-api-featured-images "Better REST API Featured Images") and pull requests are always welcome. :)
 
@@ -120 +146 @@
 == Changelog ==
 
+= 1.1.0 =
+* Add a better_rest_api_featured_image filter for adding custom data to the response. Props: avishayil
+
 = 1.0.2 =
 * Change register_api_field to register_rest_field for compatibility with the REST API v2 beta 9. Props: Soean
@@ -131 +160 @@
 == Upgrade Notice ==
 
+= 1.1.0 =
+* Add a better_rest_api_featured_image filter for adding custom data to the response. Props: avishayil
+
 = 1.0.2 =
 * Change register_api_field to register_rest_field for compatibility with the REST API v2 beta 9. Props: Soean