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

説明

wp_remote_retrieve_header() は、HTTPレスポンスから、指定したヘッダーの値を取り出す関数です。

基本構文

wp_remote_retrieve_header( array|WP_Error $response, string $header ): array|string

引数

  • $response:HTTP関数の戻り値
  • $header:ヘッダー名

戻り値

ヘッダーの値。なければ空文字。

使い方(サンプル)

$type = wp_remote_retrieve_header( $res, 'content-type' );

注意点

  • ヘッダー名は大文字小文字を区別しません。

実務での使いどころ

  • 応答の、1つのヘッダー(content-type・content-length など)を、取り出すとき。

よくあるミスと対処

  • 存在しないヘッダーでは、空文字が返る。確認せずに使う。
  • 同じ名前のヘッダーが複数あるときは、配列が返る。
  • ヘッダー名の、大文字・小文字を、気にしている(区別されない)。

NG例

$type = wp_remote_retrieve_header( $response, 'Content-Type' );
if ( 'application/json' === $type ) { // charset が付いていると、一致しない
	// ...
}

OK例

$type = wp_remote_retrieve_header( $response, 'content-type' );
if ( false !== strpos( $type, 'application/json' ) ) {
	// JSON
}

使い分け早見表

関数 取り出すもの
wp_remote_retrieve_header() 1つのヘッダー
wp_remote_retrieve_headers() ヘッダーの一覧
wp_remote_retrieve_response_code() ステータスコード

関連項目

wp_remote_retrieve_headers()

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

コメント

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