Extending the WordPress REST API

[jonathanbossenger]

Details

• Content type (Online Workshop, Lesson, Course, Tutorial, or Lesson Plan): Lesson
• Content title: Extending the WP REST API
• Topic description: This lesson will introduce two methods of adding fields to REST API requests, either by enabling custom fields in the REST API route, or by making custom fields available as top level fields, as well as the pros and cons of both approaches.
• Audience (User, Developer, Designer, Contributor, etc.): Developer
• Experience Level (Beginner, Intermediate, Advanced, Any): Beginnner

Learning Objectives

• Register post meta for a custom post type that supports the WP REST API
• Add or update a custom post type via the WP REST API including this custom post meta
• Modify the custom post meta by moving it to a top-level field on the WP REST API endpoint

Related Resources and Other Notes

• https://developer.wordpress.org/rest-api/extending-the-rest-api/modifying-responses/

Automation Code

//lesson

[github-actions]

Lesson Development Checklist

• Gather any relevant links to Support, Docs, or related material
• Description and Objectives finalized
• Lesson created and announced to the team for review
• Lesson reviewed
• Lesson video submitted and published to WPTV
• Lesson created on Learn.WordPress.org
• Lesson video published to YouTube
• Lesson on Learn.WordPress.org updated with YouTube video
• Lesson published to Learn.WordPress.org

[jonathanbossenger]

Script: https://github.com/jonathanbossenger/wp-content/blob/main/developer-learning-pathway/08-wordpress-rest-api/04-extending-the-wp-rest-api.md

[jonathanbossenger]

04.Extending.the.WordPress.REST.API.mp4

Video ready for review

Please follow the Guidelines for reviewing content to review this lesson.

[ironnysh]

Tutorial/Lessons Review Checklist

• Learning outcomes/objectives are clear.
• Technical concepts introduced in the content are accurate.
• The speed of demonstrations are easy to follow.
• The narration audio matches what is shown visually.
• Spelling and grammar are correct.
• Sound quality is consistent throughout the video.
• Brand Usage Guidelines and Promotional Guidelines are being followed.
• Media assets are all in the public domain (CC0).

Lots of good stuff here :-)

• It might be worth mentioning that show_in_rest is required if you want to view the custom field in the editor.
• At 7:31, when you switch to the editor, the custom fields are already displayed below the main window, but this isn't the default behavior. It would be nice to show how to enable it.
• At 7:37, there's a little repetition: "It's also..."

[jonathanbossenger]

@ironnysh thanks for the review

the custom fields are already displayed below the main window, but this isn't the default behavior. It would be nice to show how to enable it.

This is covered in the Introduction to plugins lesson on custom fields

At 7:37, there's a little repetition: "It's also..."

Good catch, thanks.

[jonathanbossenger]

Updated video

04.Extending.the.WordPress.REST.API.mp4

[ironnysh]

This is covered in the Introduction to plugins lesson on custom fields

@jonathanbossenger, but what if people don't follow the linear path? :-)

BTW, there's been a change in 6.5, so this line should be updated:

[jonathanbossenger]

BTW, there's been a change in 6.5, so [this line](https://github.com/jonathanbossenger/wp-content/blob/e1aebbf4b4362cb24ec9f8a35da3675303e3e403/developer-learning-pathway/06-introduction-to-wordpress-plugins/05-custom-post-type-data.md?plain=1#L45) should be updated:

Yeah, I saw that. I'll probably circle back and update that lesson once the full learning pathway is completed.

[jonathanbossenger]

https://wordpress.tv/2024/04/07/extending-the-wordpress-rest-api/

[jonathanbossenger]

https://learn.wordpress.org/lesson/extending-the-wordpress-rest-api/

[jonathanbossenger]

//publish