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


お勧め

Posts filter multiselect:プラグイン作ってみました(2022年4月8日 更新)

先週の金曜日、知り合いの方から「投稿一覧ページで絞り込みを行う際、複数選択できないか」といった問い合わせがあり、その時には「標準では無理ですね」と返答しました。このこと自体は事実なのですが、要するに「複数選択可能なドロップダウンメニュー」が実現できれば対応するのはそれほど難しくないような気がしました。この週末、そんなノリでちょっとコーディングしてできたのがこのプラグインです。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

古めのリビジョンを削除した時のメモ(2022年5月16日 更新)

大きく育ったデータベースを整理するため、古めのリビジョンとそれに紐づいたカスタムフィールドデータを削除。と思ったら「The total number of locks exceeds the lock table size」というエラーが発生して削除できなかった。

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

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