WordPress.org

Make WordPress Core

Changeset 47009


Ignore:
Timestamp:
12/24/2019 04:17:17 PM (11 months ago)
Author:
SergeyBiryukov
Message:

Docs: Use a third-person singular verb for comment template function descriptions, per the documentation standards.

See #48303.

File:
1 edited

Legend:

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

    r47008 r47009  
    1010
    1111/**
    12  * Retrieve the author of the current comment.
     12 * Retrieves the author of the current comment.
    1313 *
    1414 * If the comment has an empty comment_author field, then 'Anonymous' person is
     
    7575
    7676/**
    77  * Retrieve the email of the author of the current comment.
     77 * Retrieves the email of the author of the current comment.
    7878 *
    7979 * @since 1.5.0
     
    101101
    102102/**
    103  * Display the email of the author of the current global $comment.
     103 * Displays the email of the author of the current global $comment.
    104104 *
    105105 * Care should be taken to protect the email address and assure that email
     
    132132
    133133/**
    134  * Display the html email link to the author of the current comment.
     134 * Displays the HTML email link to the author of the current comment.
    135135 *
    136136 * Care should be taken to protect the email address and assure that email
     
    157157
    158158/**
    159  * Return the html email link to the author of the current comment.
     159 * Returns the HTML email link to the author of the current comment.
    160160 *
    161161 * Care should be taken to protect the email address and assure that email
     
    205205
    206206/**
    207  * Retrieve the HTML link to the URL of the author of the current comment.
     207 * Retrieves the HTML link to the URL of the author of the current comment.
    208208 *
    209209 * Both get_comment_author_url() and get_comment_author() rely on get_comment(),
     
    243243
    244244/**
    245  * Display the HTML link to the URL of the author of the current comment.
     245 * Displays the HTML link to the URL of the author of the current comment.
    246246 *
    247247 * @since 0.71
     
    282282
    283283/**
    284  * Display the IP address of the author of the current comment.
     284 * Displays the IP address of the author of the current comment.
    285285 *
    286286 * @since 0.71
     
    538538
    539539/**
    540  * Retrieve the comment date of the current comment.
     540 * Retrieves the comment date of the current comment.
    541541 *
    542542 * @since 1.5.0
     
    568568
    569569/**
    570  * Display the comment date of the current comment.
     570 * Displays the comment date of the current comment.
    571571 *
    572572 * @since 0.71
     
    625625
    626626/**
    627  * Display the excerpt of the current comment.
     627 * Displays the excerpt of the current comment.
    628628 *
    629629 * @since 1.2.0
     
    650650
    651651/**
    652  * Retrieve the comment id of the current comment.
     652 * Retrieves the comment id of the current comment.
    653653 *
    654654 * @since 1.5.0
     
    672672
    673673/**
    674  * Display the comment id of the current comment.
     674 * Displays the comment id of the current comment.
    675675 *
    676676 * @since 0.71
     
    681681
    682682/**
    683  * Retrieve the link to a given comment.
     683 * Retrieves the link to a given comment.
    684684 *
    685685 * @since 1.5.0
     
    819819
    820820/**
    821  * Display the link to the current post comments.
     821 * Displays the link to the current post comments.
    822822 *
    823823 * @since 0.71
     
    867867
    868868/**
    869  * Display the language string for the number of comments the current post has.
     869 * Displays the language string for the number of comments the current post has.
    870870 *
    871871 * @since 0.71
     
    884884
    885885/**
    886  * Display the language string for the number of comments the current post has.
     886 * Displays the language string for the number of comments the current post has.
    887887 *
    888888 * @since 4.0.0
     
    945945
    946946/**
    947  * Retrieve the text of the current comment.
     947 * Retrieves the text of the current comment.
    948948 *
    949949 * @since 1.5.0
     
    975975
    976976/**
    977  * Display the text of the current comment.
     977 * Displays the text of the current comment.
    978978 *
    979979 * @since 0.71
     
    10051005
    10061006/**
    1007  * Retrieve the comment time of the current comment.
     1007 * Retrieves the comment time of the current comment.
    10081008 *
    10091009 * @since 1.5.0
     
    10401040
    10411041/**
    1042  * Display the comment time of the current comment.
     1042 * Displays the comment time of the current comment.
    10431043 *
    10441044 * @since 0.71
     
    10511051
    10521052/**
    1053  * Retrieve the comment type of the current comment.
     1053 * Retrieves the comment type of the current comment.
    10541054 *
    10551055 * @since 1.5.0
     
    10801080
    10811081/**
    1082  * Display the comment type of the current comment.
     1082 * Displays the comment type of the current comment.
    10831083 *
    10841084 * @since 0.71
     
    11121112
    11131113/**
    1114  * Retrieve The current post's trackback URL.
     1114 * Retrieves the current post's trackback URL.
    11151115 *
    11161116 * There is a check to see if permalink's have been enabled and if so, will
     
    11401140
    11411141/**
    1142  * Display the current post's trackback URL.
     1142 * Displays the current post's trackback URL.
    11431143 *
    11441144 * @since 0.71
     
    11691169
    11701170/**
    1171  * Generate and display the RDF for the trackback information of current post.
     1171 * Generates and displays the RDF for the trackback information of current post.
    11721172 *
    11731173 * Deprecated in 3.0.0, and restored in 3.0.1.
     
    12611261
    12621262/**
    1263  * Display form token for unfiltered comments.
     1263 * Displays form token for unfiltered comments.
    12641264 *
    12651265 * Will only display nonce token if the current user has permissions for
     
    12851285
    12861286/**
    1287  * Load the comment template specified in $file.
     1287 * Loads the comment template specified in $file.
    12881288 *
    12891289 * Will not display the comments template if not on single post or page, or if
     
    15981598
    15991599/**
    1600  * Retrieve HTML content for reply to comment link.
     1600 * Retrieves HTML content for reply to comment link.
    16011601 *
    16021602 * @since 2.7.0
     
    17431743
    17441744/**
    1745  * Retrieve HTML content for reply to post link.
     1745 * Retrieves HTML content for reply to post link.
    17461746 *
    17471747 * @since 2.7.0
     
    18331833
    18341834/**
    1835  * Retrieve HTML content for cancel comment reply link.
     1835 * Retrieves HTML content for cancel comment reply link.
    18361836 *
    18371837 * @since 2.7.0
     
    18631863
    18641864/**
    1865  * Display HTML content for cancel comment reply link.
     1865 * Displays HTML content for cancel comment reply link.
    18661866 *
    18671867 * @since 2.7.0
     
    18741874
    18751875/**
    1876  * Retrieve hidden input HTML for replying to comments.
     1876 * Retrieves hidden input HTML for replying to comments.
    18771877 *
    18781878 * @since 3.0.0
     
    19031903
    19041904/**
    1905  * Output hidden input HTML for replying to comments.
     1905 * Outputs hidden input HTML for replying to comments.
    19061906 *
    19071907 * @since 2.7.0
     
    19141914
    19151915/**
    1916  * Display text based on comment reply status.
     1916 * Displays text based on comment reply status.
    19171917 *
    19181918 * Only affects users with JavaScript disabled.
     
    19571957
    19581958/**
    1959  * List comments.
     1959 * Displays a list of comments.
    19601960 *
    19611961 * Used in the comments.php template to list comments for a particular post.
Note: See TracChangeset for help on using the changeset viewer.