説明
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
お勧め
meta_compare_key使ってみた（2019年3月19日 更新）
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名（メタキー）に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた（2018年5月27日 更新）
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」（Bulkアクション）フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する（2012年3月15日 更新）
投稿記事に挿入する画像サイズは、サムネイル（150×150）、中サイズ（300×300）、大サイズ（1024×1024）がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」－「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える（2014年9月12日 更新）
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える（2021年9月9日 更新）
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。