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.

David Anderson / Team Updraft

DNutbourne

Prashant Baldha

aporter

Venkat Raj

WPGetAPI

<p>Connect WordPress to external APIs, without code.</p>
<p>Easily send data to any API and get data from unlimited 3rd party REST APIs. Format and display the returned data on your WordPress website using a shortcode or a template tag.</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/X50qINEs1yo?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>WPGet API supports virtually all authentication methods including API keys, bearer tokens, basic auth, username/password and <a href="https://wpgetapi.com/downloads/oauth-2-0-authentication/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">OAuth 2.0 authorization</a>.</p>
<h3>Live Examples</h3>
<p>View our live examples of connecting to several different APIs and displaying the data in various unique ways including charts, graphs, tables and weather forecasts.</p>
<p><a href="https://wpgetapi.com/demo-connecting-wordpress-to-external-api/?utm_campaign=Demo&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">LIVE EXAMPLES – Connecting WordPress to external APIs</a></p>
<h3>Major Features</h3>
<ul>
<li>Connect your WordPress website to any REST API</li>
<li>Unlimited APIs & endpoints</li>
<li>No coding required</li>
<li>Display API data using a template tag or shortcode</li>
<li>GET, POST, PUT, PATCH & DELETE methods</li>
<li>Add query string, header & body parameters</li>
</ul>
<h3>Documentation</h3>
<p>We have tons of articles and help available.</p>
<ul>
<li><a href="https://wpgetapi.com/docs/quick-start-guide/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Quick Start Guide</a></li>
<li><a href="https://wpgetapi.com/docs/step-by-step-example/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Step by Step Example</a></li>
<li><a href="https://wpgetapi.com/docs/frequently-asked-questions/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Frequently Asked Questions</a></li>
<li><a href="https://wpgetapi.com/docs/will-this-work-with-my-api/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Will this work with my API?</a></li>
</ul>
<h3>Extending WPGet API</h3>
<h4>PRO Plugin</h4>
<p>The <strong><a href="https://wpgetapi.com/downloads/pro-plugin/?utm_campaign=Pro&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">PRO Plugin</a></strong> provides many extra features that allow you to do some more advanced things with your APIs. Features of the PRO Plugin include:</p>
<ul>
<li>Actions – automate your API when an action happens on your site</li>
<li>Tokens – grab dynamic data without code and send to your API</li>
<li>Dynamic variables – a PHP solution for grabbing dynamic values</li>
<li>Chain API calls</li>
<li>Cache API calls</li>
<li>Format API data into HTML</li>
<li>Retrieve nested data</li>
<li>Base64 encoded auth</li>
<li>XML format</li>
</ul>
<h4>API to Posts Plugin</h4>
<p>The <strong><a href="https://wpgetapi.com/downloads/api-to-posts/?utm_campaign=APItoPosts&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">API to Posts Plugin</a></strong> allows you to import API data and create WooCommerce products or custom posts from this API data. Features of the API to Posts Plugin include:</p>
<ul>
<li>Import API data</li>
<li>Import from unlimited endpoints</li>
<li>Map API data to WordPress fields</li>
<li>Supports custom fields, ACF, tags, categories, custom taxonomies, images and more</li>
<li>Supports all standard WooCommerce fields</li>
<li>Create WooCommerce products from API data</li>
<li>Sync API to WooCommerce products & posts</li>
<li>Set interval of sync from every minutes up to once a week</li>
</ul>
<h4>OAuth 2.0 Authorization</h4>
<p>The <strong><a href="https://wpgetapi.com/downloads/oauth-2-0-authentication/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">OAuth 2.0 Authorization</a></strong> plugin allows authorization of your API through the OAuth 2.0 method.</p>
<h3>WPGet API Integrations</h3>
<p>WPGet API integrates extremely well with other WordPress plugins, allowing you to do some very cool things with your API. Click the links below for more info on these integrations.</p>
<ul>
<li><a href="https://wpgetapi.com/docs/connect-woocommerce-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">WooCommerce to API</a></li>
<li><a href="https://wpgetapi.com/docs/woocommerce-api-product-sync/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">WooCommerce API Product Sync</a></li>
<li><a href="https://wpgetapi.com/docs/send-contact-form-7-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Contact Form 7 send data to API</a></li>
<li><a href="https://wpgetapi.com/docs/send-wpforms-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">WPForms send data to API</a></li>
<li><a href="https://wpgetapi.com/docs/send-gravity-forms-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Gravity Forms send data to API</a></li>
<li><a href="https://wpgetapi.com/docs/using-with-wpdatatables/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Charts & Tables from API data using wpDataTables</a></li>
</ul>
<h3>Translating WPGet API</h3>
<p>You can translate WPGet API into your own language on <a href="https://translate.wordpress.org/projects/wp-plugins/wpgetapi/" rel="nofollow ugc">translate.wordpress.org</a></p>
<p>Here is an article to help <a href="https://make.wordpress.org/polyglots/handbook/translating/first-steps/" rel="nofollow ugc">get started with translations</a></p>


WPGet API – Connect to any external REST API

Connect any REST API to WordPress. WPGet API enables easy API integration, allowing you to display API data without any code.

Better REST API Featured Images vs WPGet API – Connect to any external REST API