説明
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
お勧め
WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。
wp_titleからwp_get_document_titleへ（2018年5月27日 更新）
先週、WordPress 4.4 beta1（以降4.4 beta1）が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。
WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）
先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。
カテゴリー専用の投稿一覧と新規投稿メニューを追加する（2012年1月23日 更新）
サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。さくらのVPSでKUSANAGI#3（2018年5月27日 更新）
今回は「前回」の続き。http（80番）をクローズ、そのほかに行った調整作業について整理する。