Make WordPress Core


Ignore:
Timestamp:
04/26/2022 06:18:30 AM (2 years ago)
Author:
audrasjb
Message:

Docs: Use third-person singular verbs for function descriptions in Core Comment API and Comment template functions.

See #54729.

File:
1 edited

Legend:

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

    r53225 r53265  
    88
    99/**
    10  * Check whether a comment passes internal checks to be allowed to add.
     10 * Checks whether a comment passes internal checks to be allowed to add.
    1111 *
    1212 * If manual comment moderation is set in the administration, then all checks,
     
    150150
    151151/**
    152  * Retrieve the approved comments for post $post_id.
     152 * Retrieves the approved comments for post $post_id.
    153153 *
    154154 * @since 2.0.0
     
    230230
    231231/**
    232  * Retrieve a list of comments.
     232 * Retrieves a list of comments.
    233233 *
    234234 * The comment list can be for the blog as a whole or for an individual post.
     
    246246
    247247/**
    248  * Retrieve all of the WordPress supported comment statuses.
     248 * Retrieves all of the WordPress supported comment statuses.
    249249 *
    250250 * Comments have a limited set of valid status values, this provides the comment
     
    311311
    312312/**
    313  * The date the last comment was modified.
     313 * Retrieves the date the last comment was modified.
    314314 *
    315315 * @since 1.5.0
     
    418418
    419419/**
    420  * Add meta data field to a comment.
     420 * Adds meta data field to a comment.
    421421 *
    422422 * @since 2.9.0
     
    436436
    437437/**
    438  * Remove metadata matching criteria from a comment.
     438 * Removes metadata matching criteria from a comment.
    439439 *
    440440 * You can match based on the key, or key and value. Removing based on key and
     
    458458
    459459/**
    460  * Retrieve comment meta field for a comment.
     460 * Retrieves comment meta field for a comment.
    461461 *
    462462 * @since 2.9.0
     
    480480
    481481/**
    482  * Update comment meta field based on comment ID.
     482 * Updates comment meta field based on comment ID.
    483483 *
    484484 * Use the $prev_value parameter to differentiate between meta fields with the
     
    978978
    979979/**
    980  * Calculate the total number of comment pages.
     980 * Calculates the total number of comment pages.
    981981 *
    982982 * @since 2.7.0
     
    10351035
    10361036/**
    1037  * Calculate what page number a comment will appear on for comment paging.
     1037 * Calculates what page number a comment will appear on for comment paging.
    10381038 *
    10391039 * @since 2.7.0
     
    16171617
    16181618/**
    1619  * Marks a comment as Spam
     1619 * Marks a comment as Spam.
    16201620 *
    16211621 * @since 2.9.0
     
    16651665
    16661666/**
    1667  * Removes a comment from the Spam
     1667 * Removes a comment from the Spam.
    16681668 *
    16691669 * @since 2.9.0
     
    17161716
    17171717/**
    1718  * The status of a comment by ID.
     1718 * Retrieves the status of a comment by comment ID.
    17191719 *
    17201720 * @since 1.0.0
     
    17471747
    17481748/**
    1749  * Call hooks for when a comment status transition occurs.
     1749 * Calls hooks for when a comment status transition occurs.
    17501750 *
    17511751 * Calls hooks for comment status transitions. If the new comment status is not the same
     
    18451845
    18461846/**
    1847  * Clear the lastcommentmodified cached value when a comment status is changed.
     1847 * Clears the lastcommentmodified cached value when a comment status is changed.
    18481848 *
    18491849 * Deletes the lastcommentmodified cache key when a comment enters or leaves
     
    18671867
    18681868/**
    1869  * Get current commenter's name, email, and URL.
     1869 * Gets current commenter's name, email, and URL.
    18701870 *
    18711871 * Expects cookies content to already be sanitized. User of this function might
     
    19191919
    19201920/**
    1921  * Get unapproved comment author's email.
     1921 * Gets unapproved comment author's email.
    19221922 *
    19231923 * Used to allow the commenter to see their pending comment.
     
    21182118
    21192119/**
    2120  * Whether a comment should be blocked because of comment flood.
     2120 * Determines whether a comment should be blocked because of comment flood.
    21212121 *
    21222122 * @since 2.1.0
     
    22882288
    22892289/**
    2290  * Send a comment moderation notification to the comment moderator.
     2290 * Sends a comment moderation notification to the comment moderator.
    22912291 *
    22922292 * @since 4.4.0
     
    23122312
    23132313/**
    2314  * Send a notification of a new comment to the post author.
     2314 * Sends a notification of a new comment to the post author.
    23152315 *
    23162316 * @since 4.4.0
     
    25682568
    25692569/**
    2570  * Whether to defer comment counting.
     2570 * Determines whether to defer comment counting.
    25712571 *
    25722572 * When setting $defer to true, all post comment counts will not be updated
     
    28032803
    28042804/**
    2805  * Perform all pingbacks, enclosures, trackbacks, and send to pingback services.
     2805 * Performs all pingbacks, enclosures, trackbacks, and sends to pingback services.
    28062806 *
    28072807 * @since 2.1.0
     
    28182818
    28192819/**
    2820  * Perform all pingbacks.
     2820 * Performs all pingbacks.
    28212821 *
    28222822 * @since 5.6.0
     
    28402840
    28412841/**
    2842  * Perform all enclosures.
     2842 * Performs all enclosures.
    28432843 *
    28442844 * @since 5.6.0
     
    28622862
    28632863/**
    2864  * Perform all trackbacks.
     2864 * Performs all trackbacks.
    28652865 *
    28662866 * @since 5.6.0
     
    28842884
    28852885/**
    2886  * Perform trackbacks.
     2886 * Performs trackbacks.
    28872887 *
    28882888 * @since 1.5.0
     
    30723072
    30733073/**
    3074  * Check whether blog is public before returning sites.
     3074 * Checks whether blog is public before returning sites.
    30753075 *
    30763076 * @since 2.1.0
     
    30883088
    30893089/**
    3090  * Send a Trackback.
     3090 * Sends a Trackback.
    30913091 *
    30923092 * Updates database when sending trackback to prevent duplicates.
     
    31293129
    31303130/**
    3131  * Send a pingback.
     3131 * Sends a pingback.
    31323132 *
    31333133 * @since 1.2.0
     
    31543154
    31553155/**
    3156  * Default filter attached to pingback_ping_source_uri to validate the pingback's Source URI
     3156 * Default filter attached to pingback_ping_source_uri to validate the pingback's Source URI.
    31573157 *
    31583158 * @since 3.5.1
     
    32733273
    32743274/**
    3275  * Close comments on old posts on the fly, without any extra DB queries. Hooked to the_posts.
     3275 * Closes comments on old posts on the fly, without any extra DB queries. Hooked to the_posts.
    32763276 *
    32773277 * @since 2.7.0
     
    33133313
    33143314/**
    3315  * Close comments on an old post. Hooked to comments_open and pings_open.
     3315 * Closes comments on an old post. Hooked to comments_open and pings_open.
    33163316 *
    33173317 * @since 2.7.0
Note: See TracChangeset for help on using the changeset viewer.