Braad

<p><strong>Note:</strong> You probably do not need this plugin. The REST API already supports adding the query param <code>?_embed</code> to your URL and the response will then include all “embedded media”, including the featured image, and the data you get there is exactly what this plugin gives you. The only reasons to use this plugin at this point are if you prefer to have the featured image data in a top level field in the response rather than among other embedded media in the <code>_embedded</code> field, and if you <em>always</em> want the featured image data in the response rather than having to ask for it with <code>?_embed</code>. I still use this plugin because I do usually want both these things, but definitely give <code>?_embed</code> a try before using this plugin. 🙂</p>
<p>Version 2 of the WordPress REST API returns a <code>featured_media</code> field (formerly featured_image) on the post object by default, but this field is simply the image ID.</p>
<p>This plugin adds a <code>better_featured_image</code> field to the post object that contains the available image sizes and urls, allowing you to get this information without making a second request.</p>
<p>It takes this:</p>
<pre><code>"featured_media": 13,
</code></pre>
<p>And turns it into this:</p>
<pre><code>"featured_media": 13,
"better_featured_image": {
    "id": 13,
    "alt_text": "Hot Air Balloons",
    "caption": "The event featured hot air balloon rides",
    "description": "The hot air balloons from the big event",
    "media_type": "image",
    "media_details": {
      "width": 5760,
      "height": 3840,
      "file": "2015/09/balloons.jpg",
      "sizes": {
        "thumbnail": {
          "file": "balloons-150x150.jpg",
          "width": 150,
          "height": 150,
          "mime-type": "image/jpeg",
          "source_url": "http://api.example.com/wp-content/uploads/2015/09/balloons-150x150.jpg"
        },
        "medium": {
          "file": "balloons-300x200.jpg",
          "width": 300,
          "height": 200,
          "mime-type": "image/jpeg",
          "source_url": "http://api.example.com/wp-content/uploads/2015/09/balloons-300x200.jpg"
        },
        "large": {
          "file": "balloons-1024x683.jpg",
          "width": 1024,
          "height": 683,
          "mime-type": "image/jpeg",
          "source_url": "http://api.example.com/wp-content/uploads/2015/09/balloons-1024x683.jpg"
        },
        "post-thumbnail": {
          "file": "balloons-825x510.jpg",
          "width": 825,
          "height": 510,
          "mime-type": "image/jpeg",
          "source_url": "http://api.example.com/wp-content/uploads/2015/09/balloons-825x510.jpg"
        }
      },
      "image_meta": {
        "aperture": 6.3,
        "credit": "",
        "camera": "Canon EOS 5D Mark III",
        "caption": "",
        "created_timestamp": 1433110262,
        "copyright": "",
        "focal_length": "50",
        "iso": "100",
        "shutter_speed": "0.004",
        "title": "",
        "orientation": 1
      }
    },
    "post": null,
    "source_url": "http://api.example.com/wp-content/uploads/2015/09/balloons.jpg"
},
</code></pre>
<p>The format of the response is nearly identical to what you would get sending a request to <code>/wp-json/wp/v2/media/13</code> or using <code>?_embed</code>. When no featured image has been set on the post the <code>better_featured_image</code> field will have a value of <code>null</code>.</p>
<p>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 <code>/media/</code>, especially for multiple posts.</p>
<p>As of version 1.1.0, there is a filter <code>better_rest_api_featured_image</code> 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:</p>
<pre><code>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;
}
</code></pre>
<p>This plugin is on <a href="https://github.com/BraadMartin/better-rest-api-featured-images" title="Better REST API Featured Images" rel="nofollow ugc">on Github</a> and pull requests are always welcome. 🙂</p>


Better REST API Featured Images

Does what id says, and it helps me a lot while building the theme in Angular2. Only one GET to have Post and Featured Image details!



Perfect! Must be in the API core

The Plugin works very well and saves time, thanks!



Works also with REST API V2

Thanks Martin.
This plugin does excectly what is says it would do.
And this should definitely be integrated in the main api code!!!



Great plugin, why is this not in the default API?

Awesome

Adds a top-level field with featured image data including available sizes and URLs to the post object returned by the REST API.

berkux

