函数文档

wp_remote_retrieve_header()

💡 云策文档标注

概述

wp_remote_retrieve_header() 函数用于从 HTTP 响应中按名称检索单个标头值。它处理 WP_Error 或无效参数,返回标头值或空字符串。

关键要点

  • 参数:$response(必需,数组或 WP_Error),$header(必需,字符串)。
  • 返回值:字符串或数组(如果多个同名标头),参数错误或标头不存在时返回空字符串。
  • 内部逻辑:检查 $response 是否为 WP_Error 或是否包含 headers 键,然后检索指定标头。

代码示例

$response = wp_remote_get( 'http://www.foo.com/file.txt' );
$last_modified = wp_remote_retrieve_header( $response, 'last-modified' );

📄 原文内容

Retrieves a single header by name from the raw response.

Parameters

$responsearray|WP_Errorrequired
HTTP response.
$headerstringrequired
Header name to retrieve value from.

Return

array|string The header(s) value(s). Array if multiple headers with the same name are retrieved.
Empty string if incorrect parameter given, or if the header doesn’t exist.

Source

function wp_remote_retrieve_header( $response, $header ) {
	if ( is_wp_error( $response ) || ! isset( $response['headers'] ) ) {
		return '';
	}

	if ( isset( $response['headers'][ $header ] ) ) {
		return $response['headers'][ $header ];
	}

	return '';
}

Changelog

Version Description
2.7.0 Introduced.

User Contributed Notes