WordPress.org

Make WordPress Core

Changeset 34237


Ignore:
Timestamp:
09/16/2015 01:51:13 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Add changelog entries for parameters where WP_Comment object support was added in [33961].

See #33638. See #32246.

File:
1 edited

Legend:

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

    r34216 r34237  
    1616 *
    1717 * @since 1.5.0
     18 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    1819 *
    1920 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to retrieve the author.
     
    5051 *
    5152 * @since 0.71
     53 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    5254 *
    5355 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author.
     
    7476 *
    7577 * @since 1.5.0
     78 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    7679 *
    7780 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's email.
     
    105108 *
    106109 * @since 0.71
     110 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    107111 *
    108112 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's email.
     
    196200 *
    197201 * @since 1.5.0
     202 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    198203 *
    199204 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's link.
     
    229234 *
    230235 * @since 0.71
     236 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    231237 *
    232238 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's link.
     
    241247 *
    242248 * @since 1.5.0
     249 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    243250 *
    244251 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's IP address.
     
    266273 *
    267274 * @since 0.71
     275 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    268276 *
    269277 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's IP address.
     
    278286 *
    279287 * @since 1.5.0
     288 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    280289 *
    281290 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to get the author's URL.
    282291 *                                   Default current comment.
    283  * @return string
     292 * @return string Comment author URL.
    284293 */
    285294function get_comment_author_url( $comment_ID = 0 ) {
     
    305314 *
    306315 * @since 0.71
     316 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    307317 *
    308318 * @param int|WP_Comment $comment_ID Optional. WP_Comment or the ID of the comment for which to print the author's URL.
     
    387397 *
    388398 * @since 2.7.0
     399 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
    389400 *
    390401 * @param string|array   $class    Optional. One or more classes to add to the class list.
     
    394405 * @param bool           $echo     Optional. Whether to cho or return the output.
    395406 *                                 Default true.
    396  * @return string|void
     407 * @return string If `$echo` is false, the class will be returned. Void otherwise.
    397408 */
    398409function comment_class( $class = '', $comment = null, $post_id = null, $echo = true ) {
     
    409420 *
    410421 * @since 2.7.0
     422 * @since 4.4.0 Added the ability for `$comment_id` to also accept a WP_Comment object.
    411423 *
    412424 * @global int $comment_alt
     
    486498     * @param string      $class      A comma-separated list of additional classes added to the list.
    487499     * @param int         $comment_id The comment id.
    488      * @param object      $comment    The comment
     500     * @param WP_Comment  $comment    The comment object.
    489501     * @param int|WP_Post $post_id    The post ID or WP_Post object.
    490502     */
     
    496508 *
    497509 * @since 1.5.0
     510 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    498511 *
    499512 * @param string          $d          Optional. The format of the date. Default user's setting.
     
    524537 *
    525538 * @since 0.71
    526  *
    527  * @param string          $d          Optional. The format of the date. Default user's settings.
    528  * @param int|WP_Comment  $comment_ID WP_Comment or ID of the comment for which to print the date.
    529  *                                    Default current comment.
     539 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
     540 *
     541 * @param string         $d          Optional. The format of the date. Default user's settings.
     542 * @param int|WP_Comment $comment_ID WP_Comment or ID of the comment for which to print the date.
     543 *                                   Default current comment.
    530544 */
    531545function comment_date( $d = '', $comment_ID = 0 ) {
     
    541555 *
    542556 * @since 1.5.0
     557 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    543558 *
    544559 * @param int|WP_Comment $comment_ID  WP_Comment or ID of the comment for which to get the excerpt.
     
    582597 *
    583598 * @since 1.2.0
     599 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    584600 *
    585601 * @param int|WP_Comment $comment_ID  WP_Comment or ID of the comment for which to print the excerpt.
     
    637653 *
    638654 * @since 1.5.0
     655 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
    639656 *
    640657 * @see get_page_of_comment()
     
    696713
    697714/**
    698  * Retrieve the link to the current post comments.
     715 * Retrieves the link to the current post comments.
    699716 *
    700717 * @since 1.5.0
     
    706723    $hash = get_comments_number( $post_id ) ? '#comments' : '#respond';
    707724    $comments_link = get_permalink( $post_id ) . $hash;
     725
    708726    /**
    709727     * Filter the returned post comments permalink.
     
    816834 *
    817835 * @since 1.5.0
     836 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    818837 *
    819838 * @see Walker_Comment::comment()
     
    845864 *
    846865 * @since 0.71
     866 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
    847867 *
    848868 * @see Walker_Comment::comment()
     
    919939 *
    920940 * @since 1.5.0
    921  *
    922  * @param int|WP_Comment $comment_ID  WP_Comment or ID of the comment for which to get the type.
    923  *                                    Default current comment.
     941 * @since 4.4.0 Added the ability for `$comment_ID` to also accept a WP_Comment object.
     942 *
     943 * @param int|WP_Comment $comment_ID Optional. WP_Comment or ID of the comment for which to get the type.
     944 *                                   Default current comment.
    924945 * @return string The comment type.
    925946 */
     
    13841405 *
    13851406 * @since 2.7.0
     1407 * @since 4.4.0 Added the ability for `$comment` to also accept a WP_Comment object.
    13861408 *
    13871409 * @param array $args {
     
    14011423 *     @type string $after      The text or HTML to add after the reply link. Default empty.
    14021424 * }
    1403  * @param int        $comment Comment being replied to. Default current comment.
    1404  * @param int|WP_Post $post    Post ID or WP_Post object the comment is going to be displayed on.
    1405  *                             Default current post.
     1425 * @param int|WP_Comment $comment Comment being replied to. Default current comment.
     1426 * @param int|WP_Post    $post    Post ID or WP_Post object the comment is going to be displayed on.
     1427 *                                Default current post.
    14061428 * @return void|false|string Link to show comment form, if successful. False, if comments are closed.
    14071429 */
     
    14411463     * @since 4.1.0
    14421464     *
    1443      * @param array   $args    Comment reply link arguments. See {@see get_comment_reply_link()}
    1444      *                         for more information on accepted arguments.
    1445      * @param object $comment The object of the comment being replied to.
    1446      * @param WP_Post $post    The {@see WP_Post} object.
     1465     * @param array      $args    Comment reply link arguments. See get_comment_reply_link()
     1466     *                            for more information on accepted arguments.
     1467     * @param WP_Comment $comment The object of the comment being replied to.
     1468     * @param WP_Post    $post    The WP_Post object.
    14471469     */
    14481470    $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );
     
    14651487        );
    14661488    }
     1489
    14671490    /**
    14681491     * Filter the comment reply link.
     
    15531576    }
    15541577    $formatted_link = $args['before'] . $link . $args['after'];
     1578
    15551579    /**
    15561580     * Filter the formatted post comments link HTML.
     
    15961620
    15971621    $formatted_link = '<a rel="nofollow" id="cancel-comment-reply-link" href="' . $link . '"' . $style . '>' . $text . '</a>';
     1622
    15981623    /**
    15991624     * Filter the cancel comment reply link HTML.
Note: See TracChangeset for help on using the changeset viewer.