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

説明

wp_remote_request() は、GET/POST以外のメソッド(PUT、DELETEなど)でHTTPリクエストを送る関数です。

基本構文

wp_remote_request( string $url, array $args = array() ): array|WP_Error

引数

  • $url:URL
  • $args:method を含むオプション

戻り値

レスポンスの配列。失敗時は WP_Error。

使い方(サンプル)

$res = wp_remote_request( $url, array( 'method' => 'DELETE' ) );

注意点

  • メソッドの指定がないと GET になります。

実務での使いどころ

  • PUT・DELETE・PATCHなど、GET・POST以外のメソッドで、外部のAPIを呼ぶとき。
  • メソッドを、変数で切り替えて、リクエストするとき。

よくあるミスと対処

  • method を指定していない。既定は GET。
  • 戻り値が WP_Error のときと、ステータスコードを、確認していない。
  • GET・POSTだけでよいのに、これを使っている。wp_remote_get()・wp_remote_post() の方が、読みやすい。

NG例

wp_remote_request( $url, array( 'body' => $data ) ); // method がなく、GET になる

OK例

$response = wp_remote_request( $url, array(
	'method' => 'DELETE',
) );
if ( is_wp_error( $response ) ) {
	return;
}

使い分け早見表

関数 メソッド
wp_remote_request() 任意(PUT・DELETEなど)
wp_remote_get() GET
wp_remote_post() POST

関連項目

wp_remote_get()、wp_remote_post()

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

コメント

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