From 37916c2a5fc19ea65cb2f6598bfe07192432c906 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Mon, 30 Apr 2018 13:09:21 +0000 Subject: [PATCH] Comments: Update the inline docs following [42772]. See #43436 git-svn-id: https://develop.svn.wordpress.org/trunk@43042 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-comments-post.php | 5 +++-- src/wp-includes/comment.php | 9 +++++---- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/src/wp-comments-post.php b/src/wp-comments-post.php index 1836166fcd..c61e73dcd1 100644 --- a/src/wp-comments-post.php +++ b/src/wp-comments-post.php @@ -44,10 +44,11 @@ $cookies_consent = ( isset( $_POST['wp-comment-cookies-consent'] ) ); * Perform other actions when comment cookies are set. * * @since 3.4.0 + * @since 4.9.6 The `$cookies_consent` parameter was added. * * @param WP_Comment $comment Comment object. - * @param WP_User $user User object. The user may not exist. - * @param boolean $cookies_consent Whether the user has opted-in commenter cookies. + * @param WP_User $user Comment author's user object. The user may not exist. + * @param boolean $cookies_consent Comment author's consent to store cookies. */ do_action( 'set_comment_cookies', $comment, $user, $cookies_consent ); diff --git a/src/wp-includes/comment.php b/src/wp-includes/comment.php index 974bc2897f..5efa23010b 100644 --- a/src/wp-includes/comment.php +++ b/src/wp-includes/comment.php @@ -540,11 +540,12 @@ function wp_queue_comments_for_comment_meta_lazyload( $comments ) { * Sets the cookies used to store an unauthenticated commentator's identity. Typically used * to recall previous comments by this commentator that are still held in moderation. * - * @param WP_Comment $comment Comment object. - * @param object $user Comment author's object. - * @param boolean $cookies_consent Optional. Comment author's consent to store cookies. Default true. - * * @since 3.4.0 + * @since 4.9.6 The `$cookies_consent` parameter was added. + * + * @param WP_Comment $comment Comment object. + * @param WP_User $user Comment author's user object. The user may not exist. + * @param boolean $cookies_consent Optional. Comment author's consent to store cookies. Default true. */ function wp_set_comment_cookies( $comment, $user, $cookies_consent = true ) { // If the user already exists, or the user opted out of cookies, don't set cookies.