Changeset 11091

Timestamp:

04/26/2009 11:54:59 PM (15 years ago)

Author:

ryan

Message:

phpdoc udpates and error checks for http. Props DD32. fixes #8620

File:

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

trunk/wp-includes/http.php

@@ -1899 +1899 @@
  * @param string $url Site URL to retrieve.
  * @param array $args Optional. Override the defaults.
- * @return WP_Error|string The body of the response or WP_Error on failure.
+ * @return WP_Error|array The response or WP_Error on failure.
  */
 function wp_remote_request($url, $args = array()) {
@@ -1915 +1915 @@
  * @param string $url Site URL to retrieve.
  * @param array $args Optional. Override the defaults.
- * @return WP_Error|string The body of the response or WP_Error on failure.
+ * @return WP_Error|array The response or WP_Error on failure.
  */
 function wp_remote_get($url, $args = array()) {
@@ -1931 +1931 @@
  * @param string $url Site URL to retrieve.
  * @param array $args Optional. Override the defaults.
- * @return WP_Error|string The body of the response or WP_Error on failure.
+ * @return WP_Error|array The response or WP_Error on failure.
  */
 function wp_remote_post($url, $args = array()) {
@@ -1947 +1947 @@
  * @param string $url Site URL to retrieve.
  * @param array $args Optional. Override the defaults.
- * @return WP_Error|string The body of the response or WP_Error on failure.
+ * @return WP_Error|array The response or WP_Error on failure.
  */
 function wp_remote_head($url, $args = array()) {
@@ -1963 +1963 @@
  */
 function wp_remote_retrieve_headers(&$response) {
-    if ( ! isset($response['headers']) || ! is_array($response['headers']))
+    if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
         return array();
 
@@ -1976 +1976 @@
  * @param array $response
  * @param string $header Header name to retrieve value from.
- * @return array The header value. Empty string on if incorrect parameter given.
+ * @return string The header value. Empty string on if incorrect parameter given, or if the header doesnt exist.
  */
 function wp_remote_retrieve_header(&$response, $header) {
-    if ( ! isset($response['headers']) || ! is_array($response['headers']))
+    if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
         return '';
 
@@ -1996 +1996 @@
  *
  * @param array $response HTTP response.
- * @return array The keys 'code' and 'message' give information on the response.
+ * @return string the response code. Empty string on incorrect parameter given.
  */
 function wp_remote_retrieve_response_code(&$response) {
-    if ( ! isset($response['response']) || ! is_array($response['response']))
+    if ( is_wp_error($response) ||! isset($response['response']) || ! is_array($response['response']))
         return '';
 
@@ -2013 +2013 @@
  *
  * @param array $response HTTP response.
- * @return array The keys 'code' and 'message' give information on the response.
+ * @return string The response message. Empty string on incorrect parameter given.
  */
 function wp_remote_retrieve_response_message(&$response) {
-    if ( ! isset($response['response']) || ! is_array($response['response']))
+    if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
         return '';
 
@@ -2031 +2031 @@
  */
 function wp_remote_retrieve_body(&$response) {
-    if ( ! isset($response['body']) )
+    if ( is_wp_error($response) || ! isset($response['body']) )
         return '';