sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Comments: Realign parameter documentation in the DocBlocks for comment_author_email_link() and get_comment_author_email_link() following [37348].

Browse Source 
Also adds a missing return description for `get_comment_author_email_link()`.

Props flixos90 for the initial patch.
Fixes #36571.


git-svn-id: https://develop.svn.wordpress.org/trunk@37349 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-05-02 20:03:24 +00:00
parent 0f468dd456
commit e85c0d94b9
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/wp-includes/comment-template.php
View File

@ -140,11 +140,11 @@ function comment_author_email( $comment_ID = 0 ) {
* @since 0.71 * @since 0.71
* @since 4.6.0 The `$comment` parameter was added. * @since 4.6.0 The `$comment` parameter was added.
* *
* @param string $linktext Optional. Text to display instead of the comment author's email address. * @param string $linktext Optional. Text to display instead of the comment author's email address.
* Default empty. * Default empty.
* @param string $before Optional. Text or HTML to display before the email link. Default empty. * @param string $before Optional. Text or HTML to display before the email link. Default empty.
* @param string $after Optional. Text or HTML to display after the email link. Default empty. * @param string $after Optional. Text or HTML to display after the email link. Default empty.
* @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment. * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
*/ */
function comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) { function comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
if ( $link = get_comment_author_email_link( $linktext, $before, $after, $comment ) ) { if ( $link = get_comment_author_email_link( $linktext, $before, $after, $comment ) ) {
@ -164,12 +164,13 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '', $
* @since 2.7.0 * @since 2.7.0
* @since 4.6.0 The `$comment` parameter was added. * @since 4.6.0 The `$comment` parameter was added.
* *
* @param string $linktext Optional. Text to display instead of the comment author's email address. * @param string $linktext Optional. Text to display instead of the comment author's email address.
* Default empty. * Default empty.
* @param string $before Optional. Text or HTML to display before the email link. Default empty. * @param string $before Optional. Text or HTML to display before the email link. Default empty.
* @param string $after Optional. Text or HTML to display after the email link. Default empty. * @param string $after Optional. Text or HTML to display after the email link. Default empty.
* @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment. * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
* @return string * @return string HTML markup for the comment author email link. By default, the email address is obfuscated
* via the {@see 'comment_email'} filter with antispambot().
*/ */
function get_comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) { function get_comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
$comment = get_comment( $comment ); $comment = get_comment( $comment );