開発者向けWordPressのカスタマイズ：カスタムREST APIエンドポイントの開発

WordPressは世界で最も人気のあるコンテンツ管理システム（CMS）の1つですが、WordPressは従来のブログコンテンツをサポートするだけでなく、WordPress REST APIという、WordPressと他の外部Webアプリケーションの橋渡しをする魔法のAPIのおかげで、大きく進化しました。WordPress REST API は、WordPress とその他の外部ウェブアプリケーションをつなぐ架け橋として機能する魔法の API です。この素晴らしいAPIは、WordPressと他の外部ウェブアプリケーションをつなぐ架け橋として機能し、WordPressが他のアプリケーションとより良い「チャット」を行い、素晴らしいウェブ体験を一緒に作り上げることを可能にします。

このAPIはどのように機能するのですか？エンドポイント」と呼ばれるものを利用します。これらのエンドポイントを使えば、WordPressからコンテンツを簡単に取得したり変更したりすることができます。このためにWordPressのバックエンドにログインする必要はありません。WordPressの使用は、より柔軟で強力になります。

WordPress REST APIについて

WordPress REST API は、標準的な HTTP メソッドを使って WordPress ウェブサイトとプログラムでやりとりできる強力なインターフェースです。そのデフォルトの機能には、構造化された JSON フォーマットの投稿、ページ、コメント、ユーザー、タクソノミなどのさまざまな種類の WordPress データへのアクセスと操作が含まれます。また、リモートでコンテンツのCRUD操作を行うことも可能です。

しかし、WordPress REST APIの本当の価値は、カスタムエンドポイントによる拡張性にあります。カスタムエンドポイントは、追加機能、サードパーティのサービス、独自のデータ構造の統合など、特定のニーズに合わせてAPIを調整するために作成することができます。この柔軟性により、高度にカスタマイズされた機能豊富なアプリケーションをWordPress上に構築することができます。

カスタムAPIエンドポイントの計画方法

カスタムエンドポイントの構造と使用法を計画することは、効率的なAPI開発の鍵となります。特定のニーズに合わせたカスタムエンドポイントは、最適な機能を確保するために慎重な検討が必要です。戦略的なプランニングは、スケーラビリティと適応性を促進するだけでなく、変化するビジネスニーズに対応するためにエンドポイントの将来性を確保します。

実装前にカスタムAPIエンドポイントのサポートを計画しましょう：

• エンドポイント機能の明確化エンドポイントの計画では、エンドポイントの具体的な機能、期待されるデータ型、使用法を明確にします。
• 一貫性と開発効率また、エンドポイント、レスポンスタイプ、フォーマットの使用に一貫性を持たせることで、APIとのインタラクションも向上します。さらに、APIが何に使用されるかを知ることで、適切な実装が可能になり、開発時間を短縮し、エラーのリスクを減らすことができます。
• 拡張性と適応性 エンドポイントの必要性を定義することで、設計を完全にやり直すことなく、変化するビジネスニーズや要件に対応できるようになります。
• 安全性適切なエンドポイントプランニングは、データへのアクセスや操作に必要な認証要件を決定するのに役立ちます。APIを通じたコンテンツへのアクセスでは、ユーザ認証が不要な場合があります。しかし、機密データや未承認データを含むコンテンツについては、セキュリティ要件を定義し、認証やアクセス制御などの対策を実施することが重要です。

次のハンズオンセクションでは、カスタムエンドポイントの作成方法について説明します。site-domain/wp-json/custom/v2/testimonialsWordPressデータベースサイトからお客様の声を取得します。

リクエスト送信後、エンドポイントはコールバック関数で定義されたWordPressサイトの評価に関する情報を含むJSONオブジェクトを返します。

エンドポイント用にカスタム投稿タイプを作成

まずカスタム投稿タイプを作成します：

1. WordPress管理ダッシュボードから外装状態一部ナビゲーションテーマファイルエディタ .

2.テーマを開く関数.php ファイルに以下のコードを追加してください：

関数 create_custom_testimonial_type() {
    register_post_type('testimonials', array(
        'labels' => array(
            'name' => 'お客様の声', 'singular_name' => 'お客様の声', 'singular_name' => 'お客様の声'
            'singular_name' => 'Testimonial'.
        ),
        
        'has_archive' => true, 'show_in_rest' => true, 'show_in_rest' => true
        'show_in_rest' => true, // これでREST APIのサポートが有効になります。
    ));
}
add_action('init', 'create_custom_testimonial_type')；

このコードはカスタム「レコメンデーション」を作成します。ポストタイプ を有効にし、WordPress REST API サポート ( 'show_in_rest' => true).コールバック追加アクションフック 関数作成_証言タイプ を作成し、実行中に起動します。ラベルやパラメータは、削除したり追加したりすることで、ニーズに合わせてカスタマイズすることができます。

3.クリック更新資料 をクリックして変更を保存します。

