Changeset 47008

Timestamp:

12/24/2019 04:08:34 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for get_comment_author_url().

Props stevenlinx.
Fixes #49076.

File:

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

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

@@ -243 +243 @@
 
 /**
- * Display the html link to the url of the author of the current comment.
+ * Display the HTML link to the URL of the author of the current comment.
  *
  * @since 0.71
@@ -295 +295 @@
 
 /**
- * Retrieve the url of the author of the current comment.
+ * Retrieves the URL of the author of the current comment, not linked.
  *
  * @since 1.5.0
@@ -302 +302 @@
  * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
  *                                   Default current comment.
- * @return string Comment author URL.
+ * @return string Comment author URL, if provided, an empty string otherwise.
  */
 function get_comment_author_url( $comment_ID = 0 ) {
@@ -328 +328 @@
 
 /**
- * Display the url of the author of the current comment.
+ * Displays the URL of the author of the current comment, not linked.
  *
  * @since 0.71
@@ -353 +353 @@
 
 /**
- * Retrieves the HTML link of the url of the author of the current comment.
+ * Retrieves the HTML link of the URL of the author of the current comment.
  *
  * $linktext parameter is only used if the URL does not exist for the comment
@@ -398 +398 @@
 
 /**
- * Displays the HTML link of the url of the author of the current comment.
+ * Displays the HTML link of the URL of the author of the current comment.
  *
  * @since 0.71
@@ -1350 +1350 @@
 
     /*
-     * The url of the current comment author escaped for use in attributes.
+     * The URL of the current comment author escaped for use in attributes.
      */
     $comment_author_url = esc_url( $commenter['comment_author_url'] );