Changeset 28653 for trunk/src/wp-includes/media.php

Timestamp:

06/03/2014 03:52:46 AM (12 years ago)

Author:

DrewAPicture

Message:

Make sure $post is properly documented as optional where applicable.

See #28388.

File:

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

trunk/src/wp-includes/media.php

@@ -2975 +2975 @@
  * @since 3.6.0
  *
- * @param string $type (Mime) type of media desired
- * @param mixed $post Post ID or object
- * @return array Found attachments
+ * @param string      $type Mime type.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return array Found attachments.
  */
 function get_attached_media( $type, $post = 0 ) {
@@ -3101 +3101 @@
  * @since 3.6.0
  *
- * @param int|WP_Post $post Optional. Post ID or object.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
  * @param bool        $html Whether to return HTML or data.
  * @return string|array Gallery data and srcs parsed from the expanded shortcode.
@@ -3126 +3126 @@
  * @since 3.6.0
  *
- * @param mixed $post Optional. Post ID or object.
- * @return array A list of lists, each containing image srcs parsed
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return array A list of lists, each containing image srcs parsed.
  *              from an expanded shortcode
  */
@@ -3140 +3140 @@
  * @since 3.6.0
  *
- * @param mixed $post Optional. Post ID or object.
- * @return array A list of a gallery's image srcs in order
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
+ * @return array A list of a gallery's image srcs in order.
  */
 function get_post_gallery_images( $post = 0 ) {