wp_remote_retrieve_response_message()


WordPressのwp_remote_retrieve_response_message()関数は、リモートリクエストのレスポンスメッセージを取得するために使用されます。

構文

wp_remote_retrieve_response_message( array $response );
  • $response (array) — リモートリクエストのレスポンス。通常はwp_remote_get()またはwp_remote_post()の返り値。

戻り値:

  • (string) — レスポンスメッセージ。たとえば「OK」や「Not Found」など。

使用例

例 1. レスポンスメッセージの取得

以下のコードは、リモートリクエストのレスポンスメッセージを取得して表示します。

<?php
$response = wp_remote_get( 'https://example.com/api/' );
$message = wp_remote_retrieve_response_message( $response );
echo $message;
?>

例 2. ステータスコードとメッセージを表示

リモートリクエストのステータスコードとレスポンスメッセージを表示する例です。

<?php
$response = wp_remote_get( 'https://example.com/api/' );
$status_code = wp_remote_retrieve_response_code( $response );
$message = wp_remote_retrieve_response_message( $response );
echo "Status: $status_code, Message: $message";
?>

例 3. レスポンスメッセージのエラーチェック

レスポンスメッセージをチェックしてエラーを処理します。

<?php
$response = wp_remote_get( 'https://example.com/api/' );
$message = wp_remote_retrieve_response_message( $response );
if ( $message === 'Not Found' ) {
    echo 'リソースが見つかりませんでした。';
}
?>

例 4. 成功時にデータを取得

レスポンスメッセージが「OK」の場合にのみデータを処理します。

<?php
$response = wp_remote_get( 'https://example.com/api/' );
$message = wp_remote_retrieve_response_message( $response );
if ( $message === 'OK' ) {
    $body = wp_remote_retrieve_body( $response );
    echo $body;
}
?>

例 5. エラー処理を含むAPIリクエスト

エラーメッセージが特定の条件に一致する場合に処理を実行します。

<?php
$response = wp_remote_get( 'https://example.com/api/' );
$message = wp_remote_retrieve_response_message( $response );
if ( $message !== 'OK' ) {
    error_log( 'リクエストエラー: ' . $message );
} else {
    $body = wp_remote_retrieve_body( $response );
    echo $body;
}
?>

注意事項

  • レスポンスがWP_Errorの場合、この関数を使用する前にチェックしてください。
  • APIのレスポンス内容によってメッセージが異なるため、適切なエラーハンドリングを実装してください。

関連機能：