函数文档

wp_remote_retrieve_cookies()

💡 云策文档标注

概述

wp_remote_retrieve_cookies() 函数用于从 HTTP 响应中提取所有 cookie 数据,返回一个 WP_Http_Cookie 对象数组。如果响应为 WP_Error 或没有 cookie,则返回空数组。

关键要点

  • 参数:$response(必需),类型为 array 或 WP_Error,表示 HTTP 响应。
  • 返回值:WP_Http_Cookie[],响应中的 cookie 对象数组;若无 cookie 或响应为 WP_Error,则返回空数组。
  • 函数内部检查 is_wp_error() 和 $response['cookies'] 是否为空,确保安全处理错误情况。
  • 相关函数:wp_remote_retrieve_cookie() 用于按名称检索单个 cookie。
  • 引入版本:4.4.0。

代码示例

function wp_remote_retrieve_cookies( $response ) {
    if ( is_wp_error( $response ) || empty( $response['cookies'] ) ) {
        return array();
    }

    return $response['cookies'];
}

📄 原文内容

Retrieves only the cookies from the raw response.

Parameters

$responsearray|WP_Errorrequired
HTTP response.

Return

WP_Http_Cookie[] An array of WP_Http_Cookie objects from the response.
Empty array if there are none, or the response is a WP_Error.

Source

function wp_remote_retrieve_cookies( $response ) {
	if ( is_wp_error( $response ) || empty( $response['cookies'] ) ) {
		return array();
	}

	return $response['cookies'];
}

Changelog

Version Description
4.4.0 Introduced.