Add featured +- attached images to post endpoint in REST API

[discobot]

When one pulls up the endpoint “wp-json/wp/v2/posts” we get a key called “featured_media” but it returns an integer value.

Can’t we rewrite this to give a proper URL to the featured image? or even add another key that has attached images as URLs.

This will prevent the extra queries one has to return the image URLs or even install bloated plugins to get this information.

I know the endpoint already has so much information one rarely needs thus the growth of tech like GraphQL but we could also consider Author name & description to the individual posts.

This is voice is for decoupling ClassicPress to modern apps or front-ends.

---

Read-only archive: Issues · ClassicPress/ClassicPress · GitHub

Author: Laurence Bahiirwa

Vote count: 5

Status: open

Tags:

• difficulty-hard
• request-add-feature

---

Comments

I am doing something for testing here. GitHub - bahiirwa/Extend-REST-api: Extend the post featured images to the rest API programtically and safely on a high level.

~ posted by Laurence Bahiirwa

I don’t think this is necessary. You can use /wp-json/wp/v2/posts?_embed instead.

This returns more information than desired, in your case. Here is a proposed change that will help with this issue in a backwards-compatible way: #39696 (REST API: Filter which links get embedded when passing the ?_embed query parameter) – WordPress Trac

~ posted by James Nylen

In the meantime, this is fairly easy to do in a plugin. Here is some code to use as a starting point: WP REST API: Add endpoints synced from WP.com by nylen · Pull Request #9968 · Automattic/jetpack · GitHub

~ posted by James Nylen

wp-json/wp/v2/posts?_embed is not always reliable from my experience. Errors are returned thats why I always edit the endpoint with the code shared. It also adds alot of lines of code on endpoint making it slower.

~ posted by Laurence Bahiirwa

[viktor]

@james @omukiguy you two were discussing this petition back in 2018. Has anything changed since then?

[omukiguy]

I still hold the view that instead of serving media IDs only, we could serve the image URLs like we do for post content, title etc. It is the one inconsistency currently on the API for me.

Pros

• Data URL for images straight off the bat.
• Removes extra use of plugins to make custom endpoints for data in the post.

Cons

• Adds query to show the URLs such as @james mentions here: WP REST API: Add endpoints synced from WP.com by nylen · Pull Request #9968 · Automattic/jetpack · GitHub

If this is a stretch, James shares a backport we need to do for the improvement.

[viktor]

Are you able to do the backport to complete this petition?
https://core.trac.wordpress.org/ticket/39696

[omukiguy]

This can be followed here WP-r47224: Introduce selective link embedding via REST API by bahiirwa · Pull Request #1024 · ClassicPress/ClassicPress · GitHub

[viktor]

This will be included in the re-fork. The petition will be closed.