WP_Http::buildCookieHeader() public WP 2.8.0

Takes the arguments for a ::request() and checks for the cookie array.

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.

{} It's a method of the class: WP_Http{}

No Hooks.

Return

null. Null. Nothing.

Usage

$result = WP_Http::buildCookieHeader( $r ) // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid;

$r(array) (required) (passed by reference — &)

Full array of args passed into ::request()

Changelog

Code of WP_Http::buildCookieHeader() WP Http::buildCookieHeader ^{WP 5.7}

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