Changeset 43127 for branches/4.9/src/wp-includes/comment.php

Timestamp:

05/02/2018 10:10:30 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Add a checkbox to the comment form so logged out users can opt-out of commenter cookies.

Props lakenh, xkon, birgire, azaozz, johnbillion.
Merges [42772] and [43042] to the 4.9 branch.
See #43436.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-includes/comment.php (modified) (2 diffs)

branches/4.9/src/wp-includes/comment.php

@@ -523 +523 @@
  * 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.
- *
  * @since 3.4.0
- */
-function wp_set_comment_cookies($comment, $user) {
-    if ( $user->exists() )
+ * @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.
+    if ( $user->exists() ) {
         return;
+    }
+
+    if ( false === $cookies_consent ) {
+        // Remove any existing cookies.
+        $past = time() - YEAR_IN_SECONDS;
+        setcookie( 'comment_author_' . COOKIEHASH, ' ', $past, COOKIEPATH, COOKIE_DOMAIN );
+        setcookie( 'comment_author_email_' . COOKIEHASH, ' ', $past, COOKIEPATH, COOKIE_DOMAIN );
+        setcookie( 'comment_author_url_' . COOKIEHASH, ' ', $past, COOKIEPATH, COOKIE_DOMAIN );
+
+        return;
+    }
 
     /**
@@ -539 +553 @@
      * @param int $seconds Comment cookie lifetime. Default 30000000.
      */
-    $comment_cookie_lifetime = apply_filters( 'comment_cookie_lifetime', 30000000 );
+    $comment_cookie_lifetime = time() + apply_filters( 'comment_cookie_lifetime', 30000000 );
     $secure = ( 'https' === parse_url( home_url(), PHP_URL_SCHEME ) );
-    setcookie( 'comment_author_' . COOKIEHASH, $comment->comment_author, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
-    setcookie( 'comment_author_email_' . COOKIEHASH, $comment->comment_author_email, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
-    setcookie( 'comment_author_url_' . COOKIEHASH, esc_url($comment->comment_author_url), time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
+    setcookie( 'comment_author_' . COOKIEHASH, $comment->comment_author, $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
+    setcookie( 'comment_author_email_' . COOKIEHASH, $comment->comment_author_email, $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
+    setcookie( 'comment_author_url_' . COOKIEHASH, esc_url( $comment->comment_author_url ), $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure );
 }