feat: add moderation metadata fields to comments REST API endpoint

[xavierandueza]

Summary

• Adds priority field (enum: low, normal, high, urgent) to the comments endpoint for moderation triage, stored as comment meta
• Adds editorial_note string field for internal moderator notes, visible only in edit context
• Adds computed word_count read-only field to comment responses
• All new fields are supported on both create (POST /wp/v2/comments) and update (POST /wp/v2/comments/{id}) paths
• Input values are properly sanitized via sanitize_key and sanitize_textarea_field

Changes

wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

• get_item_schema(): Added schema definitions for the three new properties
• create_item(): Saves priority and editorial_note as comment meta on creation
• update_item(): Saves priority and editorial_note as comment meta on update
• prepare_item_for_response(): Reads and returns all three new fields in API responses

[readme-pr-app]

📚 Documentation update workflow has been queued for reopened PR (Job ID: 6994ec0ba0f3185b35c7675c). The documentation bot will propose changes (if relevant) shortly.

[readme-pr-app]

📊 PR Analysis Summary

Files Changed: 1 file(s)
Additions: +55 lines
Deletions: -0 lines

Changed Files

• wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Relevant Documentation Pages

Docs impacted by this PR

• createcomment
• listcomments
• getcomment
• updatecomment
• updatepost
• updatenavmenuitem
• listposts
• deletecomment
• createnavmenuitem

✅ Documentation Changes Applied

• createcomment (Updated API Reference Page)
• listcomments (Updated API Reference Page)
• getcomment (Updated API Reference Page)

🔗 View changes in ReadMe

---

This analysis was automatically generated by the ReadMe AI Documentation Bot.

[readme-pr-app]

📚 Documentation Changes Applied

• updatecomment — Updated API Reference Page
• createcomment — Updated API Reference Page
• listcomments — Updated API Reference Page

🔗 View changes in ReadMe

[readme-pr-app]

📚 No documentation updates were needed for this PR.

[readme-pr-app]

📚 Documentation Changes Applied

• updatecomment — Updated API Reference Page
• createcomment — Updated API Reference Page
• deletecomment — Updated API Reference Page

🔗 View changes in ReadMe

[readme-pr-app]

📚 Documentation Changes Applied

• updatecomment — Updated API Reference Page
• createcomment — Updated API Reference Page
• getcomment — Updated API Reference Page
• listcomments — Updated API Reference Page
• deletecomment — Updated API Reference Page

🔗 View changes in ReadMe

[readme-pr-app]

📚 Documentation Changes Applied

• createcomment — Updated API Reference Page
• updatecomment — Updated API Reference Page
• getcomment — Updated API Reference Page
• listcomments — Updated API Reference Page
• deletecomment — Updated API Reference Page

🔗 View changes in ReadMe

[readme-agent-staging]

📚 Analyzing PR for documentation updates...

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Preview
createcomment	API Reference	🔵 Updated	Preview
updatecomment	API Reference	🔵 Updated	Preview
listcomments	API Reference	🔵 Updated	Preview
getcomment	API Reference	🔵 Updated	Preview
deletecomment	API Reference	🔵 Updated	Preview

🔗 View all changes in ReadMe

---

Actions

