register_rest_route() の使い方説明・引数・注意点
register_rest_route() は、独自のREST APIエンドポイントを登録する関数です。
説明
register_rest_route() は、独自のREST APIエンドポイントを登録する関数です。
基本構文
register_rest_route( string $route_namespace, string $route, array $args = array(), bool $override = false ): bool
引数
$route_namespace:名前空間(例:myplugin/v1)$route:ルート(例:/items)$args:methods、callback、permission_callbackなど
戻り値
登録できたら true。
使い方(サンプル)
add_action( 'rest_api_init', function() {
register_rest_route( 'myplugin/v1', '/hello', array(
'methods' => 'GET',
'callback' => fn() => array( 'message' => 'hello' ),
'permission_callback' => '__return_true',
) );
} );
注意点
rest_api_initフックで呼びます。permission_callbackは必須です(省略するとWordPress 5.5以降で警告が出ます)。公開エンドポイントでも__return_trueを明示します。
実務での使いどころ
- 独自のREST APIのエンドポイントを、追加するとき。
- JavaScriptや、外部のアプリから呼ぶ、APIを作るとき。
よくあるミスと対策
rest_api_initフックの外で呼んでいる。permission_callbackを指定していない。WordPress 5.5以降は、未指定だと、警告になる。公開してよいAPIでは、'__return_true'を指定する。- 名前空間(
my-plugin/v1)を、決めていない。他のプラグインと、重なる。 - 入力値を、
argsのvalidate_callback・sanitize_callbackで、検証していない。
NG例
register_rest_route( 'my/v1', '/items', array(
'methods' => 'GET',
'callback' => 'my_items',
) ); // permission_callback がなく、フックの外で呼んでいる
OK例
add_action( 'rest_api_init', function () {
register_rest_route( 'my-plugin/v1', '/items', array(
'methods' => 'GET',
'callback' => 'my_items',
'permission_callback' => '__return_true',
) );
} );
使い分け早見表
| 関数 | 役割 |
|---|---|
register_rest_route() |
エンドポイントを登録する |
rest_url() |
REST APIのURLを取得する |
rest_ensure_response() |
戻り値を、REST用の応答に整える |
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日時点の公式サイトの記載で、数値・順位は各調査・調べの時点のものです。料金・条件は公式サイトでご確認ください。
関連項目
rest_ensure_response()、rest_url()、wp_send_json()
公式リファレンス:register_rest_route() | Function | WordPress Developer Resources
本記事は情報提供を目的としています。WordPress本体やテーマ・プラグインのバージョンによって動作が異なる場合があるため、本番環境に反映する前に、必ずテスト環境で動作を確認してください。