register_rest_route()

関数の概要

register_rest_route()関数は、WordPressのREST APIに新しいルートを登録するために使用される関数です。

パラメータの説明

  • $namespace: ルートの名前空間。
  • $route: ルートのエンドポイント。
  • $args: ルートの設定オプション。

戻り値

成功時に登録されたルートの情報を返します。

使用例


// ルートを登録する例
function custom_rest_route() {
    register_rest_route( 'custom/v1', '/data/', array(
        'methods'  => 'GET',
        'callback' => 'custom_data_callback',
    ) );
}
add_action( 'rest_api_init', 'custom_rest_route' );

関連する関数

  • register_rest_field(): REST APIにフィールドを登録する関数。
  • register_rest_post_type_args(): REST APIの投稿タイプ引数を登録する関数。