Description
REST API Featured Image is a lightweight yet powerful plugin that simplifies how to retrieve featured images via the WordPress REST API. By introducing a top-level field called featured_media_src_url, this plugin embeds the direct URL of the featured image into your REST API responses. This eliminates the need for additional API calls to fetch featured images, resulting in faster load times and enhanced site performance.
Key Features:
– Direct Access to Featured Image URL: Adds featured_media_src_url to REST API responses, providing immediate access to the featured image URL.
– Performance Optimization: Reduces the number of API requests, improving the speed and efficiency of your applications.
– Custom Post Type Support: Fully supports custom post types, allowing you to enable or disable the featured image URL field for specific post types through the admin settings.
– User-Friendly Configuration: Easy to install and configure without any coding.
Why Use REST API Featured Image?
When developing applications or themes that rely on the WordPress REST API, accessing the featured image typically requires an additional request for each post. This can be time-consuming and may negatively impact site performance. REST API Featured Image addresses this issue by including the featured image URL directly in the REST API response, saving you time and resources.
REST API Featured Image Field:
– featured_media_src_url
Installation
-
Upload the Plugin Files:
– Upload therest-api-featured-imagefolder to the/wp-content/plugins/directory.
– Or install the plugin directly through the WordPress plugins screen. -
Activate the Plugin:
– Activate the plugin through the ‘Plugins’ screen in WordPress. -
Configure Plugin Settings:
– Navigate to the plugin settings page in the WordPress admin area.
– Select the post types for which you want to enable or disable the featured image URL field.
FAQ
-
How do I access the featured image URL from the REST API?
-
After installing and activating the plugin, the REST API responses for your selected post types will include a new field named
featured_media_src_url. This field contains the direct URL to the featured image. -
Does this plugin support custom post types?
-
Yes, the plugin fully supports custom post types. You can enable or disable the featured image URL field for any post type via the plugin’s settings in the admin area.
-
Will this plugin improve my site’s performance?
-
Absolutely. By eliminating the need for additional API requests to fetch featured images, your site’s performance and load times will improve.
-
Do I need any coding knowledge to use this plugin?
-
Not at all. The plugin is user-friendly and requires no coding skills. Simply install, activate, and configure your settings.
Reviews
Contributors & Developers
“REST API Featured Image” is open source software. The following people have contributed to this plugin.
Contributors
Translate “REST API Featured Image” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.