wp_remote_retrieve_cookie

The timeline below displays how wordpress function wp_remote_retrieve_cookie has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 6.1

/**
 * Retrieve a single cookie by name from the raw response.
 *
 * @since 4.4.0
 *
 * @param array|WP_Error $response HTTP response.
 * @param string         $name     The name of the cookie to retrieve.
 * @return WP_Http_Cookie|string The `WP_Http_Cookie` object, or empty string
 *                               if the cookie is not 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 '';
}

WordPress Version: 5.3

/**
 * Retrieve a single cookie by name from the raw response.
 *
 * @since 4.4.0
 *
 * @param array|WP_Error $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 '';
}

WordPress Version: 4.4

/**
 * 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 '';
}