WP_REST_Request クラスの使い方説明・引数・注意点
WP_REST_Request は、REST APIのリクエスト(パラメーター、ヘッダーなど)を表すクラスです。エンドポイントのコールバックに渡されます。
説明
WP_REST_Request は、REST APIのリクエスト(パラメーター、ヘッダーなど)を表すクラスです。エンドポイントのコールバックに渡されます。
基本構文
WP_REST_Request
引数
get_param( $key ):パラメーターを取得get_params():全パラメーターを取得get_json_params():JSONボディを取得get_header( $key ):ヘッダーを取得get_method():HTTPメソッドを取得
戻り値
コールバックの引数として受け取ります。
使い方(サンプル)
register_rest_route( 'my/v1', '/item', array(
'methods' => 'GET',
'callback' => function( WP_REST_Request $req ) {
return array( 'id' => absint( $req->get_param( 'id' ) ) );
},
'permission_callback' => '__return_true',
) );
注意点
- 受け取った値は必ずサニタイズします。
argsにsanitize_callback/validate_callbackを指定すると、自動で検証できます。
実務での使いどころ
- REST APIの、コールバックで、リクエストのパラメータ(URL、クエリ、本文)を、受け取るとき。
- JSONの本文(
get_json_params())を、取得するとき。
よくあるミスと対策
$_POST・$_GETを、直接使っている。$request->get_param()を使う。- パラメータを、検証・サニタイズしていない。
register_rest_route()のargsで、validate_callback・sanitize_callbackを指定する。 - 存在しないパラメータは
null。確認せずに使う。
NG例
function my_callback( $request ) {
$id = $_GET['id']; // 直接使っている
}
OK例
function my_callback( WP_REST_Request $request ) {
$id = absint( $request->get_param( 'id' ) );
$body = $request->get_json_params();
return rest_ensure_response( array( 'id' => $id ) );
}
使い分け早見表
| やりたいこと | 使うもの |
|---|---|
| パラメータを、取得する | $request->get_param() |
| JSONの本文を、取得する | $request->get_json_params() |
| 応答を、作る | rest_ensure_response() |
PR エックスサーバー
WordPressを、速く・止まらずに運営したい方へ
サーバー選びを間違えると、表示が遅い・サイトが止まるリスクがあります
こんなお悩みはありませんか?
- どのレンタルサーバーを選べばよいか分からない
- 表示が遅い・サイトが落ちるのが心配
- WordPressの設定やセキュリティに自信がない
サーバーは、あとから乗り換えると、データの移行やドメインの設定に手間がかかります。表示が遅い、突然止まるといったトラブルは、訪問者が離れる原因にもなります。最初に、稼働率の保証や実績を確認して選ぶのが安全です。
エックスサーバーなら、WordPressの運営に強いレンタルサーバーを、迷わず選べます。国内でWordPressを利用して運用されているサイトの集計(Dataprovider.com調べ、2025年6月)で、国内シェアNo.1と公式サイトに記載されています。
選ばれるポイント
- WordPressサイトの国内シェアNo.1。実績で選びたいときの安心材料(Dataprovider.com調べ、2025年6月)
- サイトが止まりにくい。月間稼働率99.99%以上を保証し、下回ると月額費用の一部を返金
- 攻撃に強い。WordPressを狙った攻撃の99%以上を未然に防ぐ機能(2024年9月15日〜11月15日の当社調べ)
- ドメイン代を節約できる。独自ドメインが永久無料(対象ドメイン・契約期間などの条件あり)
- テーマ選びも安心。人気テーマ「Cocoon」の開発・提供元が運営
- 10日間の無料お試しで、契約前に操作や表示の速さを確かめられる
10日間の無料お試しで、契約前に試せます
10日間無料でお試し
広告(アフィリエイト)を含みます。特長は2026年11月8日時点の公式サイトの記載で、数値・順位は各調査・調べの時点のものです。料金・条件は公式サイトでご確認ください。
関連項目
register_rest_route()、WP_REST_Response、rest_ensure_response()
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。