From 090b527065216b671896cfbf342f0b5516412e5d Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 19 Sep 2013 05:55:01 +0000 Subject: [PATCH] Clarify phpdoc for `get_comment_author_link()`. props nofearinc. Fixes #24508. git-svn-id: https://develop.svn.wordpress.org/trunk@25494 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/comment-template.php | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/comment-template.php b/src/wp-includes/comment-template.php index 4744fa7deb..8a686582e0 100644 --- a/src/wp-includes/comment-template.php +++ b/src/wp-includes/comment-template.php @@ -136,16 +136,17 @@ function get_comment_author_email_link($linktext='', $before='', $after='') { } /** - * Retrieve the html link to the url of the author of the current comment. + * Retrieve the HTML link to the URL of the author of the current comment. + * + * Both get_comment_author_url() and get_comment_author() rely on get_comment(), + * which falls back to the global comment variable if the $comment_ID argument is empty. * * @since 1.5.0 - * @uses apply_filters() Calls 'get_comment_author_link' hook on the complete link HTML or author * - * @param int $comment_ID The ID of the comment for which to get the author's link. Optional. - * @return string Comment Author name or HTML link for author's URL + * @param int $comment_ID Optional. The ID of the comment for which to get the author's link. + * @return string The comment author name or HTML link for author's URL. */ function get_comment_author_link( $comment_ID = 0 ) { - /** @todo Only call these functions when they are needed. Include in if... else blocks */ $url = get_comment_author_url( $comment_ID ); $author = get_comment_author( $comment_ID );