• Merge doc branch with PR merge
• Delete doc branch with PR close

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
updatecomment	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the Update a comment endpoint documentation including request body schema, code examples, response example, and TypeScript interfaces.
createcomment	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the Create a comment endpoint documentation including request body schema, code examples, response example, and TypeScript interfaces.
listcomments	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the List comments response example and TypeScript interface to reflect new comment moderation metadata fields.
getcomment	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the Retrieve a comment response example and TypeScript interface to reflect new comment moderation metadata fields.
deletecomment	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the Delete a comment response example and TypeScript interface to reflect new comment moderation metadata fields in the previous object.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
listcomments	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the response interface, response example, and OAS definition for the List comments endpoint.
createcomment	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the request body, response interface, code examples, response example, and OAS definition for the Create a comment endpoint.
getcomment	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the response interface, response example, and OAS definition for the Retrieve a comment endpoint.
updatecomment	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the request body, response interface, code examples, response example, and OAS definition for the Update a comment endpoint.
deletecomment	API Reference	📝 Updated	Added priority, editorial_note, and word_count fields to the response interface, response example (previous object), and OAS definition for the Delete a comment endpoint.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
listcomments	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the List comments response interface, response example, and OAS definition.
createcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Create a comment request/response interfaces, response example, and OAS definition.
getcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Retrieve a comment response interface, response example, and OAS definition.
updatecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Update a comment request/response interfaces, response example, and OAS definition.
deletecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Delete a comment response interface, response example, and OAS definition.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
listcomments	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the List comments response schema, TypeScript interface, and response example.
createcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Create a comment request body, response schema, TypeScript interfaces, code examples, and response example.
getcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Retrieve a comment response schema, TypeScript interface, and response example.
updatecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Update a comment request body, response schema, TypeScript interfaces, code examples, and response example.
deletecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Delete a comment response schema, TypeScript interface, and response example.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
listcomments	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to CommentResponse interface, response example, and OAS for the new moderation metadata fields.
createcomment	API Reference	📝 Updated	Add priority and word_count fields to the response JSON example.
getcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to CommentResponse interface, response example, and OAS for the new moderation metadata fields.
updatecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to request/response interfaces, response example, and OAS for the new moderation metadata fields.
deletecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to CommentResponse interface, response example, and OAS for the new moderation metadata fields.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
listcomments	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the List comments endpoint response schema, TypeScript interface, and response example.
createcomment	API Reference	📝 Updated	Add priority and word_count fields to the Create a comment response example.
getcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Retrieve a comment endpoint response schema, TypeScript interface, and response example.
updatecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Update a comment endpoint request body, response schema, TypeScript interfaces, and response example.
deletecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Delete a comment endpoint response schema, TypeScript interface, and response example.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
listcomments	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the List comments endpoint documentation, TypeScript interfaces, response examples, and OAS definition.
createcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Create a comment endpoint documentation, TypeScript interfaces, response examples, and OAS definition.
getcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Retrieve a comment endpoint documentation, TypeScript interface, response example, and OAS definition.
updatecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Update a comment endpoint documentation, TypeScript interfaces, response examples, and OAS definition.
deletecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the Delete a comment endpoint documentation, TypeScript interface, response example, and OAS definition.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

_{If neither actions are selected, on PR close/merge the docs branch in ReadMe will remain open.}

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
listcomments	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to TypeScript interface and response example for new comment moderation metadata fields.
createcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to TypeScript interfaces, response example, and OAS for new comment moderation metadata fields.
getcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to TypeScript interface, response example, and OAS for new comment moderation metadata fields.
updatecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to TypeScript interfaces and response example for new comment moderation metadata fields.
updatecomment	API Reference	📝 Updated	Add OAS definition with priority, editorial_note, and word_count fields for the update comment endpoint.
deletecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to TypeScript interface, response example, and OAS for new comment moderation metadata fields.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

_{If neither actions are selected, on PR close/merge the docs branch in ReadMe will remain open.}

[readme-pr-app]

⚠️ The documentation bot was unable to process documentation updates (Job ID: 69eb1e4da00d51ea038b0a9c).

You can re-trigger by converting this PR to draft, then opening for review again.

[readme-pr-app]

Documentation Changes Added

Page	Section	Action	Summary
listcomments	API Reference	📝 Updated	Add priority and word_count fields to the response interface, response example, and OAS definition for the List comments endpoint.
createcomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the request params, response interface, response example, and OAS definition for the Create a comment endpoint.
getcomment	API Reference	📝 Updated	Add priority and word_count fields to the response interface, response example, and OAS definition for the Retrieve a comment endpoint.
updatecomment	API Reference	📝 Updated	Add priority, editorial_note, and word_count fields to the request params, response interface, response example, and OAS definition for the Update a comment endpoint.
deletecomment	API Reference	📝 Updated	Add priority and word_count fields to the response interface, response example, and OAS definition for the Delete a comment endpoint.

🔗 View all changes in ReadMe

---

Actions

• Merge documentation branch with PR merge
• Delete documentation branch with PR close

_{If neither actions are selected, on PR close/merge the docs branch in ReadMe will remain open.}