wp_remote_retrieve_headers() の使い方|説明・引数・注意点

説明

wp_remote_retrieve_headers() は、HTTPレスポンスの配列から、ヘッダーを取り出す関数です。

基本構文

wp_remote_retrieve_headers( array|WP_Error $response ): Requests_Utility_CaseInsensitiveDictionary|array

引数

  • $response:HTTP関数の戻り値

戻り値

ヘッダーの連想配列風オブジェクト。

使い方(サンプル)

$headers = wp_remote_retrieve_headers( $res );

注意点

  • ヘッダー名は大文字小文字を区別せず参照できます。

実務での使いどころ

  • 応答のヘッダーを、まとめて取り出すとき。
  • すべてのヘッダーを、確認・記録するとき。

よくあるミスと対処

  • 戻り値を、通常の配列として扱っている。ヘッダー名の大文字・小文字は、区別されない。ヘッダーの名前は、小文字で比べるのが、安全。
  • WP_Error のときを、考えていない。
  • 1つのヘッダーだけでよいのに、これを使っている。wp_remote_retrieve_header() が簡単。

NG例

$headers = wp_remote_retrieve_headers( $response );
echo $headers['Content-Type']; // 無い場合は null になる(エラー時の空の配列では、警告になる)

OK例

$headers = wp_remote_retrieve_headers( $response );
if ( isset( $headers['content-type'] ) ) {
	echo esc_html( $headers['content-type'] );
}

使い分け早見表

関数 取り出すもの
wp_remote_retrieve_headers() ヘッダーの一覧
wp_remote_retrieve_header() 1つのヘッダー
wp_remote_retrieve_body() 本文

関連項目

wp_remote_retrieve_header()

公式リファレンス:wp_remote_retrieve_headers() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました