WordPress.org

Make WordPress Core


Ignore:
Timestamp:
05/22/2016 06:40:47 PM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Standardize filter docs in wp-includes/comment.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.php

    r37487 r37512  
    5252
    5353        /**
    54          * Filter the maximum number of links allowed in a comment.
     54         * Filters the maximum number of links allowed in a comment.
    5555         *
    5656         * @since 3.0.0
     
    271271
    272272    /**
    273      * Filter the default comment status for the given post type.
     273     * Filters the default comment status for the given post type.
    274274     *
    275275     * @since 4.3.0
     
    505505
    506506    /**
    507      * Filter the lifetime of the comment cookie in seconds.
     507     * Filters the lifetime of the comment cookie in seconds.
    508508     *
    509509     * @since 2.8.0
     
    529529    if ( isset( $_COOKIE['comment_author_' . COOKIEHASH] ) ) {
    530530        /**
    531          * Filter the comment author's name cookie before it is set.
     531         * Filters the comment author's name cookie before it is set.
    532532         *
    533533         * When this filter hook is evaluated in wp_filter_comment(),
     
    546546    if ( isset( $_COOKIE['comment_author_email_' . COOKIEHASH] ) ) {
    547547        /**
    548          * Filter the comment author's email cookie before it is set.
     548         * Filters the comment author's email cookie before it is set.
    549549         *
    550550         * When this filter hook is evaluated in wp_filter_comment(),
     
    563563    if ( isset( $_COOKIE['comment_author_url_' . COOKIEHASH] ) ) {
    564564        /**
    565          * Filter the comment author's URL cookie before it is set.
     565         * Filters the comment author's URL cookie before it is set.
    566566         *
    567567         * When this filter hook is evaluated in wp_filter_comment(),
     
    697697
    698698    /**
    699      * Filter a comment's approval status before it is set.
     699     * Filters a comment's approval status before it is set.
    700700     *
    701701     * @since 2.1.0
     
    749749        $time_newcomment  = mysql2date('U', $date, false);
    750750        /**
    751          * Filter the comment flood status.
     751         * Filters the comment flood status.
    752752         *
    753753         * @since 2.1.0
     
    11021102
    11031103    /**
    1104      * Filter the comments count for a given post.
     1104     * Filters the comments count for a given post.
    11051105     *
    11061106     * @since 2.7.0
     
    15091509
    15101510    /**
    1511      * Filter the current commenter's name, email, and URL.
     1511     * Filters the current commenter's name, email, and URL.
    15121512     *
    15131513     * @since 3.1.0
     
    16301630    if ( isset( $commentdata['user_ID'] ) ) {
    16311631        /**
    1632          * Filter the comment author's user id before it is set.
     1632         * Filters the comment author's user id before it is set.
    16331633         *
    16341634         * The first time this filter is evaluated, 'user_ID' is checked
     
    16461646
    16471647    /**
    1648      * Filter the comment author's browser user agent before it is set.
     1648     * Filters the comment author's browser user agent before it is set.
    16491649     *
    16501650     * @since 1.5.0
     
    16561656    $commentdata['comment_author'] = apply_filters( 'pre_comment_author_name', $commentdata['comment_author'] );
    16571657    /**
    1658      * Filter the comment content before it is set.
     1658     * Filters the comment content before it is set.
    16591659     *
    16601660     * @since 1.5.0
     
    16641664    $commentdata['comment_content'] = apply_filters( 'pre_comment_content', $commentdata['comment_content'] );
    16651665    /**
    1666      * Filter the comment author's IP before it is set.
     1666     * Filters the comment author's IP before it is set.
    16671667     *
    16681668     * @since 1.5.0
     
    17461746
    17471747    /**
    1748      * Filter a comment's data before it is sanitized and inserted into the database.
     1748     * Filters a comment's data before it is sanitized and inserted into the database.
    17491749     *
    17501750     * @since 1.5.0
     
    18631863
    18641864    /**
    1865      * Filter whether to send the post author new comment notification emails,
     1865     * Filters whether to send the post author new comment notification emails,
    18661866     * overriding the site setting.
    18671867     *
     
    19991999
    20002000    /**
    2001      * Filter the comment content before it is updated in the database.
     2001     * Filters the comment content before it is updated in the database.
    20022002     *
    20032003     * @since 1.5.0
     
    24222422            $client->timeout = 3;
    24232423            /**
    2424              * Filter the user agent sent when pinging-back a URL.
     2424             * Filters the user agent sent when pinging-back a URL.
    24252425             *
    24262426             * @since 2.9.0
     
    26522652
    26532653    /**
    2654      * Filter the list of post types to automatically close comments for.
     2654     * Filters the list of post types to automatically close comments for.
    26552655     *
    26562656     * @since 3.2.0
Note: See TracChangeset for help on using the changeset viewer.