Jeremy Selph

<p>While working on a custom WordPress theme we needed the ability to feature users and authors. So we created this ‘Featured users’ plugin which allows the administrator to easily star (feature) users. Then using a custom query in the theme, shortcode or widget; featured users can be displayed by only retrieving users with the custom user meta <code>jsfeatured_user</code>. The plugin does not make any changes to your current theme it only does the following:</p>
<ul>
<li>Adds a featured column in the Users panel of the WordPress Admin.</li>
<li>When a user is featured the plugin adds or updates the custom field ‘jsfeatured_user’ and sets the value to yes.</li>
<li>Provides custom widget that echoes out shortcode.</li>
<li>Provides custom shortcode that echoes ul list of featured users.</li>
<li>Includes theme functions and filters for developers.</li>
</ul>
<p>Feel free to use and include in your WordPress Installs, please think of us if you need a custom theme or plugin developed! Use documented code examples on the settings page to modify the expected output.</p>
<h3>How to</h3>
<p>After activating and after updating the plugin’s settings go to wp-admin > Users > All Users and feature a few users. To use the ‘Featured Users’ plugin edit a page and add the ‘Featured Users’ shortcode or update a sidebar and add the ‘Featured Users’ widget.</p>
<h3>Shortcode Paramaters</h3>
<p>[rd-featured-users role=”administrator,author” avatar=”yes” max=”100″]</p>
<ul>
<li>role = A comma-separated list of roles of the users you want to include in the query. Note the settings page can override this. The default is all roles again unless the settings page specifies which to allow.</li>
<li>avatar = Options are yes or no, specify whether to show or not show the users’ avatar image. The default is no.</li>
<li>max = The maximum number of users to display.</li>
</ul>
<h3>Filters</h3>
<p>WordPress filters allow a ‘developer’ to modify aspects of the ‘Featured Users’ plugin without editing the core plugin. If you are not familiar with filters <a href="https://codex.wordpress.org/Plugin_API" rel="nofollow ugc">please read this</a> before continuing.</p>
<ol>
<li>‘featured-users-args’, <a href="https://codex.wordpress.org/Class_Reference/WP_User_Query" rel="nofollow ugc">https://codex.wordpress.org/Class_Reference/WP_User_Query</a></li>
<li>‘featured-users-css’, url to css file</li>
<li>‘featured-users-JS’, url to js file</li>
<li>‘featured-user-shortcode-row’, user row in shortcode and widget</li>
<li>‘featured-user-shortcode-return’, shortcode and widget content</li>
</ol>
<h3>Support</h3>
<p>For custom WordPress plugin and theme development requests email us at <a href="mailto:info@reactivedevelopment.net" rel="nofollow ugc">info@reactivedevelopment.net</a> or go to <a href="https://www.reactivedevelopment.net/" rel="nofollow ugc">https://www.reactivedevelopment.net/</a>. If you have questions or requests for this plugin go to <a href="https://wordpress.org/support/plugin/featured-users-wordpress-plugin" rel="ugc">https://wordpress.org/support/plugin/featured-users-wordpress-plugin</a> or for quick and paid support go to <a href="https://www.reactivedevelopment.net/contact/project-mind/?plugin=featured-users" rel="nofollow ugc">https://www.reactivedevelopment.net/contact/project-mind/?plugin=featured-users</a> to message us.</p>


Featured Users

Allows the administrator to make users featured. All it does is give the user a custom meta field called jsfeatured_user. Now available are a shortcod …

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.

Featured Users vs Better REST API Featured Images