wp_remote_post

説明

mixed wp_remote_post( string $url [ , array $args = array() ] )
POSTメソッドを送信する。

パラメータ

  • $url
    リクエスト先URLを指定。
  • $args
    パラメータを連想配列で指定(省略時はarray())。連想配列の要素は次の通り。
    キー名内容省略時の値
    'method'メソッド種別'POST'
    'timeout'タイムアウト秒数5
    'redirection'リダイレクト回数5
    'httpversion'HTTPバージョン'1.0'
    'user-agent'ユーザエージェント'WordPress/'.$wp_version.'; '.get_bloginfo( 'url' )
    'blocking'ブロッキング指定true
    'headers'ヘッダーarray()
    'cookies'クッキーarray()
    'body'ボディ(クエリパラメータ)null
    'compress'圧縮指定false
    'decompress'非圧縮指定true
    'sslverify'SSLベリファイ指定true
    'stream'ストリーム指定false
    'filename'ファイル情報null

返り値

リクエストを送信(レスポンスを取得)できた場合は連想配列を、送信に失敗した場合は WP_Errorオブジェクトを返す。連想配列は次の通り。
キー名内容
'headers'ヘッダー情報('server'、'date'、'content-type'などの連想配列)
'body'レスポンス本体(文字列)
'response'レスポンス情報('code'と'message'要素を持つ連想配列)
'cookies'クッキー情報(配列)
'filename'ファイル情報

注意

基本的には wp_remote_request関数と同じだが、パラメータ$argsの'method'を省略した場合は'POST'が適用される点が異なる。
POST送信するクエリは、パラメータ$argsの'body'の値として連想配列(またはオブジェクト)で指定する。
※このクエリの展開は、'method'値が'POST'か'PUT'の場合のみ行われる。

使用例

  • 'http://localhost/'にPOSTメソッドを送信する。
    <?php
    $options = array( 'body' => array( 'query_name'=>'query_value' ) );
    $response = wp_remote_post( 'http://localhost/', $options );
    ?>

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/http.php

最終更新 : 2017年05月23日 16:20



お勧め

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

「姓」の後に「名」を(2013年11月6日 更新)

WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)

今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。

投稿情報を連想配列で参照する(2018年5月27日 更新)

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。