基本的なこと
APIにカスタムエンドポイントを追加したいですか?素晴らしい!シンプルな例から始めましょう。
シンプルな関数は次のようになります:
<?php
/**
* Grab latest post title by an author!
*
* @param array $data Options for the function.
* @return string|null Post title for the latest, * or null if none.
*/
function my_awesome_func( $data ) {
$posts = get_posts( array(
'author' => $data['id'],
) );
if ( empty( $posts ) ) {
return null;
}
return $posts[0]->post_title;
}
これをAPI経由で利用可能にするためには、ルートを登録する必要があります。これにより、APIは特定のリクエストに対して私たちの関数で応答することができます。これは、register_rest_route
という関数を通じて行い、APIが読み込まれていないときに余分な作業を避けるためにrest_api_init
のコールバックで呼び出す必要があります。
``````bash
<?php
add_action( 'rest_api_init', function () {
register_rest_route( 'myplugin/v1', '/author/(?P<id>\d+)', array(
'methods' => 'GET',
'callback' => 'my_awesome_func',
) );
} );
`
現在、私たちはそのルートのために1つのエンドポイントのみを登録しています。「ルート」という用語はURLを指し、「エンドポイント」はそれに対応するメソッドおよび URLの背後にある関数を指します(詳細については用語集を参照してください)。
たとえば、あなたのサイトのドメインがexample.com
で、APIパスがwp-json
である場合、完全なURLはhttp://example.com/wp-json/myplugin/v1/author/(?P\d+)
になります。
美しいパーマリンクがないサイトでは、ルートはrest_route
パラメータとしてURLに追加されます。上記の例では、完全なURLはhttp://example.com/?rest_route=/myplugin/v1/author/(?P\d+)
になります。
各ルートには任意の数のエンドポイントを持つことができ、各エンドポイントについて許可されるHTTPメソッド、リクエストに応答するためのコールバック関数、およびカスタム権限を作成するための権限コールバックを定義できます。さらに、リクエスト内で許可されるフィールドを定義し、各フィールドにデフォルト値、サニタイズコールバック、バリデーションコールバック、およびフィールドが必須かどうかを指定できます。
名前空間
名前空間はエンドポイントのURLの最初の部分です。カスタムルート間の衝突を防ぐために、ベンダー/パッケージのプレフィックスとして使用する必要があります。名前空間を使用すると、2つのプラグインが異なる機能を持つ同じ名前のルートを追加できます。
一般的に、名前空間はvendor/v1
のパターンに従うべきで、vendor
は通常、あなたのプラグインまたはテーマのスラッグであり、v1
はAPIの最初のバージョンを表します。新しいエンドポイントで互換性を破る必要がある場合は、これをv2
に上げることができます。
上記のシナリオでは、異なる2つのプラグインから同じ名前の2つのルートが必要であり、すべてのベンダーはユニークな名前空間を使用する必要があります。これを怠ることは、テーマやプラグインでベンダー関数のプレフィックス、クラスプレフィックス、および/またはクラス名前空間を使用しないことに類似しており、非常に悪いです。
名前空間を使用する追加の利点は、クライアントがあなたのカスタムAPIのサポートを検出できることです。APIインデックスは、サイト上の利用可能な名前空間をリストします:
{
"name": "WordPress Site",
"description": "Just another WordPress site",
"url": "http://example.com/",
"namespaces": [
"wp/v2",
"vendor/v1",
"myplugin/v1",
"myplugin/v2",
]
}
クライアントがあなたのAPIがサイトに存在するかどうかを確認したい場合、彼らはこのリストに対して確認できます。(詳細については発見ガイドを参照してください。)
引数
デフォルトでは、ルートはリクエストから渡されたすべての引数を受け取ります。これらは単一のパラメータセットにマージされ、その後リクエストオブジェクトに追加され、これはエンドポイントへの最初のパラメータとして渡されます:
<?php
function my_awesome_func( WP_REST_Request $request ) {
// You can access parameters via direct array access on the object:
$param = $request['some_param'];
// Or via the helper method:
$param = $request->get_param( 'some_param' );
// You can get the combined, merged set of parameters:
$parameters = $request->get_params();
// The individual sets of parameters are also available, if needed:
$parameters = $request->get_url_params();
$parameters = $request->get_query_params();
$parameters = $request->get_body_params();
$parameters = $request->get_json_params();
$parameters = $request->get_default_params();
// Uploads aren't merged in, but can be accessed separately:
$parameters = $request->get_file_params();
}
(パラメータがどのようにマージされるかを正確に知りたい場合は、WP_REST_Request::get_parameter_order()
のソースを確認してください。基本的な順序は、ボディ、クエリ、URL、次にデフォルトです。)
通常、すべてのパラメータは変更されずに取り込まれます。ただし、ルートを登録する際に引数を登録することができ、これによりサニタイズとバリデーションを実行できます。
リクエストにContent-type: application/json
ヘッダーが設定され、ボディに有効なJSONが含まれている場合、get_json_params()
は解析されたJSONボディを連想配列として返します。
引数は、各エンドポイントのargs
キーでマップとして定義されます(callback
オプションの隣)。このマップは、引数の名前をキーとして使用し、その値はその引数のオプションのマップです。この配列には、default
、required
、sanitize_callback
、およびvalidate_callback
のキーを含めることができます。
default
:引数に値が提供されていない場合のデフォルト値として使用されます。required
:trueとして定義されている場合、その引数に値が渡されないとエラーが返されます。デフォルト値が設定されている場合は影響がありません。引数には常に値があります。validate_callback
:引数の値を受け取る関数を渡すために使用されます。その関数は、値が有効な場合はtrueを、そうでない場合はfalseを返す必要があります。sanitize_callback
:メインコールバックに渡す前に引数の値をサニタイズするために使用される関数を渡すために使用されます。
前の例を考えると、渡されたパラメータが常に数値であることを保証できます:
``````bash
<?php
add_action( 'rest_api_init', function () {
register_rest_route( 'myplugin/v1', '/author/(?P<id>\d+)', array(
'methods' => 'GET',
'callback' => 'my_awesome_func',
'args' => array(
'id' => array(
'validate_callback' => function($param, $request, $key) {
return is_numeric( $param );
}
),
),
) );
} );
`
`````'sanitize_callback' => 'absint'`````のようなものを代わりに使用することもできますが、バリデーションはエラーをスローし、クライアントが何を間違っているのかを理解できるようにします。サニタイズは、エラーをスローするのではなく、入力されるデータを変更したい場合に便利です(無効なHTMLなど)。
<a name="return-value"></a>
### 戻り値
コールバックが呼び出された後、戻り値はJSONに変換され、クライアントに返されます。これにより、基本的に任意の形式のデータを返すことができます。上記の例では、文字列またはnullを返しており、これらはAPIによって自動的に処理され、JSONに変換されます。
他のWordPress関数と同様に、`````WP_Error`````インスタンスを返すこともできます。このエラー情報は、500 Internal Service Errorステータスコードとともにクライアントに渡されます。`````status`````オプションを`````WP_Error`````インスタンスデータに設定することで、エラーをさらにカスタマイズできます。たとえば、無効な入力データの場合は`````400`````を使用します。
以前の例を考えると、エラーインスタンスを返すことができます:
``````bash
<?php
/**
* Grab latest post title by an author!
*
* @param array $data Options for the function.
* @return string|null Post title for the latest,
* or null if none.
*/
function my_awesome_func( $data ) {
$posts = get_posts( array(
'author' => $data['id'],
) );
if ( empty( $posts ) ) {
return new WP_Error( 'no_author', 'Invalid author', array( 'status' => 404 ) );
}
return $posts[0]->post_title;
}
`
著者に属する投稿がない場合、これはクライアントに404 Not Foundエラーを返します:
HTTP/1.1 404 Not Found
[{
"code": "no_author",
"message": "Invalid author",
"data": { "status": 404 }
}]
より高度な使用法では、WP_REST_Response
オブジェクトを返すことができます。このオブジェクトは通常のボディデータを「ラップ」しますが、カスタムステータスコードやカスタムヘッダーを返すことを可能にします。また、レスポンスにリンクを追加することもできます。これを使用する最も簡単な方法は、コンストラクタを介して行うことです:
<?php
$data = array( 'some', 'response', 'data' );
// Create the response object
$response = new WP_REST_Response( $data );
// Add a custom status code
$response->set_status( 201 );
// Add a custom header
$response->header( 'Location', 'http://example.com/' );
既存のコールバックをラップする場合は、常に戻り値にrest_ensure_response()
を使用する必要があります。これにより、エンドポイントから返された生データが自動的にWP_REST_Response
に変換されます。(WP_Error
は適切なエラーハンドリングを可能にするためにWP_REST_Response
に変換されません。)
重要なことに、REST APIルートのコールバックは常にデータを返す必要があります。レスポンスボディ自体を送信しようとすべきではありません。これにより、REST APIサーバーが行う追加の処理、リンク/埋め込みの処理、ヘッダーの送信などが行われます。言い換えれば、die( wp_json_encode( $data ) );
やwp_send_json( $data )
を呼び出さないでください。WordPress 5.5以降、REST APIリクエスト中にwp_send_json()
ファミリーの関数が使用されると、_doing_it_wrong
通知が発行されます。
REST APIを使用する際は、コールバックからWP_REST_ResponseまたはWP_Errorオブジェクトを返してください。
権限コールバック
エンドポイントのために権限コールバックも登録する必要があります。これは、実際のコールバックが呼び出される前に、ユーザーがアクション(読み取り、更新など)を実行できるかどうかを確認する関数です。これにより、APIはクライアントに特定のURLで実行できるアクションを伝えることができ、最初にリクエストを試みる必要がありません。
このコールバックは、permission_callback
として登録でき、再びcallback
オプションの隣のエンドポイントオプションにあります。このコールバックは、ブール値またはWP_Error
インスタンスを返す必要があります。この関数がtrueを返すと、レスポンスが処理されます。falseを返すと、デフォルトのエラーメッセージが返され、リクエストは処理を続行しません。WP_Error
を返すと、そのエラーがクライアントに返されます。
権限コールバックは、現在のユーザーを設定するリモート認証の後に実行されます。これにより、current_user_can
を使用して、認証されたユーザーがアクションに対して適切な権限を持っているか、または現在のユーザーIDに基づいて他のチェックを行うことができます。可能な限り、current_user_can
を常に使用するべきです。ユーザーがログインしているかどうか(認証)を確認するのではなく、アクションを実行できるかどうか(認可)を確認してください。
前の例を続けると、編集者以上のユーザーのみがこの著者データを表示できるようにすることができます。ここでいくつかの異なる権限を確認できますが、最も良いのは`````edit_others_posts`````で、これは実際に編集者の核心です。これを行うには、ここでコールバックが必要です:
``````bash
<?php
add_action( 'rest_api_init', function () {
register_rest_route( 'myplugin/v1', '/author/(?P<id>\d+)', array(
'methods' => 'GET',
'callback' => 'my_awesome_func',
'args' => array(
'id' => array(
'validate_callback' => 'is_numeric'
),
),
'permission_callback' => function () {
return current_user_can( 'edit_others_posts' );
}
) );
} );
`
権限コールバックもリクエストオブジェクトを最初のパラメータとして受け取るため、必要に応じてリクエスト引数に基づいてチェックを行うことができます。
WordPress 5.5以降、permission_callback
が提供されていない場合、REST APIは_doing_it_wrong
通知を発行します。
myplugin/v1/authorのREST APIルート定義には、必須のpermission_callback引数が欠けています。公開を意図したREST APIルートには、__return_trueを権限コールバックとして使用してください。
公開されているREST APIエンドポイントの場合、return_true
を権限コールバックとして使用できます。
<?php
add_action( 'rest_api_init', function () {
register_rest_route( 'myplugin/v1', '/author/(?P<id>\d+)', array(
'methods' => 'GET',
'callback' => 'my_awesome_func',
'permission_callback' => '__return_true',
) );
} );
発見
カスタムエンドポイントのリソース発見を有効にしたい場合は、rest_queried_resource_route
フィルターを使用して行うことができます。たとえば、カスタムリソースのIDを含むカスタムクエリ変数my-route
を考えてみてください。次のコードスニペットは、my-route
クエリ変数が使用されるたびに発見リンクを追加します。
function my_plugin_rest_queried_resource_route( $route ) {
$id = get_query_var( 'my-route' );
if ( ! $route && $id ) {
$route = '/my-ns/v1/items/' . $id;
}
return $route;
}
add_filter( 'rest_queried_resource_route', 'my_plugin_rest_queried_resource_route' );
注意:エンドポイントがカスタム投稿タイプまたはカスタムタクソノミーを説明している場合、rest_route_for_post
またはrest_route_for_term
フィルターを使用することをお勧めします。
コントローラーパターン
コントローラーパターンは、APIで複雑なエンドポイントを扱うためのベストプラクティスです。
このセクションを読む前に、「内部クラスの拡張」を読むことをお勧めします。これにより、デフォルトのルートで使用されるパターンに慣れることができ、これはベストプラクティスです。リクエストを処理するために使用するクラスがWP_REST_Controller
クラスまたはそれを拡張するクラスを拡張する必要はありませんが、そうすることで、これらのクラスで行われた作業を継承できます。さらに、使用しているコントローラーメソッドに基づいてベストプラクティスに従っていることを確認できます。
コントローラの本質は、RESTの慣習に一致するように一般的に命名されたメソッドのセットと便利なヘルパーです。コントローラは、register_routes
メソッドでルートを登録し、get_items
、get_item
、create_item
、update_item
、delete_item
でリクエストに応答し、同様に命名された権限チェックメソッドを持っています。このパターンに従うことで、エンドポイントのステップや機能を見逃すことがありません。
コントローラを使用するには、まず基本コントローラをサブクラス化する必要があります。これにより、独自の動作を追加するための基本的なメソッドセットが得られます。
コントローラをサブクラス化したら、クラスをインスタンス化して動作させる必要があります。これは、rest_api_init
にフックされたコールバック内で行うべきで、必要なときにのみクラスをインスタンス化することを保証します。通常のコントローラーパターンは、このコールバック内で$controller->register_routes()
を呼び出すことで、クラスがそのエンドポイントを登録できるようにします。
例
以下は「スターター」カスタムルートです:
<?php
class Slug_Custom_Route extends WP_REST_Controller {
/**
* Register the routes for the objects of the controller.
*/
public function register_routes() {
$version = '1';
$namespace = 'vendor/v' . $version;
$base = 'route';
register_rest_route( $namespace, '/' . $base, array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_items' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'args' => array(
),
),
array(
'methods' => WP_REST_Server::CREATABLE,
'callback' => array( $this, 'create_item' ),
'permission_callback' => array( $this, 'create_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( true ),
),
) );
register_rest_route( $namespace, '/' . $base . '/(?P<id>[\d]+)', array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_item' ),
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'args' => array(
'context' => array(
'default' => 'view',
),
),
),
array(
'methods' => WP_REST_Server::EDITABLE,
'callback' => array( $this, 'update_item' ),
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'args' => $this->get_endpoint_args_for_item_schema( false ),
),
array(
'methods' => WP_REST_Server::DELETABLE,
'callback' => array( $this, 'delete_item' ),
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
'args' => array(
'force' => array(
'default' => false,
),
),
),
) );
register_rest_route( $namespace, '/' . $base . '/schema', array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_public_item_schema' ),
) );
}
/**
* Get a collection of items
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
$items = array(); //do a query, call another class, etc
$data = array();
foreach( $items as $item ) {
$itemdata = $this->prepare_item_for_response( $item, $request );
$data[] = $this->prepare_response_for_collection( $itemdata );
}
return new WP_REST_Response( $data, 200 );
}
/**
* Get one item from the collection
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
//get parameters from request
$params = $request->get_params();
$item = array();//do a query, call another class, etc
$data = $this->prepare_item_for_response( $item, $request );
//return a response or error based on some conditional
if ( 1 == 1 ) {
return new WP_REST_Response( $data, 200 );
} else {
return new WP_Error( 'code', __( 'message', 'text-domain' ) );
}
}
/**
* Create one item from the collection
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function create_item( $request ) {
$item = $this->prepare_item_for_database( $request );
if ( function_exists( 'slug_some_function_to_create_item' ) ) {
$data = slug_some_function_to_create_item( $item );
if ( is_array( $data ) ) {
return new WP_REST_Response( $data, 200 );
}
}
return new WP_Error( 'cant-create', __( 'message', 'text-domain' ), array( 'status' => 500 ) );
}
/**
* Update one item from the collection
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
$item = $this->prepare_item_for_database( $request );
if ( function_exists( 'slug_some_function_to_update_item' ) ) {
$data = slug_some_function_to_update_item( $item );
if ( is_array( $data ) ) {
return new WP_REST_Response( $data, 200 );
}
}
return new WP_Error( 'cant-update', __( 'message', 'text-domain' ), array( 'status' => 500 ) );
}
/**
* Delete one item from the collection
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function delete_item( $request ) {
$item = $this->prepare_item_for_database( $request );
if ( function_exists( 'slug_some_function_to_delete_item' ) ) {
$deleted = slug_some_function_to_delete_item( $item );
if ( $deleted ) {
return new WP_REST_Response( true, 200 );
}
}
return new WP_Error( 'cant-delete', __( 'message', 'text-domain' ), array( 'status' => 500 ) );
}
/**
* Check if a given request has access to get items
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|bool
*/
public function get_items_permissions_check( $request ) {
//return true; <--use to make readable by all
return current_user_can( 'edit_something' );
}
/**
* Check if a given request has access to get a specific item
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|bool
*/
public function get_item_permissions_check( $request ) {
return $this->get_items_permissions_check( $request );
}
/**
* Check if a given request has access to create items
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|bool
*/
public function create_item_permissions_check( $request ) {
return current_user_can( 'edit_something' );
}
/**
* Check if a given request has access to update a specific item
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|bool
*/
public function update_item_permissions_check( $request ) {
return $this->create_item_permissions_check( $request );
}
/**
* Check if a given request has access to delete a specific item
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|bool
*/
public function delete_item_permissions_check( $request ) {
return $this->create_item_permissions_check( $request );
}
/**
* Prepare the item for create or update operation
*
* @param WP_REST_Request $request Request object
* @return WP_Error|object $prepared_item
*/
protected function prepare_item_for_database( $request ) {
return array();
}
/**
* Prepare the item for the REST response
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @return mixed
*/
public function prepare_item_for_response( $item, $request ) {
return array();
}
/**
* Get the query params for collections
*
* @return array
*/
public function get_collection_params() {
return array(
'page' => array(
'description' => 'Current page of the collection.',
'type' => 'integer',
'default' => 1,
'sanitize_callback' => 'absint',
),
'per_page' => array(
'description' => 'Maximum number of items to be returned in result set.',
'type' => 'integer',
'default' => 10,
'sanitize_callback' => 'absint',
),
'search' => array(
'description' => 'Limit results to those matching a string.',
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
),
);
}
}