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

説明

wp_remote_retrieve_response_code() は、HTTPレスポンスの配列から、ステータスコードを取り出す関数です。

基本構文

wp_remote_retrieve_response_code( array|WP_Error $response ): int|string

引数

  • $response:HTTP関数の戻り値

戻り値

ステータスコード(200 など)。

使い方(サンプル)

if ( 200 !== wp_remote_retrieve_response_code( $res ) ) {
	// エラー処理
}

注意点

  • エラー時は空文字が返ることがあります。

実務での使いどころ

  • 応答の、HTTPステータスコード(200、404、500など)を、確認するとき。

よくあるミスと対処

  • WP_Error のときは、空文字が返る。200 === との、厳密な比較が、常に失敗する。
  • 200だけを、成功としている。201や204も、成功の場合がある。
  • 文字列と整数を、厳密に比べて、一致しない。

NG例

if ( '200' === wp_remote_retrieve_response_code( $response ) ) { // 型が違い、一致しない
	// ...
}

OK例

$code = (int) wp_remote_retrieve_response_code( $response );
if ( $code >= 200 && $code < 300 ) {
	// 成功
}

使い分け早見表

関数 取り出すもの
wp_remote_retrieve_response_code() ステータスコード
wp_remote_retrieve_body() 本文
wp_remote_retrieve_header() 1つのヘッダー

関連項目

wp_remote_retrieve_body()、wp_remote_get()、is_wp_error()

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

コメント

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