rest_parse_request_arg()

関数の概要

rest_parse_request_arg()は、WordPress REST APIのリクエスト引数を解析するための関数です。リクエストされた引数を正しく処理し、適切な形式に変換します。

パラメータの説明

  • $value (mixed) – リクエストから取得した値。
  • $request (WP_REST_Request) – REST APIリクエストオブジェクト。
  • $param (string) – パラメータの名前。

戻り値

解析された引数の値を返します。

使用例


// リクエストから'example_param'を取得して解析する
$param_value = rest_parse_request_arg( $request->get_param( 'example_param' ), $request, 'example_param' );

関連する関数

  • rest_sanitize_request_arg() – REST APIのリクエスト引数をサニタイズする関数。