に追加されたWordPressダッシュボードを表示するには、ダッシュボードを更新します。お勧めのオプションです。

4.クリックお客様の声 > 新しい投稿を追加 お客様の声を含む新しい投稿を作成します。.を使用することができます。プルクオート ブロック推薦文をどのように表示するかによって、他にも使えるブロックがあります。

Pullquoteブロックを使用して作成された証言のサンプルを2つご紹介します：

WordPressでのカスタムエンドポイントの登録

カスタムエンドポイントを登録すると、REST API から利用できるようになります。これにはレジスタ・レスト・ルート 関数はrest_api_init フックを呼び出し、ルートが呼び出されたときに呼び出されるコールバックメソッドを提供します。

以下のコードをテーマの関数.php ドキュメンテーション

add_action( 'rest_api_init', 'register_testimonial_rest_route' )；

関数 register_testimonial_rest_route(){
register_rest_route(
'custom/v2'、
'/testimonials'、
array(
'methods' => 'GET'、
'callback' => 'get_testimonials'、
)
);
}

これらregister_rest_route() 3つのパラメータが必要です：

• ルーティング名前空間( $route_namespace): これは URL セグメントの最初の部分で、ベンダー/バージョン番号のパターンに従う必要があります。名前空間はエンドポイントを区別するのに役立ち、 顧客がカスタムエンドポイントのサポートに問い合わせやすくなります。このチュートリアルではカスタム/v2 名前空間。
• 基本URL ( 1TP4ルート): これは名前空間の後に位置し、メソッドにマップされる URL です。複数のエンドポイントをルートに登録できます。この記事では/お客様の声 推奨ルートを取得するようエンドポイントに指示します。
• エンドポイント用オプション ( 1TP4タルグ): ルートを呼び出すために使われる HTTP メソッドと、リクエストが送信されたときにエンドポイントから呼び出されるコールバック関数の配列です。このコールバック関数については次のセクションで説明します。

最後に、エンドポイントアドレスをメモします。エンドポイントのフォーマットはサイトアドレス/wp-json/名前空間/ルート.したがって、この例では、終点は次のようになります。https://www.staging.kidspartysanctuary.co.uk/wp-json/custom/v2/testimonials.

エンドポイントのコールバック関数の実装

カスタム投稿タイプを作成し、カスタムエンドポイントを登録したら、次はコールバック関数を記述します。このコールバック関数は、エンドポイントにアクセスするたびに呼び出されます。

1,お客様の声 以下のコードを使ってコールバック関数を宣言してください：

関数 get_testimonials(){

}

2.取得したWordPressのレコメンドデータを格納するために、空のレコメンド配列を初期化します：

$testimonials = array()；

3.1TP4タルグ のクエリパラメータにちなんだ配列。WP_Query お電話ください。

$args = array(
    'post_type' => 'testimonials', //カスタム投稿タイプを問い合わせたいことを指定します。
'testimonials', //カスタム投稿タイプを問い合わせたいことを指定します。
    'nopaging' => true, //ページ分割は行わず、すべての証言を一度に取得します。
),

4.クラスのインスタンスの作成WP_Query インスタンスは配列1TP4タルグ 指定されたパラメータに基づいてクエリが実行され、WordPress クエリの結果が$query を変数に追加します。

$query = new WP_Query($args)

5.おすすめの投稿があるかどうかをチェックする条件文を書きます。次にと同時に ループで投稿を反復処理し、その投稿に対するおすすめの投稿を返します。タイトル歌で応える内容

if ( $query->have_posts() ) { { { ( $query->have_posts() )
        while ( $query->have_posts() ) { { { $query->the_post()
            $query->the_post()；
            $testimonial_data = array( /*すべての投稿のタイトルと内容を格納する配列*/)
を格納する配列*/
            'title' => get_the_title()、
                
                // 必要に応じて他のフィールドを追加
            );
            $testimonials[] = $testimonial_data；
        }
        wp_reset_postdata(); /* $postグローバルを現在の投稿にリストアします。
グローバルを現在の投稿に復元します。
    }
    return rest_ensure_response( $testimonials ); /*レスポンスがレスポンスオブジェクトとして正しく設定されていることを確認します。
一貫性のためにレスポンスオブジェクトとして正しく設定されていることを確認します*/ } return rest_ensure_response( $testimonials ); /*レスポンスが

6,ポストマンの使用エンドポイントをテストし、データにアクセスできることを確認します。

ブラウザを使ってテストすることもできます。これはsite-domain/wp-json/custom/v2/testimonials ブラウザのアドレスバーにURLを入力し、エンドポイントにアクセスします。

ユーザが WordPress のデータベースデータに簡単にアクセスして操作できるようにしたいですか？コールバック関数でルートを登録するだけです。このコールバック関数は小さなデータヘルパーのような役割を果たし、ユーザーがデータにアクセスしたり操作したりしたいときにデータの処理を手助けします。このようにして、WordPress API のカスタムエンドポイントを問題なく実装することができます！