Comments: Update the inline docs following [42772].

See #43436


git-svn-id: https://develop.svn.wordpress.org/trunk@43042 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2018-04-30 13:09:21 +00:00
parent 2e08b275a6
commit 37916c2a5f
2 changed files with 8 additions and 6 deletions

View File

@ -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 );

View File

@ -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.