Changeset 37484

Timestamp:

05/22/2016 05:17:11 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Fix some parameter alignment and backtick-escaping in two DocBlocks in wp-admin/includes/media.php.

See #32246.

File:

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

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

@@ -264 +264 @@
  * @since 2.5.0
  *
- * @param string $file_id   Index of the $_FILES array that the file was sent. Required.
+ * @param string $file_id   Index of the `$_FILES` array that the file was sent. Required.
  * @param int    $post_id   The post ID of a post to attach the media item to. Required, but can
  *                          be set to 0, creating a media item that has no relationship to a post.
@@ -385 +385 @@
  * @since 2.6.0
  *
- * @param array $file_array Array similar to a $_FILES upload array
- * @param int $post_id The post ID the media is associated with
- * @param string $desc Description of the sideloaded file
- * @param array $post_data allows you to overwrite some of the attachment
- * @return int|object The ID of the attachment or a WP_Error on failure
+ * @param array  $file_array Array similar to a `$_FILES` upload array.
+ * @param int    $post_id    The post ID the media is associated with.
+ * @param string $desc       Optional. Description of the side-loaded file. Default null.
+ * @param array  $post_data  Optional. Post data to override. Default empty array.
+ * @return int|object The ID of the attachment or a WP_Error on failure.
  */
 function media_handle_sideload( $file_array, $post_id, $desc = null, $post_data = array() ) {