Changeset 40263

Timestamp:

03/10/2017 02:32:31 PM (8 years ago)

Author:

johnbillion

Message:

Build/Test tools: Don't override the wp_set_auth_cookie() and wp_clear_auth_cookie() functions.

Overriding pluggable functions in the test suite is asking for trouble in the future. In addition, it means the test suite can't be guaranteed to behave the same as core.

This instead introduces a send_auth_cookies filter which can be hooked in during the test suite to prevent these functions from attempting to send cookie headers to the client.

Fixes #39367

Location:

trunk

Files:

• src/wp-includes/pluggable.php (modified) (2 diffs)
• tests/phpunit/includes/functions.php (modified) (1 diff)

trunk/src/wp-includes/pluggable.php

@@ -901 +901 @@
     do_action( 'set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in' );
 
+    /**
+     * Allows preventing auth cookies from actually being sent to the client.
+     *
+     * @since 4.7.4
+     *
+     * @param bool $send Whether to send auth cookies to the client.
+     */
+    if ( ! apply_filters( 'send_auth_cookies', true ) ) {
+        return;
+    }
+
     setcookie($auth_cookie_name, $auth_cookie, $expire, PLUGINS_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
     setcookie($auth_cookie_name, $auth_cookie, $expire, ADMIN_COOKIE_PATH, COOKIE_DOMAIN, $secure, true);
@@ -922 +933 @@
      */
     do_action( 'clear_auth_cookie' );
+
+    /**
+     * Allows preventing auth cookies from actually being sent to the client.
+     *
+     * @since 4.7.4
+     *
+     * @param bool $send Whether to send auth cookies to the client.
+     */
+    if ( ! apply_filters( 'send_auth_cookies', true ) ) {
+        return;
+    }
 
     setcookie( AUTH_COOKIE,        ' ', time() - YEAR_IN_SECONDS, ADMIN_COOKIE_PATH,   COOKIE_DOMAIN );

trunk/tests/phpunit/includes/functions.php

@@ -165 +165 @@
 // Skip `setcookie` calls in auth_cookie functions due to warning:
 // Cannot modify header information - headers already sent by ...
-
-function wp_set_auth_cookie( $user_id, $remember = false, $secure = '', $token = '' ) {
-    $auth_cookie = null;
-    $expire = null;
-    $expiration = null;
-    $user_id = null;
-    $scheme = null;
-    /** This action is documented in wp-inclues/pluggable.php */
-    do_action( 'set_auth_cookie', $auth_cookie, $expire, $expiration, $user_id, $scheme );
-    $logged_in_cookie = null;
-    /** This action is documented in wp-inclues/pluggable.php */
-    do_action( 'set_logged_in_cookie', $logged_in_cookie, $expire, $expiration, $user_id, 'logged_in' );
-}
-
-function wp_clear_auth_cookie() {
-    /** This action is documented in wp-inclues/pluggable.php */
-    do_action( 'clear_auth_cookie' );
-}
+tests_add_filter( 'send_auth_cookies', '__return_false' );