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.

miniorange

<p><strong>WordPress REST API endpoints</strong> are <strong>open and unsecured by default</strong> which can be used to access your site data. Secure WordPress APIs from unauthorized users with our <strong><a href="https://plugins.miniorange.com/wordpress-rest-api-authentication" rel="nofollow ugc">JWT Authentication for WP REST APIs plugin</a></strong>.</p>
<p>Our plugin offers below authentication methods to <strong>Protect WP REST API endpoints</strong>:<br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-jwt-authentication-method" rel="nofollow ugc">JWT Authentication</a><br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-basic-authentication-method" rel="nofollow ugc">Basic Authentication</a><br />
– <a href="https://plugins.miniorange.com/rest-api-key-authentication-method" rel="nofollow ugc">API Key Authentication</a><br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-oauth-2-0-authentication-method" rel="nofollow ugc">OAuth 2.0 Authentication</a><br />
– External Token based Authentication 2.0/OIDC/JWT/<a href="https://firebase.google.com/docs/auth/admin/create-custom-tokens" rel="nofollow ugc">Firebase</a> provider’s token authentication methods.</p>
<p>You can authenticate default WordPress endpoints and custom-developed REST endpoints and third-party plugin REST API endpoints like that of <a href="https://wordpress.org/plugins/woocommerce/" rel="ugc">Woocommerce</a>, <a href="https://www.learndash.com/" rel="nofollow ugc">Learndash</a>, <a href="https://wordpress.org/plugins/buddypress/" rel="ugc">Buddypress</a>, <a href="https://www.gravityforms.com/" rel="nofollow ugc">Gravity Forms</a>, <a href="https://wordpress.org/plugins/cart-rest-api-for-woocommerce/" rel="ugc">CoCart</a>, etc.</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/IsyKI7eEV-I?version=3&rel=1&showsearch=0&showinfo=1&iv_load_policy=1&fs=1&hl=en-US&autohide=2&start=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>
<h3>WP REST API Authentication Methods in our plugin</h3>
<ul>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-jwt-authentication-method#step_a1" rel="nofollow ugc">JWT Authentication</a><br />
Provides an endpoint where you can pass the user credentials, and it will generate a JWT (JSON Web Token), which you can use to access the WordPress REST APIs accordingly.<br />
Additionally, to maintain a seamless user experience without frequent logins needed due to token expiry, you can use our <em>Refresh and Revoke token</em> mechanisms feature.<br />
When the access token expires, instead of forcing the user to log in again, the client can request a new access token using a valid refresh token.</li>
<li><a href="https://plugins.miniorange.com/rest-api-key-authentication-method#step_a" rel="nofollow ugc">API Key Authentication</a></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-basic-authentication-method" rel="nofollow ugc">Basic Authentication</a>:<br />
        – 1. <strong>Username: Password</strong><br />
        – 2. <strong>Client-ID: Client-Secret</strong></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-oauth-2-0-authentication-method#step_a" rel="nofollow ugc">OAuth 2.0 Authentication</a><br />
        – 1. <strong>Password Grant</strong><br />
            – 2. <strong>Client Credentials Grant</strong></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-authentication-using-third-party-provider#step_a" rel="nofollow ugc">Third Party Provider Authentication</a></li>
</ul>
<h3>Following are some of the integrations that are possible with WP REST API Authentication:</h3>
<ul>
<li>Learndash API Authentication</li>
<li>Custom Built REST API Endpoints Authentication</li>
<li>BuddyPress API Authentication</li>
<li>WooCommerce API Authentication</li>
<li>Gravity Form API Authentication</li>
<li>External/Third-party plugin API endpoints integration in WordPress</li>
</ul>
<p>You can also disable the WP REST APIs with our plugin such that no one can make API calls to your WordPress REST API endpoints.Our plugin also provides <strong>Refresh and Revoke Token</strong> that can be used to improve the API security.</p>
<h3>Benefits of Refresh Token</h3>
<ul>
<li>Enhances security by keeping access tokens short-lived.</li>
<li>Improves user experience with uninterrupted sessions.</li>
<li>Reduces login frequency.</li>
</ul>
<h3>Benefits of Revoke Token</h3>
<ul>
<li>Protects against token misuse if a device is lost or compromised.</li>
<li>Enables admin-triggered logouts or session control.</li>
<li>Useful for complying with stricter session policies.</li>
</ul>
<p>With this plugin, the user is allowed to access your site’s resources only after successful WP REST API authentication. JWT Authentication for WP REST APIs plugin will make your <strong>WordPress endpoints secure from unauthorized access.</strong></p>
<h3>Plugin Feature List</h3>
<h3>FREE PLAN</h3>
<ul>
<li>Authenticate only default core WordPress REST API endpoints.</li>
<li>Basic Authentication with username and password.</li>
<li>JWT Authentication (JSON Web Token Authentication).</li>
<li>Enable Selective API protection.</li>
<li>Restrict non-logged-in users to access REST API endpoints.</li>
<li>Disable WP REST APIs</li>
</ul>
<h3>PREMIUM PLAN</h3>
<ul>
<li>Authenticate all REST API endpoints (Default WP, Custom APIs,Third-Party plugins)</li>
<li><strong>JWT Token Authentication</strong> (JSON Web Token Authentication)</li>
<li>Login, Refresh and Revoke token endpoints for token management</li>
<li>API Key Authentication</li>
<li>Basic Authentication (username/password and email/password)</li>
<li>OAuth 2.0 Authentication</li>
<li>Universal API key and User-specific API key for authentication</li>
<li>Selective API protection.</li>
<li>Disable WP REST APIs</li>
<li>Time-based token expiry</li>
<li>Role-based WP REST API authentication</li>
<li>Custom Header support rather than just <em>Authorization</em> to increase security.</li>
<li>Create users in WordPress based on third-party provider access tokens (JWT tokens) authentication.</li>
</ul>
<h3>Privacy</h3>
<p>This plugin does not store any user data.</p>


JWT Authentication for WP REST APIs

This was the plugin that I was looking for. It is just plug and play!

Great plugin, does as it says!


Great support from the MiniOrange team! Atul and Vidushi are very helpful and lightning fast to respond.


Great Support

Secure and protect WordPress REST API from unauthorized access using JWT token, Basic Authentication, API Key, OAuth 2, or external token.

Better REST API Featured Images vs JWT Authentication for WP REST APIs