Make WordPress Core

Changeset 52205


Ignore:
Timestamp:
11/18/2021 01:55:36 PM (5 years ago)
Author:
johnbillion
Message:

Docs: Corrections relating to types used in inline documentation for comment ID and site ID proprties.

Includes a correction for a typo introduced in [52204].

See #53399

Location:
trunk/src
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-comments-list-table.php

    r52007 r52205  
    10731073                 *
    10741074                 * @param string $column_name The custom column's name.
    1075                  * @param int    $comment_id  The custom column's unique ID number.
     1075                 * @param string $comment_id  The comment ID as a numeric string.
    10761076                 */
    10771077                do_action( 'manage_comments_custom_column', $column_name, $item->comment_ID );
  • trunk/src/wp-admin/network/sites.php

    r51475 r52205  
    262262                         * @since MU (3.0.0)
    263263                         *
    264                          * @param string $id The ID of the activated site.
     264                         * @param int $id The ID of the activated site.
    265265                         */
    266266                        do_action( 'activate_blog', $id );
     
    273273                         * @since MU (3.0.0)
    274274                         *
    275                          * @param string $id The ID of the site being deactivated.
     275                         * @param int $id The ID of the site being deactivated.
    276276                         */
    277277                        do_action( 'deactivate_blog', $id );
  • trunk/src/wp-includes/comment-template.php

    r52200 r52205  
    4343         *
    4444         * @param string     $author     The comment author's username.
    45          * @param int        $comment_ID The comment ID.
     45         * @param string     $comment_ID The comment ID as a numeric string.
    4646         * @param WP_Comment $comment    The comment object.
    4747         */
     
    6969         *
    7070         * @param string $author     The comment author's username.
    71          * @param int    $comment_ID The comment ID.
     71         * @param string $comment_ID The comment ID as a numeric string.
    7272         */
    7373        echo apply_filters( 'comment_author', $author, $comment->comment_ID );
     
    9494         *
    9595         * @param string     $comment_author_email The comment author's email address.
    96          * @param int        $comment_ID           The comment ID.
     96         * @param string     $comment_ID           The comment ID as a numeric string.
    9797         * @param WP_Comment $comment              The comment object.
    9898         */
     
    126126         *
    127127         * @param string $author_email The comment author's email address.
    128          * @param int    $comment_ID   The comment ID.
     128         * @param string $comment_ID   The comment ID as a numeric string.
    129129         */
    130130        echo apply_filters( 'author_email', $author_email, $comment->comment_ID );
     
    237237         *                           Empty for an invalid URL.
    238238         * @param string $author     The comment author's username.
    239          * @param int    $comment_ID The comment ID.
     239         * @param string $comment_ID The comment ID as a numeric string.
    240240         */
    241241        return apply_filters( 'get_comment_author_link', $return, $author, $comment->comment_ID );
     
    275275         *
    276276         * @param string     $comment_author_IP The comment author's IP address, or an empty string if it's not available.
    277          * @param int        $comment_ID        The comment ID.
     277         * @param string     $comment_ID        The comment ID as a numeric string.
    278278         * @param WP_Comment $comment           The comment object.
    279279         */
     
    321321         * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
    322322         *
    323          * @param string     $url        The comment author's URL.
    324          * @param int        $comment_ID The comment ID.
    325          * @param WP_Comment $comment    The comment object.
     323         * @param string          $url        The comment author's URL, or an empty string.
     324         * @param string|int      $comment_ID The comment ID as a numeric string, or 0 if not found.
     325         * @param WP_Comment|null $comment    The comment object, or null if not found.
    326326         */
    327327        return apply_filters( 'get_comment_author_url', $url, $id, $comment );
     
    348348         *
    349349         * @param string $author_url The comment author's URL.
    350          * @param int    $comment_ID The comment ID.
     350         * @param string $comment_ID The comment ID as a numeric string.
    351351         */
    352352        echo apply_filters( 'comment_url', $author_url, $comment->comment_ID );
     
    532532         * @param string[]    $classes    An array of comment classes.
    533533         * @param string[]    $class      An array of additional classes added to the list.
    534          * @param int         $comment_id The comment ID.
     534         * @param string      $comment_id The comment ID as a numeric string.
    535535         * @param WP_Comment  $comment    The comment object.
    536536         * @param int|WP_Post $post_id    The post ID or WP_Post object.
     
    625625         *
    626626         * @param string     $excerpt    The comment excerpt text.
    627          * @param int        $comment_ID The comment ID.
     627         * @param string     $comment_ID The comment ID as a numeric string.
    628628         * @param WP_Comment $comment    The comment object.
    629629         */
     
    651651         *
    652652         * @param string $comment_excerpt The comment excerpt text.
    653          * @param int    $comment_ID      The comment ID.
     653         * @param string $comment_ID      The comment ID as a numeric string.
    654654         */
    655655        echo apply_filters( 'comment_excerpt', $comment_excerpt, $comment->comment_ID );
     
    661661 * @since 1.5.0
    662662 *
    663  * @return int The comment ID.
     663 * @return string The comment ID as a numeric string.
    664664 */
    665665function get_comment_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
     
    670670         *
    671671         * @since 1.5.0
    672          * @since 4.1.0 The `$comment_ID` parameter was added.
    673          *
    674          * @param int        $comment_ID The current comment ID.
     672         * @since 4.1.0 The `$comment` parameter was added.
     673         *
     674         * @param string     $comment_ID The current comment ID as a numeric string.
    675675         * @param WP_Comment $comment    The comment object.
    676676         */
     
    10981098         *
    10991099         * @param string     $comment_type The type of comment, such as 'comment', 'pingback', or 'trackback'.
    1100          * @param int        $comment_ID   The comment ID.
     1100         * @param string     $comment_ID   The comment ID as a numeric string.
    11011101         * @param WP_Comment $comment      The comment object.
    11021102         */
  • trunk/src/wp-includes/comment.php

    r52029 r52205  
    14891489         * @since 4.9.0 Added the `$comment` parameter.
    14901490         *
    1491          * @param int        $comment_id The comment ID.
     1491         * @param string     $comment_id The comment ID as a numeric string.
    14921492         * @param WP_Comment $comment    The comment to be deleted.
    14931493         */
     
    15171517         * @since 4.9.0 Added the `$comment` parameter.
    15181518         *
    1519          * @param int        $comment_id The comment ID.
     1519         * @param string     $comment_id The comment ID as a numeric string.
    15201520         * @param WP_Comment $comment    The deleted comment.
    15211521         */
     
    15631563         * @since 4.9.0 Added the `$comment` parameter.
    15641564         *
    1565          * @param int        $comment_id The comment ID.
     1565         * @param string     $comment_id The comment ID as a numeric string.
    15661566         * @param WP_Comment $comment    The comment to be trashed.
    15671567         */
     
    15801580                 * @since 4.9.0 Added the `$comment` parameter.
    15811581                 *
    1582                  * @param int        $comment_id The comment ID.
     1582                 * @param string     $comment_id The comment ID as a numeric string.
    15831583                 * @param WP_Comment $comment    The trashed comment.
    15841584                 */
     
    16111611         * @since 4.9.0 Added the `$comment` parameter.
    16121612         *
    1613          * @param int        $comment_id The comment ID.
     1613         * @param string     $comment_id The comment ID as a numeric string.
    16141614         * @param WP_Comment $comment    The comment to be untrashed.
    16151615         */
     
    16311631                 * @since 4.9.0 Added the `$comment` parameter.
    16321632                 *
    1633                  * @param int        $comment_id The comment ID.
     1633                 * @param string     $comment_id The comment ID as a numeric string.
    16341634                 * @param WP_Comment $comment    The untrashed comment.
    16351635                 */
     
    17101710         * @since 4.9.0 Added the `$comment` parameter.
    17111711         *
    1712          * @param int        $comment_id The comment ID.
     1712         * @param string     $comment_id The comment ID as a numeric string.
    17131713         * @param WP_Comment $comment    The comment to be unmarked as spam.
    17141714         */
     
    17301730                 * @since 4.9.0 Added the `$comment` parameter.
    17311731                 *
    1732                  * @param int        $comment_id The comment ID.
     1732                 * @param string     $comment_id The comment ID as a numeric string.
    17331733                 * @param WP_Comment $comment    The comment unmarked as spam.
    17341734                 */
     
    18641864         * @since 2.7.0
    18651865         *
    1866          * @param int        $comment_ID The comment ID.
     1866         * @param string     $comment_ID The comment ID as a numeric string.
    18671867         * @param WP_Comment $comment    Comment object.
    18681868         */
     
    24342434         * @since 1.5.0
    24352435         *
    2436          * @param int    $comment_id     Comment ID.
     2436         * @param string $comment_id     Comment ID as a numeric string.
    24372437         * @param string $comment_status Current comment status. Possible values include
    24382438         *                               'hold', '0', 'approve', '1', 'spam', and 'trash'.
  • trunk/src/wp-includes/link-template.php

    r52180 r52205  
    16291629         *
    16301630         * @param string $link       Anchor tag for the edit link.
    1631          * @param int    $comment_id Comment ID.
     1631         * @param string $comment_id Comment ID as a numeric string.
    16321632         * @param string $text       Anchor text.
    16331633         */
  • trunk/src/wp-includes/ms-functions.php

    r52204 r52205  
    14701470         * @since 5.4.0 The `$blog_id` parameter was added.
    14711471         *
    1472          * @param string $msg     Email body.
    1473          * @param int    $blog_id The new site's ID.
     1472         * @param string     $msg     Email body.
     1473         * @param int|string $blog_id The new site's ID as an integer or numeric string.
    14741474         */
    14751475        $msg = apply_filters( 'newblog_notify_siteadmin', $msg, $blog_id );
  • trunk/src/wp-includes/ms-site.php

    r51184 r52205  
    978978         * @since 4.6.0
    979979         *
    980          * @param int     $id              Blog ID.
     980         * @param string  $id              Site ID as a numeric string.
    981981         * @param WP_Site $blog            Site object.
    982982         * @param string  $domain_path_key md5 hash of domain and path.
  • trunk/src/wp-includes/pluggable.php

    r52083 r52205  
    15851585                 *
    15861586                 * @param string[] $emails     An array of email addresses to receive a comment notification.
    1587                  * @param int      $comment_id The comment ID.
     1587                 * @param string   $comment_id The comment ID as a numeric string.
    15881588                 */
    15891589                $emails = apply_filters( 'comment_notification_recipients', $emails, $comment->comment_ID );
     
    16061606                 * @since 3.8.0
    16071607                 *
    1608                  * @param bool $notify     Whether to notify the post author of their own comment.
    1609                  *                         Default false.
    1610                  * @param int  $comment_id The comment ID.
     1608                 * @param bool   $notify     Whether to notify the post author of their own comment.
     1609                 *                           Default false.
     1610                 * @param string $comment_id The comment ID as a numeric string.
    16111611                 */
    16121612                $notify_author = apply_filters( 'comment_notification_notify_author', false, $comment->comment_ID );
     
    17411741                 *
    17421742                 * @param string $notify_message The comment notification email text.
    1743                  * @param int    $comment_id     Comment ID.
     1743                 * @param string $comment_id     Comment ID as a numeric string.
    17441744                 */
    17451745                $notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment->comment_ID );
     
    17511751                 *
    17521752                 * @param string $subject    The comment notification email subject.
    1753                  * @param int    $comment_id Comment ID.
     1753                 * @param string $comment_id Comment ID as a numeric string.
    17541754                 */
    17551755                $subject = apply_filters( 'comment_notification_subject', $subject, $comment->comment_ID );
     
    17611761                 *
    17621762                 * @param string $message_headers Headers for the comment notification email.
    1763                  * @param int    $comment_id      Comment ID.
     1763                 * @param string $comment_id      Comment ID as a numeric string.
    17641764                 */
    17651765                $message_headers = apply_filters( 'comment_notification_headers', $message_headers, $comment->comment_ID );
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-navigation-areas-controller.php

    r52204 r52205  
    247247                 * returned.
    248248                 *
    249                  * @param WP_REST_Response\WP_Error $response The response object, or WP_Error object on failure.
     249                 * @param WP_REST_Response|WP_Error $response The response object, or WP_Error object on failure.
    250250                 * @param object                    $area     The original status object.
    251251                 * @param WP_REST_Request           $request  Request used to generate the response.
Note: See TracChangeset for help on using the changeset viewer.