非常に多くの場合、テーマやプラグインからHTTPリクエストを行う必要があります。たとえば、外部APIからデータを取得する必要があるときです。幸いなことに、WordPressにはそれを行うための多くのヘルパー関数があります。
このセクションでは、HTTPリクエストを適切に行い、その応答を処理する方法を学びます。
以下は、あなたが見ることになる例です。
$response = wp_remote_get( 'https://api.github.com/users/wordpress' );
$body = wp_remote_retrieve_body( $response );
次の記事では、リクエストを行う方法についての詳細な説明が見られます:
利用可能なヘルパー関数を探しているだけの場合、以下のものがあります:
以下の関数は、URLを取得するために使用するものです。
wp_remote_get()
:GET HTTPメソッドを使用してURLを取得します。wp_remote_post()
:POST HTTPメソッドを使用してURLを取得します。wp_remote_head()
:HEAD HTTPメソッドを使用してURLを取得します。wp_remote_request()
:デフォルトのGETまたは指定したカスタムHTTPメソッドを使用してURLを取得します。
他のヘルパー関数は、応答の異なる部分を取得することに関係しています。これにより、APIの使用が非常に簡単になり、応答オブジェクトを処理するための推奨方法となります。
wp_remote_retrieve_body()
– 応答からボディのみを取得します。wp_remote_retrieve_header()
– 生の応答から名前で単一のヘッダーを取得します。wp_remote_retrieve_headers()
– 生の応答からヘッダーのみを取得します。wp_remote_retrieve_response_code()
– HTTP応答の応答コードを取得します。これは200であるべきですが、失敗時には4xxまたは3xxになる可能性があります。wp_remote_retrieve_response_message()
– 生の応答から応答メッセージのみを取得します。