Interactivity API: Full CRUD Tutorial

[karstengresch]

Details

• Topic description: Full Interactivity API example with Create - Read - Update - Delete (CRUD).
  The idea is a course like "Using the WordPress Data Layer"[1] , but based on the Interactivity API (IAPI) and, thus, frontend editing.
  
  There is already a basic IAPI introduction[2] by Magdalena Paciorek (@magdalenapaciorek), which helped me a lot, nevertheless, it's not changing any DB records.
  
  To demonstrate how IAPI is intended to work with CRUDing posts/CPTs, I think, an course would become helpful to many.
  
• Audience: Plugin developoers
• Learning objectives: Developers will be able to create fully-fledged plugins leveraging the features of the Interactivity API
• Content type (Online Workshop, Lesson, Course, Tutorial, or Lesson Plan): Course
• WordPress version (optional): 6.5++
• Will you be creating this content? (Yes or No): No :-|

Related Resources

[1] https://learn.wordpress.org/course/using-the-wordpress-data-layer/
[2] https://developer.wordpress.org/news/2024/04/11/a-first-look-at-the-interactivity-api/#creating-a-donation-calculator

Next steps for SMEs

Please follow the team handbook "Vetting topic ideas" to vet this topic.

[jonathanbossenger]

@karstengresch, thanks for creating this issue.

I'm going to ask our Subject Matter Experts to help with vetting this idea. It's a great idea for a course; we just need to do a bit more work on fleshing out the learning objectives and the course structure.

[karstengresch]

Hi @jonathanbossenger - thanks for taking this suggestion into consideration. Would be great if one day every plugin developer could easily enable their users with seamless FE based submissions w/o the need of any form builder.

[Successfulsebunya]

Vetting Checklist for SMEs

• Priority - either High, Medium or Low: High
  The Interactivity API (IAPI) is a powerful new feature in WordPress 6.5+, and there’s currently a lack of comprehensive learning content showing how to implement full CRUD functionality with it. Given the shift toward more frontend interactivity and block-based editing, this course would meet a real need—especially for plugin developers.

• Feedback regarding the topic description: Clear and focused, but could use a slight improvement in structure and clarity

Suggested Revision:

This course will demonstrate how to implement full Create, Read, Update, and Delete (CRUD) functionality using WordPress’s Interactivity API (IAPI), enabling frontend editing of posts and custom post types. It builds upon the foundational content introduced by Magdalena Paciorek, expanding it with real-world examples that modify database records and showcase best practices for plugin developers.

• Feedback regarding the learning objectives: The objective is solid and developer-focused, but could be made more measurable.

Suggested Revision:

By the end of this course, developers will be able to:

1. Understand how the Interactivity API works in WordPress 6.5+
2. Implement CRUD operations on posts or custom post types using IAPI
3. Build frontend-editable interfaces within custom plugins
4. Use IAPI to connect UI components with dynamic WordPress data

• Any other feedback:

1. The author notes that they will not be creating the content, so the Learn team would need to find an SME to write and deliver the course.
2. It might be useful to mention that this course aligns with WordPress's move toward more JavaScript-driven interfaces and user-friendly editing experiences.
3. Consider including a mention of security and nonce handling in IAPI interactions with CRUD, which is often overlooked.

Related Resources