Changeset 34369

Timestamp:

09/22/2015 03:13:13 AM (9 years ago)

Author:

wonderboymusic

Message:

HTTP: Add some new Cookie helper functions:

• wp_remote_retrieve_cookies( $response )
• wp_remote_retrieve_cookie( $response, $name )
• wp_remote_retrieve_cookie_value( $response, $name )

Adds unit tests.

Props johnbillion.
Fixes #33711.

Location:

trunk

Files:

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

trunk/src/wp-includes/http-functions.php

@@ -284 +284 @@
 
     return $response['body'];
+}
+
+/**
+ * Retrieve only the body from the raw response.
+ *
+ * @since 4.4.0
+ *
+ * @param array $response HTTP response.
+ * @return array An array of `WP_Http_Cookie` objects from the response. Empty array if there are none, or the response is a WP_Error.
+ */
+function wp_remote_retrieve_cookies( $response ) {
+    if ( is_wp_error( $response ) || empty( $response['cookies'] ) ) {
+        return array();
+    }
+
+    return $response['cookies'];
+}
+
+/**
+ * Retrieve a single cookie by name from the raw response.
+ *
+ * @since 4.4.0
+ *
+ * @param array  $response HTTP response.
+ * @param string $name     The name of the cookie to retrieve.
+ * @return WP_Http_Cookie|string The `WP_Http_Cookie` object. Empty string if the cookie isn't present in the response.
+ */
+function wp_remote_retrieve_cookie( $response, $name ) {
+    $cookies = wp_remote_retrieve_cookies( $response );
+
+    if ( empty( $cookies ) ) {
+        return '';
+    }
+
+    foreach ( $cookies as $cookie ) {
+        if ( $cookie->name === $name ) {
+            return $cookie;
+        }
+    }
+
+    return '';
+}
+
+/**
+ * Retrieve a single cookie's value by name from the raw response.
+ *
+ * @since 4.4.0
+ *
+ * @param array  $response HTTP response.
+ * @param string $name     The name of the cookie to retrieve.
+ * @return string The value of the cookie. Empty string if the cookie isn't present in the response.
+ */
+function wp_remote_retrieve_cookie_value( $response, $name ) {
+    $cookie = wp_remote_retrieve_cookie( $response, $name );
+
+    if ( ! is_a( $cookie, 'WP_Http_Cookie' ) ) {
+        return '';
+    }
+
+    return $cookie->value;
 }
 

trunk/tests/phpunit/tests/http/functions.php

@@ -76 +76 @@
         $this->assertWPError( $response );
     }
+
+    /**
+     * @ticket 33711
+     */
+    function test_get_response_cookies() {
+        $url = 'https://wordpress.org/wp-login.php';
+
+        $response = wp_remote_head( $url );
+        $cookies  = wp_remote_retrieve_cookies( $response );
+
+        $this->assertInternalType( 'array', $cookies );
+        $this->assertNotEmpty( $cookies );
+
+        $cookie = wp_remote_retrieve_cookie( $response, 'wordpress_test_cookie' );
+        $this->assertInstanceOf( 'WP_Http_Cookie', $cookie );
+        $this->assertSame( 'wordpress_test_cookie', $cookie->name );
+        $this->assertSame( 'WP Cookie check', $cookie->value );
+
+        $value = wp_remote_retrieve_cookie_value( $response, 'wordpress_test_cookie' );
+        $this->assertSame( 'WP Cookie check', $value );
+
+        $no_value = wp_remote_retrieve_cookie_value( $response, 'not_a_cookie' );
+        $this->assertSame( '', $no_value );
+
+        $no_cookie = wp_remote_retrieve_cookie( $response, 'not_a_cookie' );
+        $this->assertSame( '', $no_cookie );
+    }
+
 }