WP_Http::buildCookieHeader() WordPress Method
The WP_Http::buildCookieHeader() function builds a cookie header based on an array of cookie data. The array is expected to have the following format: array( 'name' => 'value', 'name2' => 'value2' ) The function will return a string containing the cookie header.
WP_Http::buildCookieHeader( array $r ) #
Takes the arguments for a ::request() and checks for the cookie array.
Description
If it’s found, then it upgrades any basic name => value pairs to WP_Http_Cookie instances, which are each parsed into strings and added to the Cookie: header (within the arguments array). Edits the array by reference.
Parameters
- $r
(array)(Required)Full array of args passed into ::request()
Source
File: wp-includes/class-wp-http.php
public static function buildCookieHeader( &$r ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
if ( ! empty( $r['cookies'] ) ) {
// Upgrade any name => value cookie pairs to WP_HTTP_Cookie instances.
foreach ( $r['cookies'] as $name => $value ) {
if ( ! is_object( $value ) ) {
$r['cookies'][ $name ] = new WP_Http_Cookie(
array(
'name' => $name,
'value' => $value,
)
);
}
}
$cookies_header = '';
foreach ( (array) $r['cookies'] as $cookie ) {
$cookies_header .= $cookie->getHeaderValue() . '; ';
}
$cookies_header = substr( $cookies_header, 0, -2 );
$r['headers']['cookie'] = $cookies_header;
}
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 2.8.0 | Introduced. |