WordPress.org

Make WordPress Core

Changeset 37349


Ignore:
Timestamp:
05/02/2016 08:03:24 PM (3 years ago)
Author:
DrewAPicture
Message:

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

Also adds a missing return description for get_comment_author_email_link().

Props flixos90 for the initial patch.
Fixes #36571.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/comment-template.php

    r37348 r37349  
    141141 * @since 4.6.0 The `$comment` parameter was added.
    142142 *
    143  * @param string $linktext Optional. Text to display instead of the comment author's email address.
    144  *                         Default empty.
    145  * @param string $before   Optional. Text or HTML to display before the email link. Default empty.
    146  * @param string $after    Optional. Text or HTML to display after the email link. Default empty.
    147  * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
     143 * @param string         $linktext Optional. Text to display instead of the comment author's email address.
     144 *                                 Default empty.
     145 * @param string         $before   Optional. Text or HTML to display before the email link. Default empty.
     146 * @param string         $after    Optional. Text or HTML to display after the email link. Default empty.
     147 * @param int|WP_Comment $comment  Optional. Comment ID or WP_Comment object. Default is the current comment.
    148148 */
    149149function comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
     
    165165 * @since 4.6.0 The `$comment` parameter was added.
    166166 *
    167  * @param string $linktext Optional. Text to display instead of the comment author's email address.
    168  *                         Default empty.
    169  * @param string $before   Optional. Text or HTML to display before the email link. Default empty.
    170  * @param string $after    Optional. Text or HTML to display after the email link. Default empty.
    171  * @param int|WP_Comment $comment Optional. Comment ID or WP_Comment object. Default is the current comment.
    172  * @return string
     167 * @param string         $linktext Optional. Text to display instead of the comment author's email address.
     168 *                                 Default empty.
     169 * @param string         $before   Optional. Text or HTML to display before the email link. Default empty.
     170 * @param string         $after    Optional. Text or HTML to display after the email link. Default empty.
     171 * @param int|WP_Comment $comment  Optional. Comment ID or WP_Comment object. Default is the current comment.
     172 * @return string HTML markup for the comment author email link. By default, the email address is obfuscated
     173 *                via the {@see 'comment_email'} filter with antispambot().
    173174 */
    174175function get_comment_author_email_link( $linktext = '', $before = '', $after = '', $comment = null ) {
Note: See TracChangeset for help on using the changeset viewer.