Changeset 52205 for trunk/src/wp-includes/pluggable.php

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

File:

• trunk/src/wp-includes/pluggable.php (modified) (5 diffs)

trunk/src/wp-includes/pluggable.php

@@ -1585 +1585 @@
                  *
                  * @param string[] $emails     An array of email addresses to receive a comment notification.
-                 * @param int      $comment_id The comment ID.
+                 * @param string   $comment_id The comment ID as a numeric string.
                  */
                 $emails = apply_filters( 'comment_notification_recipients', $emails, $comment->comment_ID );
@@ -1606 +1606 @@
                  * @since 3.8.0
                  *
-                 * @param bool $notify     Whether to notify the post author of their own comment.
-                 *                         Default false.
-                 * @param int  $comment_id The comment ID.
+                 * @param bool   $notify     Whether to notify the post author of their own comment.
+                 *                           Default false.
+                 * @param string $comment_id The comment ID as a numeric string.
                  */
                 $notify_author = apply_filters( 'comment_notification_notify_author', false, $comment->comment_ID );
@@ -1741 +1741 @@
                  *
                  * @param string $notify_message The comment notification email text.
-                 * @param int    $comment_id     Comment ID.
+                 * @param string $comment_id     Comment ID as a numeric string.
                  */
                 $notify_message = apply_filters( 'comment_notification_text', $notify_message, $comment->comment_ID );
@@ -1751 +1751 @@
                  *
                  * @param string $subject    The comment notification email subject.
-                 * @param int    $comment_id Comment ID.
+                 * @param string $comment_id Comment ID as a numeric string.
                  */
                 $subject = apply_filters( 'comment_notification_subject', $subject, $comment->comment_ID );
@@ -1761 +1761 @@
                  *
                  * @param string $message_headers Headers for the comment notification email.
-                 * @param int    $comment_id      Comment ID.
+                 * @param string $comment_id      Comment ID as a numeric string.
                  */
                 $message_headers = apply_filters( 'comment_notification_headers', $message_headers, $comment->comment_ID );