説明
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
お勧め
投稿内容のid属性などを保存するための対策（2012年6月15日 更新）
WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった（id属性が保存できなくなった）。ここでは、その対策方法の1つを紹介しておく。WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。
4.4では投稿ページも専用テンプレートが適用できる（2018年5月27日 更新）
従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。
Google Mapsブロックを作る過程で悩んだ件（2022年8月23日 更新）
自分なりのGoogle Mapsブロックを作るべく、カスタムHTMLブロックをベースにいくつかのパラメータ要素をサイドバーに追加していく。Google Maps用のAPIキーについてはオプションデータ（wp_optionsテーブル）に格納して利用していこうと思ったのだが、その方法がさっぱりわからなかった。
Popoverコンポーネントのanchorプロパティについて考えたときのメモ（2024年8月19日 更新）
カスタムブロックやコアブロック向けのプラグインでお世話になるPopoverコンポーネント。表示位置を決定する上で大きく影響するのがanchorプロパティである。フィルターのコールバック関数で対象ブロックに干渉できない場合はどうしたらよいのだろうか。