REST API Featured Image

外掛說明

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

安裝方式

  1. Upload the Plugin Files:
    – Upload the rest-api-featured-image folder to the /wp-content/plugins/ directory.
    – Or install the plugin directly through the WordPress plugins screen.

  2. Activate the Plugin:
    – Activate the plugin through the ‘Plugins’ screen in WordPress.

  3. 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.

常見問題集

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.

使用者評論

2020 年 11 月 27 日
I’m surprised Wordpress doesn’t include this feature by default.. it is the plugin I was looking for, thank you 🙂
閱讀全部 3 則使用者評論

參與者及開發者

以下人員參與了開源軟體〈REST API Featured Image〉的開發相關工作。

參與者

將〈REST API Featured Image〉外掛本地化為台灣繁體中文版

對開發相關資訊感興趣?

任何人均可瀏覽程式碼、查看 SVN 存放庫,或透過 RSS 訂閱開發記錄