説明
パラメータ
- $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
お勧め
5.5で非推奨になる関数名について(2020年8月12日 更新)
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい(2013年11月27日 更新)
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)
query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?