WordPress.org
Get WordPress

Make WordPress Core

Changeset 63497


Ignore:
Timestamp:
09/05/2026 09:57:52 AM (5 days ago)
Author:
wildworks
Message:

Docs: Align @param tag columns in post, comment, taxonomy, and media docblocks.

Aligns @param tag columns in docblocks across the posts, comments, taxonomy, and media APIs per the PHP inline documentation standards.

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

Props mukesh27, wildworks.
See #65818.

Location:
trunk/src
Files:
11 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/comment.php

    r61859 r63497  
    373373                 * @since 2.1.0
    374374                 *
    375                  * @param string $location The URI the user will be redirected to.
    376                  * @param int $comment_id The ID of the comment being edited.
     375                 * @param string $location   The URI the user will be redirected to.
     376                 * @param int    $comment_id The ID of the comment being edited.
    377377                 */
    378378                $location = apply_filters( 'comment_edit_redirect', $location, $comment_id );

  • trunk/src/wp-admin/includes/media.php

    r63481 r63497  
    36193619 *
    36203620 * @param array $metadata An existing array with data.
    3621  * @param array $data Data supplied by ID3 tags.
     3621 * @param array $data     Data supplied by ID3 tags.
    36223622 */
    36233623function wp_add_id3_tag_data( &$metadata, $data ) {

  • trunk/src/wp-admin/includes/post.php

    r63420 r63497  
    26082608 * @access private
    26092609 *
    2610  * @param bool   $value Whether the CPT supports block editor or not.
     2610 * @param bool   $value     Whether the CPT supports block editor or not.
    26112611 * @param string $post_type Post type.
    26122612 * @return bool Whether the block editor should be disabled or not.

  • trunk/src/wp-includes/class-wp-image-editor.php

    r62517 r63497  
    260260                         * @param int    $quality   Quality level between 1 (low) and 100 (high).
    261261                         * @param string $mime_type Image mime type.
    262                          * @param array $size {
     262                         * @param array  $size {
    263263                         *     Dimensions of the image.
    264264                         *

  • trunk/src/wp-includes/comment-template.php

    r63487 r63497  
    926926         *
    927927         * @param string|int $comments_number A string representing the number of comments a post has, otherwise 0.
    928          * @param int        $post_id Post ID.
     928         * @param int        $post_id         Post ID.
    929929         */
    930930        return apply_filters( 'get_comments_number', $comments_number, $post_id );

  • trunk/src/wp-includes/comment.php

    r63207 r63497  
    12481248         *     @type int    $max_depth Maximum comment threading depth allowed.
    12491249         * }
    1250          * @param int $comment_id ID of the comment.
     1250         * @param int   $comment_id    ID of the comment.
    12511251         */
    12521252        return apply_filters( 'get_page_of_comment', (int) $page, $args, $original_args, $comment_id );
    … …  
    34463446         * @since 7.1.0
    34473447         *
    3448          * @param bool   $should_disable  Whether pings should be disabled. Default true
    3449          *                                for non-production environments, false for production.
     3448         * @param bool   $should_disable   Whether pings should be disabled. Default true
     3449         *                                 for non-production environments, false for production.
    34503450         * @param string $environment_type The current environment type as returned by
    34513451         *                                 wp_get_environment_type().
    … …  
    36863686 *
    36873687 * @param string $server Host of blog to connect to.
    3688  * @param string $path Path to send the ping.
     3688 * @param string $path   Path to send the ping.
    36893689 */
    36903690function weblog_ping( $server = '', $path = '' ) {

  • trunk/src/wp-includes/media.php

    r63419 r63497  
    16201620         *     }
    16211621         * }
    1622          * @param array $size_array    {
     1622         * @param array  $size_array {
    16231623         *     An array of requested width and height values.
    16241624         *
    … …  
    41254125         * @since 3.5.0
    41264126         *
    4127          * @param string $output        Adjacent image HTML markup.
    4128          * @param int    $attachment_id Attachment ID
    4129          * @param string|int[] $size    Requested image size. Can be any registered image size name, or
    4130          *                              an array of width and height values in pixels (in that order).
    4131          * @param string $text          Link text.
     4127         * @param string       $output        Adjacent image HTML markup.
     4128         * @param int          $attachment_id Attachment ID
     4129         * @param string|int[] $size          Requested image size. Can be any registered image size name, or
     4130         *                                    an array of width and height values in pixels (in that order).
     4131         * @param string       $text          Link text.
    41324132         */
    41334133        return apply_filters( "{$adjacent}_image_link", $output, $attachment_id, $size, $text );

  • trunk/src/wp-includes/meta.php

    r61584 r63497  
    14281428 *                                         object type is 'post'.
    14291429 * }
    1430  * @param string|array $deprecated Deprecated. Use `$args` instead.
     1430 * @param string|array $deprecated  Deprecated. Use `$args` instead.
    14311431 * @return bool True if the meta key was successfully registered in the global array, false if not.
    14321432 *              Registering a meta key with distinct sanitize and auth callbacks will fire those callbacks,

  • trunk/src/wp-includes/post-template.php

    r63487 r63497  
    16371637 * @param bool        $fullsize   Optional. Whether to use full size. Default false.
    16381638 * @param bool        $deprecated Deprecated. Not used.
    1639  * @param bool        $permalink Optional. Whether to include permalink. Default false.
     1639 * @param bool        $permalink  Optional. Whether to include permalink. Default false.
    16401640 */
    16411641function the_attachment_link( $post = 0, $fullsize = false, $deprecated = false, $permalink = false ) {

  • trunk/src/wp-includes/post.php

    r63488 r63497  
    60136013 * @param string  $new_status Transition to this post status.
    60146014 * @param string  $old_status Previous post status.
    6015  * @param WP_Post $post Post data.
     6015 * @param WP_Post $post       Post data.
    60166016 */
    60176017function wp_transition_post_status( $new_status, $old_status, $post ) {
    … …  
    87838783 *
    87848784 * @param int  $attachment_id Attachment ID.
    8785  * @param bool $unfiltered Optional. Passed through to `get_attached_file()`. Default false.
     8785 * @param bool $unfiltered    Optional. Passed through to `get_attached_file()`. Default false.
    87868786 * @return string|false Path to the original image file or false if the attachment is not an image.
    87878787 */

  • trunk/src/wp-includes/taxonomy.php

    r63488 r63497  
    18341834                 * @since 2.3.0
    18351835                 *
    1836                  * @param mixed $value     Value of the term field.
    1837                  * @param int   $term_id   Term ID.
     1836                 * @param mixed  $value    Value of the term field.
     1837                 * @param int    $term_id  Term ID.
    18381838                 * @param string $taxonomy Taxonomy slug.
    18391839                 */
    … …  
    37713771         * @since 2.5.0
    37723772         *
    3773          * @param array  $object_ids An array of object IDs.
     3773         * @param array  $object_ids  An array of object IDs.
    37743774         * @param string $object_type Object type.
    37753775         */
Note: See TracChangeset for help on using the changeset viewer.