wp_remote_retrieve_cookie() WordPress Function

The wp_remote_retrieve_cookie() function is used to retrieve a cookie from a remote request. This function is useful for making requests to third-party sites and getting back a cookie that can be used to authenticate the user on the third-party site.

wp_remote_retrieve_cookie( array|WP_Error $response, string $name ) #

Retrieve a single cookie by name from the raw response.


Parameters

$response

(array|WP_Error)(Required)HTTP response.

$name

(string)(Required)The name of the cookie to retrieve.


Top ↑

Return

(WP_Http_Cookie|string) The WP_Http_Cookie object. Empty string if the cookie isn't present in the response.


Top ↑

Source

File: wp-includes/http.php

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


Top ↑

Changelog

Changelog
VersionDescription
4.4.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.