Changeset 32352

Timestamp:

05/05/2015 02:19:47 AM (11 years ago)

Author:

DrewAPicture

Message:

Fix documentation syntax and formatting for the media_sideload_image() DocBlock.

See #32246.

File:

• trunk/src/wp-admin/includes/media.php (modified) (2 diffs)

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

@@ -823 +823 @@
 
 /**
- * Download an image from the specified URL and attach it to a post.
+ * Downloads an image from the specified URL and attaches it to a post.
  *
  * @since 2.6.0
  * @since 4.2.0 Introduced the `$return` parameter.
  *
- * @param string $file The URL of the image to download
- * @param int $post_id The post ID the media is to be associated with
- * @param string $desc Optional. Description of the image
- * @param string $return Optional. Accepts 'html' (image tag html) or 'src' (URL). Default 'html'.
- * @return string|WP_Error Populated HTML img tag on success
+ * @param string $file    The URL of the image to download.
+ * @param int    $post_id The post ID the media is to be associated with.
+ * @param string $desc    Optional. Description of the image.
+ * @param string $return  Optional. Accepts 'html' (image tag html) or 'src' (URL). Default 'html'.
+ * @return string|WP_Error Populated HTML img tag on success, WP_Error object otherwise.
  */
 function media_sideload_image( $file, $post_id, $desc = null, $return = 'html' ) {
     if ( ! empty( $file ) ) {
+
         // Set variables for storage, fix file filename for query strings.
         preg_match( '/[^\?]+\.(jpe?g|jpe|gif|png)\b/i', $file, $matches );
@@ -861 +862 @@
     }
 
-    // Finally check to make sure the file has been saved, then return the HTML.
+    // Finally, check to make sure the file has been saved, then return the HTML.
     if ( ! empty( $src ) ) {
         if ( $return === 'src' ) {