トピック: register_rest_route() で独自の REST API エンドポイントを作成する方法

—

概要

WordPress REST API をカスタマイズする際に、`register_rest_route()` 関数を使用して独自の REST API エンドポイントを作成する方法を解説します。

サンプルコード

add_action( 'rest_api_init', function() {
    register_rest_route( 'myplugin/v1', '/custom-endpoint/', array(
        'methods' => 'GET',
        'callback' => 'my_custom_endpoint_handler',
    ));
});

function my_custom_endpoint_handler( $request ) {
    // カスタムエンドポイントの処理を記述
}

解説

• `add_action( 'rest_api_init', function() { … })` で REST API の初期化時にカスタムエンドポイントを登録します。
• `register_rest_route()` の第一引数には名前空間、第二引数にはエンドポイントのパス、第三引数には設定情報を指定します。
• `methods` には受け付ける HTTP メソッドを指定し、`callback` にはエンドポイントへのリクエストがあった際に実行されるコールバック関数を指定します。
• `my_custom_endpoint_handler` 関数内にはカスタムエンドポイントの処理を記述します。

ベストプラクティス

• エンドポイントの名前やパスは適切で分かりやすいものにすることで、他の開発者が理解しやすくなります。
• カスタムエンドポイント内でのデータのバリデーションやセキュリティ対策を適切に行うことが重要です。
• エンドポイントの拡張や追加機能を考えて、柔軟性を持たせる設計を心がけましょう。

—