<p>The simplest method to link WordPress with external APIs</p>
<p>JCI simplifies the task of retrieving data from a third-party REST API. The returned JSON-, XML, CSV, TXT-data can be neatly arranged and showcased on your WordPress site via a shortcode, a JCI Block or PHP. The plugin can generate a template for the data display.</p>
<p>20 seconds: Load API and display data</p>
<p><span class="embed-youtube" style="text-align:center; display: block;"><iframe loading="lazy" class="youtube-player" width="750" height="422" src="https://www.youtube.com/embed/RBlrAUVywAk?version=3&rel=1&showsearch=0&showinfo=1&iv_load_policy=1&fs=1&hl=en-US&autohide=2&wmode=transparent" allowfullscreen="true" style="border:0;" sandbox="allow-scripts allow-same-origin allow-popups allow-presentation allow-popups-to-escape-sandbox"></iframe></span></p>
<p>7 minutes: Basic intro to JCI free</p>
<p><span class="embed-youtube" style="text-align:center; display: block;"><iframe loading="lazy" class="youtube-player" width="750" height="422" src="https://www.youtube.com/embed/SDUj1teNG2s?version=3&rel=1&showsearch=0&showinfo=1&iv_load_policy=1&fs=1&hl=en-US&autohide=2&wmode=transparent" allowfullscreen="true" style="border:0;" sandbox="allow-scripts allow-same-origin allow-popups allow-presentation allow-popups-to-escape-sandbox"></iframe></span></p>
<h3>Examples, Preview</h3>
<p>Check out the live demonstration to explore how we’re interfacing with various APIs<br />
<a href="https://api.json-content-importer.com/free-jci-plugin-example/wetter/" rel="nofollow ugc">LIVE PREVIEW – WordPress and a external API</a></p>
<p><a href="https://www.youtube.com/watch?v=GJGBPvaKZsk" rel="nofollow ugc">Video: How to use the Wikipedia API</a></p>
<h3>Main Plugin Features</h3>
<ul>
<li>Low code usage: Save time and avoid coding using an API</li>
<li>Insert an API-URL into Step 1: Data is loaded, and and displayed. Save it as API-Access-Set.</li>
<li>Use the API-Access-Set in Step 2 to create a Shortcode</li>
<li>Optional for maximum flexibility: Use the API-Access-Set n PHP code</li>
<li>Insert an API-URL into the JCI Block: Data is loaded, and a template can be generated to display the data.</li>
<li>Easy to start: Check Installation – Is your WordPress ready for JCI? Most probably!</li>
<li>Basic Settings: Check SSL, Cacher, Gutenberg and Authentication</li>
<li>ContactForm7 Integration: Populate CF7 forms with JSON data and forward CF7-submitted data to an API.</li>
<li>Use the JCI cacher to avoid many API requests</li>
<li>JCI-Block :  Use the simple JCI Block interface to get data! Query the API and check the response. Then utilize the simple template generator inside the JCI Block to use the data!</li>
<li>Contact Form 7 Integration: Fill form and submit to API</li>
</ul>
<h3>Important Note Starting with Version 2.0.11</h3>
<p>Starting with version 2.0.11, any HTML code present in the shortcode or block is filtered to prevent dangerous code (e.g. JavaScript) from being output.<br />
However, if you want to allow certain tags or attributes as a deliberate choice:<br />
In the plugin’s “Basic Settings” there is a field called “Allow additional HTML tags (advanced)”.<br />
There you can enter comma-separated tags that should not be filtered out. For example, “iframe,script” would preserve these two tags in the HTML output.<br />
“tr#onclick” would preserve the “onclick” attribute in ”, which would otherwise be removed.</p>
<h3>Documentation</h3>
<p>There’s a wealth of resources and support at your fingertips. Explore the articles listed below to begin your journey:</p>
<ul>
<li><a href="https://doc.json-content-importer.com/" rel="nofollow ugc">JCI Manual</a></li>
<li><a href="https://doc.json-content-importer.com/json-content-importer/step-1-data-access/" rel="nofollow ugc">Step 1: Access the Data</a></li>
<li><a href="https://doc.json-content-importer.com/json-content-importer/step-2-data-usage/" rel="nofollow ugc">Step 2: Using the Data</a></li>
<li><a href="https://doc.json-content-importer.com/json-content-importer/shortcode-basic-structure/" rel="nofollow ugc">Shortcode – Basic structure</a></li>
<li><a href="https://doc.json-content-importer.com/json-content-importer/pro-contactform7/" rel="nofollow ugc">Contact Form 7 Integration</a></li>
<li><a href="https://doc.json-content-importer.com/json-content-importer/free-overview-videos/" rel="nofollow ugc">Free JCI Plugin: Overview Videos</a></li>
<li><a href="https://doc.json-content-importer.com/json-content-importer/basic-start/" rel="nofollow ugc">Free JCI Plugin: Getting Started</a></li>
</ul>
<h3>You need more?</h3>
<h4>JSON Content Importer PRO</h4>
<p>Both the free and PRO JCI Plugins serve the same purpose: retrieving data, transforming it, and publishing the results.<br />
However, while the free Plugin can only handle basic challenges, the PRO JCI Plugin offers nearly full control over WordPress, the database, and applications.<br />
<a href="https://json-content-importer.com/compare/" rel="nofollow ugc">Compare: Free vs. JCI PRO Plugin</a></p>
<p>PRO features:<br />
* application building by creating a searchform and connect it to a JSON-API in the background: pass GET-Variables to use a dynamic JSON-Feed-URL (“talk to API / webservice”)<br />
* much better and more flexible templateengine: twig<br />
* create and use Custom Post Types<br />
* store Templates independent of pages<br />
* more Shortcode-Parameters<br />
* executing Shortcodes inside a template<br />
* more features…</p>


Get Use APIs – JSON Content Importer


All I wanted to do is display the latest version number of my own plugin on my site.  I could have spent hours coding it myself, instead I spent 5 minutes installing and working out this plugin.  Great work Bernhard


Easy Peasy


learning curve is very steep with the plugin but it simply works and i fell in love with it! i use it for everything: fetching flight prices, weather data, syncing wordpress blocks / content across different sites / domain through wp rest api to name a few!


such a clever plugin

Connects an API to WordPress: Get API-data (JSON, XML, CSV...), show it with a Shortcode, a JCI Block or PHP. Generate a template with the JCI Block

Better REST API Featured Images vs Get Use APIs – JSON Content Importer