register_rest_route

（4.4.0以降）
register_rest_route - REST APIのルートを登録する

説明

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

参考

Code Reference: register_rest_route

お勧め

個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。