Changeset 51300 for trunk/src/wp-includes/comment-template.php

Timestamp:

07/01/2021 09:11:48 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Descriptive improvements and corrections for various docblocks.

See #53399

File:

• trunk/src/wp-includes/comment-template.php (modified) (2 diffs)

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

@@ -263 +263 @@
  * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
  *                                   Default current comment.
- * @return string Comment author's IP address.
+ * @return string Comment author's IP address, or an empty string if it's not available.
  */
 function get_comment_author_IP( $comment_ID = 0 ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
@@ -274 +274 @@
      * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
      *
-     * @param string     $comment_author_IP The comment author's IP address.
+     * @param string     $comment_author_IP The comment author's IP address, or an empty string if it's not available.
      * @param int        $comment_ID        The comment ID.
      * @param WP_Comment $comment           The comment object.