Changeset 24250 for trunk/wp-includes/http.php

Timestamp:

05/14/2013 02:00:19 PM (13 years ago)

Author:

ryan

Message:

Add default args list to wp_remote_request|get|post|head docblocks

Props DrewAPicture
fixes #23838

File:

• trunk/wp-includes/http.php (modified) (4 diffs)

trunk/wp-includes/http.php

@@ -50 +50 @@
  * functions to abstract out the above convoluted setup.
  *
+ * List of default arguments:
+ * 'method'      => 'GET'
+ *  - Default 'GET'  for wp_remote_get()
+ *  - Default 'POST' for wp_remote_post()
+ *  - Default 'HEAD' for wp_remote_head()
+ * 'timeout'     => 5
+ * 'redirection' => 5
+ * 'httpversion' => '1.0'
+ * 'user-agent'  => 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' )
+ * 'blocking'    => true
+ * 'headers'     => array()
+ * 'cookies'     => array()
+ * 'body'        => null
+ * 'compress'    => false,
+ * 'decompress'  => true,
+ * 'sslverify'   => true,
+ * 'stream'      => false,
+ * 'filename'    => null
+ *
  * @since 2.7.0
  *
@@ -64 +83 @@
  * Retrieve the raw response from the HTTP request using the GET method.
  *
- * @see wp_remote_request() For more information on the response array format.
+ * @see wp_remote_request() For more information on the response array format and default arguments.
  *
  * @since 2.7.0
@@ -80 +99 @@
  * Retrieve the raw response from the HTTP request using the POST method.
  *
- * @see wp_remote_request() For more information on the response array format.
+ * @see wp_remote_request() For more information on the response array format and default arguments.
  *
  * @since 2.7.0
@@ -96 +115 @@
  * Retrieve the raw response from the HTTP request using the HEAD method.
  *
- * @see wp_remote_request() For more information on the response array format.
+ * @see wp_remote_request() For more information on the response array format and default arguments.
  *
  * @since 2.7.0