説明
bool register_rest_route( string $namespace, string $route [ , array $args = array() [ , bool $override = false ] ] )
REST APIのルートを登録する。
パラメータ
- $namespaceネームスペース名を指定。
- $routeルート名を指定。
- $argsエンドポイント用の情報を配列で指定（省略時はarray()）。
- $override既存の情報を上書きする場合はtrueを指定（省略時はfalse）。
返り値
登録できた場合はtrueを、登録できなかった場合はfalseを返す。注意
独自のREST APIのルートを登録するか、既存のREST APIのルートを設定内容を変更する場合に使用する。本関数は'rest_api_init'アクションかそれ以降に使用すること。
パラメータ$argsには、エンドポイント用の設定を示す連想配列を1つ以上格納した配列となる。連想配列のキーは次の通り。
| キー | 内容 |
| 'methods' | メソッド（WP_REST_Server::READABLE、WP_REST_Server::EDITABLEなど） |
|---|---|
| 'callback' | データを返すコールバック関数 |
| 'args' | エンドポイントのパラメータ情報 |
| 'permission_callback' | 呼び出しの可否を判定するコールバック関数 |
[4.4.0]パラメータ$namespaceと$routeは、空の場合に警告メッセージが表示され、エラーになる。
[5.1.0]本関数を'rest_api_init'アクションの実行前に呼び出すと警告メッセージが表示される。
[5.4.2]パラメータ$namespaceは、先頭または末尾に'/'を指定すると警告メッセージが表示される。
[5.5.0]パラメータ$argsの各エンドポイント用の設定を示す連想配列に'permission_callback'キーにコールバック関数が指定されていないと警告メッセージが表示される。
使用例
- REST APIのルートを登録する。
register_rest_route( $namespace, $route, $args );
フィルター
実行するフィルターはありません。アクション
実行するアクションはありません。ソースファイル
/wp-includes/rest-api.php最終更新 : 2022年08月17日 17:38
お勧め
Login rebuilder 2.3.0の新機能を紹介（2018年5月27日 更新）
プラグイン「Login rebuilder」はログイン時の履歴（ログ）や不正なログインページへのアクセス履歴を保存している。これらの履歴情報はダッシュボートで確認できるが、バージョン2.3.0においてそれぞれがダウンロードできるようになった。
古めのリビジョンを削除した時のメモ（2022年5月16日 更新）
大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。
決まった値を返すだけの関数群（2018年5月27日 更新）
WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。
「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日 更新）
ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。
WP_Postオブジェクトで投稿情報を直感的に使う（2012年10月4日 更新）
WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。