Make WordPress Core


Ignore:
Timestamp:
08/17/2026 01:13:55 PM (5 weeks ago)
Author:
SergeyBiryukov
Message:

Docs: Remove a blank line between @param and @return in core docblocks.

The PHP inline documentation standards place @return immediately after the last @param tag, with no blank line between them:

/**
 * Summary.
 *
 * @since x.x.x
 *
 * @param string $var Description.
 * @return string Description.
 */

This corrects 44 docblocks across 33 files in src/wp-includes that used a line break between the two tags.

Developed in https://github.com/WordPress/wordpress-develop/pull/13063.

Props mukesh27, dhruvang21.
See #65818, #65860.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/functions.php

    r63312 r63320  
    53015301 *
    53025302 * @param string $input_string The string to kebab-case.
    5303  *
    53045303 * @return string kebab-cased-string.
    53055304 */
     
    87228721 * @param string $after   Markup to output after the annotation. Default `</p>`.
    87238722 * @param bool   $display Whether to echo or return the markup. Default `true` for echo.
    8724  *
    87258723 * @return string|null Update PHP page annotation if available and $display is false, null otherwise.
    87268724 */
Note: See TracChangeset for help on using the changeset viewer.