wp_remote_post( string $url, array $args = array() )

Performs an HTTP request using the POST method and returns its response.


Description

Top ↑

See also


Top ↑

Parameters

$url

(string) (Required) URL to retrieve.

$args

(array) (Optional) Request arguments.

Default value: array()


Top ↑

Return

(array|WP_Error) The response or WP_Error on failure.


Top ↑

Source

File: wp-includes/http.php

function wp_remote_post( $url, $args = array() ) {
	$http = _wp_http_get_object();
	return $http->post( $url, $args );
}


Top ↑

Changelog

Changelog
Version Description
2.7.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    Contributed by Codex

    Post data should be sent in the body as an array. Example passing post data:

    $response = wp_remote_post( $url, array(
    	'method'      => 'POST',
    	'timeout'     => 45,
    	'redirection' => 5,
    	'httpversion' => '1.0',
    	'blocking'    => true,
    	'headers'     => array(),
    	'body'        => array(
    		'username' => 'bob',
    		'password' => '1234xyz'
    	),
    	'cookies'     => array()
        )
    );
    
    if ( is_wp_error( $response ) ) {
    	$error_message = $response->get_error_message();
    	echo "Something went wrong: $error_message";
    } else {
    	echo 'Response:<pre>';
    	print_r( $response );
    	echo '</pre>';
    }
    

    In the example above, $response['body'] will contain the actual page content returned by the server.

  2. Skip to note 3 content
    Contributed by Pixelbart

    An example of a JSON body:

    $endpoint = 'api.example.com';
    
    $body = [
    	'name'  => 'Pixelbart',
    	'email' => 'pixelbart@example.com',
    ];
    
    $body = wp_json_encode( $body );
    
    $options = [
    	'body'        => $body,
    	'headers'     => [
    		'Content-Type' => 'application/json',
    	],
    	'timeout'     => 60,
    	'redirection' => 5,
    	'blocking'    => true,
    	'httpversion' => '1.0',
    	'sslverify'   => false,
    	'data_format' => 'body',
    ];
    
    wp_remote_post( $endpoint, $options );
    
  3. Skip to note 4 content
    Contributed by Mehedi Foysal
    $apiUrl      = 'https://api.example.com';
    $apiResponse = wp_remote_post( $apiUrl,
    	[
    		'method'    => 'GET',
    		'sslverify' => false,
    		'headers'   => [
    			'content-type' => 'application/json',
    			'user_key'     => 'xxxxxxxxxxxxx',
    		],
    	]
    );
    $apiBody     = json_decode( wp_remote_retrieve_body( $apiResponse ) );
    
  4. Skip to note 6 content
    Contributed by ouija

    A couple notes I thought worth mentioning is that if you’re using a Wordpress API endpoint that requires authentication, you can pass the _wpnonce parameter along with the session cookies to properly authenticate, like so:

    $endpoint = get_rest_url( null, 'ninja-forms-submissions/submissions/get' );
    $body = array(
    	'_wpnonce' => wp_create_nonce( 'wp_rest' ),
    	'type' => 'columns',
    	'form_ids' => '1'
    );
    
    // Need session cookies passed to verify nonce
    $cookies = array();
    foreach ( $_COOKIE as $name => $value ) {
        $cookies[] = new WP_Http_Cookie( array( 'name' => $name, 'value' => $value ) );
    }
    
    $options = array(
    	'method'.     => 'GET',
    	'body'        => $body,
    	'headers'     => array(
    		'Cache-Control' => 'no-cache',
    	),
    	'timeout'     => 60,
    	'redirection' => 5,
    	'blocking'    => true,
    	'httpversion' => '1.0',
    	'sslverify'   => false,
    	'data_format' => 'body',
    	'cookies'     => $cookies
    );
    
    $response = wp_remote_post( $endpoint, $options );
    

    Note that I’m also using wp_remote_post to perform a GET call in this example (by passing the ‘method’ argument), otherwise I could use the wp_remote_get function instead

You must log in before being able to contribute a note or feedback.