Docs: Align @param tag columns in REST API docblocks

[mukeshpanchal27]

Trac ticket: https://core.trac.wordpress.org/ticket/65818

The PHP inline documentation standards call for @param tags in a docblock to line up in columns — types, variable names, and descriptions each starting at the same offset — with wrapped descriptions indented to the description column:

/**
 * Summary.
 *
 * @since x.x.x
 *
 * @param string $var       Description.
 * @param bool   $other_var Description that wraps
 *                          onto a second line.
 */

This corrects 17 @param lines across 7 files in the REST API.

Example

src/wp-includes/rest-api/class-wp-rest-server.php — before:

 * @param int $options             JSON encoding options {@see json_encode()}.
 * @param WP_REST_Request $request Current request object.

after:

 * @param int             $options JSON encoding options {@see json_encode()}.
 * @param WP_REST_Request $request Current request object.

Files changed (7)

• src/wp-includes/rest-api.php
• src/wp-includes/rest-api/class-wp-rest-server.php
• src/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-categories-controller.php
• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php
• src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php
• src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php
• src/wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php

Part of a series

The original work was a single branch touching 80 files. It is split by component so each can be reviewed and committed independently:

• Docs: Align @param tag columns in block editor docblocks #13311 — block editor
• Docs: Align @param tag columns in REST API docblocks #13312 — REST API (this PR)
• Docs: Align @param tag columns in upgrade, plugin, and theme docblocks #13313 — upgrade, plugins, and themes
• Docs: Align @param tag columns in users and multisite docblocks #13314 — users and multisite
• Docs: Align @param tag columns in post, comment, taxonomy, and media docblocks #13315 — posts, comments, taxonomy, and media
• Docs: Align @param tag columns in administration docblocks #13316 — administration
• Docs: Align @param tag columns in general core API docblocks #13317 — general core APIs

This is a whitespace-only change: git diff -w against trunk is empty, so there is no functional change and no change to any generated documentation output beyond the alignment itself.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 5
Used for: Grouping a single large docblock alignment branch into per-component pull requests, verifying that the split is whitespace-only and that the seven branches together reproduce the original diff line for line, and drafting this description. I reviewed the alignment changes before submitting.

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props mukesh27.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.