register_rest_route

説明

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


お勧め

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。