Changeset 42773 for trunk/src/wp-admin/includes/file.php

Timestamp:

03/04/2018 05:13:35 PM (8 years ago)

Author:

SergeyBiryukov

Message:

Filesystem API: Allow download_url() to return the response code and body on error as an additional WP_Error object data.

The error response body size is limited to 1 KB by default to avoid taking up too much memory. The size can be increased using download_url_error_max_body_size filter.

Props soulseekah, campusboy1987, mihdan, SergeyBiryukov.
Fixes #43329.

File:

• trunk/src/wp-admin/includes/file.php (modified) (1 diff)

trunk/src/wp-admin/includes/file.php

@@ -994 +994 @@
         }
 
-        if ( 200 != wp_remote_retrieve_response_code( $response ) ) {
+        $response_code = wp_remote_retrieve_response_code( $response );
+
+        if ( 200 != $response_code ) {
+                $data = array(
+                        'code' => $response_code,
+                );
+
+                // Retrieve a sample of the response body for debugging purposes.
+                $tmpf = fopen( $tmpfname, 'rb' );
+                if ( $tmpf ) {
+                        /**
+                         * Filters the maximum error response body size in `download_url()`.
+                         *
+                         * @since 5.0.0
+                         *
+                         * @see download_url()
+                         *
+                         * @param int $size The maximum error response body size. Default 1 KB.
+                         */
+                        $response_size = apply_filters( 'download_url_error_max_body_size', KB_IN_BYTES );
+                        $data['body']  = fread( $tmpf, $response_size );
+                        fclose( $tmpf );
+                }
+
                 unlink( $tmpfname );
-                return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ) );
+                return new WP_Error( 'http_404', trim( wp_remote_retrieve_response_message( $response ) ), $data );
         }