Make WordPress Core

Changeset 37497


Ignore:
Timestamp:
05/22/2016 06:25:17 PM (10 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in wp-includes/comment-template.php to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

File:
1 edited

Legend:

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

    r37431 r37497  
    3535
    3636        /**
    37          * Filter the returned comment author name.
     37         * Filters the returned comment author name.
    3838         *
    3939         * @since 1.5.0
     
    6161
    6262        /**
    63          * Filter the comment author's name for display.
     63         * Filters the comment author's name for display.
    6464         *
    6565         * @since 1.2.0
     
    8686
    8787        /**
    88          * Filter the comment author's returned email address.
     88         * Filters the comment author's returned email address.
    8989         *
    9090         * @since 1.5.0
     
    118118
    119119        /**
    120          * Filter the comment author's email for display.
     120         * Filters the comment author's email for display.
    121121         *
    122122         * @since 1.2.0
     
    177177
    178178        /**
    179          * Filter the comment author's email for display.
     179         * Filters the comment author's email for display.
    180180         *
    181181         * Care should be taken to protect the email address and assure that email
     
    225225
    226226        /**
    227          * Filter the comment author's link for display.
     227         * Filters the comment author's link for display.
    228228         *
    229229         * @since 1.5.0
     
    265265
    266266        /**
    267          * Filter the comment author's returned IP address.
     267         * Filters the comment author's returned IP address.
    268268         *
    269269         * @since 1.5.0
     
    311311
    312312        /**
    313          * Filter the comment author's URL.
     313         * Filters the comment author's URL.
    314314         *
    315315         * @since 1.5.0
     
    337337
    338338        /**
    339          * Filter the comment author's URL for display.
     339         * Filters the comment author's URL for display.
    340340         *
    341341         * @since 1.2.0
     
    384384
    385385        /**
    386          * Filter the comment author's returned URL link.
     386         * Filters the comment author's returned URL link.
    387387         *
    388388         * @since 1.5.0
     
    513513
    514514        /**
    515          * Filter the returned CSS classes for the current comment.
     515         * Filters the returned CSS classes for the current comment.
    516516         *
    517517         * @since 2.7.0
     
    544544                $date = mysql2date($d, $comment->comment_date);
    545545        /**
    546          * Filter the returned comment date.
     546         * Filters the returned comment date.
    547547         *
    548548         * @since 1.5.0
     
    589589
    590590        /**
    591          * Filter the amount of words used in the comment excerpt.
     591         * Filters the amount of words used in the comment excerpt.
    592592         *
    593593         * @since 4.4.0
     
    607607        }
    608608        /**
    609          * Filter the retrieved comment excerpt.
     609         * Filters the retrieved comment excerpt.
    610610         *
    611611         * @since 1.5.0
     
    633633
    634634        /**
    635          * Filter the comment excerpt for display.
     635         * Filters the comment excerpt for display.
    636636         *
    637637         * @since 1.2.0
     
    655655
    656656        /**
    657          * Filter the returned comment ID.
     657         * Filters the returned comment ID.
    658658         *
    659659         * @since 1.5.0
     
    776776
    777777        /**
    778          * Filter the returned single comment permalink.
     778         * Filters the returned single comment permalink.
    779779         *
    780780         * @since 2.8.0
     
    804804
    805805        /**
    806          * Filter the returned post comments permalink.
     806         * Filters the returned post comments permalink.
    807807         *
    808808         * @since 3.6.0
     
    849849
    850850        /**
    851          * Filter the returned comment count for a post.
     851         * Filters the returned comment count for a post.
    852852         *
    853853         * @since 1.5.0
     
    902902        }
    903903        /**
    904          * Filter the comments count for display.
     904         * Filters the comments count for display.
    905905         *
    906906         * @since 1.5.0
     
    932932
    933933        /**
    934          * Filter the text of a comment.
     934         * Filters the text of a comment.
    935935         *
    936936         * @since 1.5.0
     
    962962        $comment_text = get_comment_text( $comment, $args );
    963963        /**
    964          * Filter the text of a comment to be displayed.
     964         * Filters the text of a comment to be displayed.
    965965         *
    966966         * @since 1.2.0
     
    996996
    997997        /**
    998          * Filter the returned comment time.
     998         * Filters the returned comment time.
    999999         *
    10001000         * @since 1.5.0
     
    10361036
    10371037        /**
    1038          * Filter the returned comment type.
     1038         * Filters the returned comment type.
    10391039         *
    10401040         * @since 1.5.0
     
    10921092
    10931093        /**
    1094          * Filter the returned trackback URL.
     1094         * Filters the returned trackback URL.
    10951095         *
    10961096         * @since 2.2.0
     
    11741174
    11751175        /**
    1176          * Filter whether the current post is open for comments.
     1176         * Filters whether the current post is open for comments.
    11771177         *
    11781178         * @since 2.5.0
     
    11991199
    12001200        /**
    1201          * Filter whether the current post is open for pings.
     1201         * Filters whether the current post is open for pings.
    12021202         *
    12031203         * @since 2.5.0
     
    14071407
    14081408        /**
    1409          * Filter the comments array.
     1409         * Filters the comments array.
    14101410         *
    14111411         * @since 2.1.0
     
    14381438        $theme_template = STYLESHEETPATH . $file;
    14391439        /**
    1440          * Filter the path to the theme template file used for the comments template.
     1440         * Filters the path to the theme template file used for the comments template.
    14411441         *
    14421442         * @since 1.5.1
     
    15071507                $respond_link = get_permalink() . '#respond';
    15081508                /**
    1509                  * Filter the respond link when a post has no comments.
     1509                 * Filters the respond link when a post has no comments.
    15101510                 *
    15111511                 * @since 4.4.0
     
    15261526        $attributes = '';
    15271527        /**
    1528          * Filter the comments link attributes for display.
     1528         * Filters the comments link attributes for display.
    15291529         *
    15301530         * @since 2.5.0
     
    15971597
    15981598        /**
    1599          * Filter the comment reply link arguments.
     1599         * Filters the comment reply link arguments.
    16001600         *
    16011601         * @since 4.1.0
     
    16271627
    16281628        /**
    1629          * Filter the comment reply link.
     1629         * Filters the comment reply link.
    16301630         *
    16311631         * @since 2.7.0
     
    17161716
    17171717        /**
    1718          * Filter the formatted post comments link HTML.
     1718         * Filters the formatted post comments link HTML.
    17191719         *
    17201720         * @since 2.7.0
     
    17601760
    17611761        /**
    1762          * Filter the cancel comment reply link HTML.
     1762         * Filters the cancel comment reply link HTML.
    17631763         *
    17641764         * @since 2.7.0
     
    17991799
    18001800        /**
    1801          * Filter the returned comment id fields.
     1801         * Filters the returned comment id fields.
    18021802         *
    18031803         * @since 3.0.0
     
    19251925
    19261926        /**
    1927          * Filter the arguments used in retrieving the comment list.
     1927         * Filters the arguments used in retrieving the comment list.
    19281928         *
    19291929         * @since 4.0.0
     
    21592159
    21602160        /**
    2161          * Filter the default comment form fields.
     2161         * Filters the default comment form fields.
    21622162         *
    21632163         * @since 3.0.0
     
    22072207
    22082208        /**
    2209          * Filter the comment form default arguments.
     2209         * Filters the comment form default arguments.
    22102210         *
    22112211         * Use 'comment_form_default_fields' to filter the comment fields.
     
    22632263                                        if ( is_user_logged_in() ) :
    22642264                                                /**
    2265                                                  * Filter the 'logged in' message for the comment form for display.
     2265                                                 * Filters the 'logged in' message for the comment form for display.
    22662266                                                 *
    22672267                                                 * @since 3.0.0
     
    22972297
    22982298                                        /**
    2299                                          * Filter the comment form fields, including the textarea.
     2299                                         * Filters the comment form fields, including the textarea.
    23002300                                         *
    23012301                                         * @since 4.4.0
     
    23172317
    23182318                                                        /**
    2319                                                          * Filter the content of the comment textarea field for display.
     2319                                                         * Filters the content of the comment textarea field for display.
    23202320                                                         *
    23212321                                                         * @since 3.0.0
     
    23392339
    23402340                                                        /**
    2341                                                          * Filter a comment form field for display.
     2341                                                         * Filters a comment form field for display.
    23422342                                                         *
    23432343                                                         * The dynamic portion of the filter hook, `$name`, refers to the name
     
    23702370
    23712371                                        /**
    2372                                          * Filter the submit button for the comment form to display.
     2372                                         * Filters the submit button for the comment form to display.
    23732373                                         *
    23742374                                         * @since 4.2.0
     
    23862386
    23872387                                        /**
    2388                                          * Filter the submit field for the comment form to display.
     2388                                         * Filters the submit field for the comment form to display.
    23892389                                         *
    23902390                                         * The submit field includes the submit button, hidden fields for the
Note: See TracChangeset for help on using the changeset viewer.