Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Clarify phpdoc for `get_comment_author_link()`. 

props nofearinc. Fixes #24508.

Built from https://develop.svn.wordpress.org/trunk@25494


git-svn-id: http://core.svn.wordpress.org/trunk@25415 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2013-09-19 05:56:10 +00:00
parent bd2425dd9c
commit 98d5c50e5f
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
wp-includes/comment-template.php
View File

@ -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 );