Ticket #34430: 34430.docs.diff

src/wp-includes/media.php

@@ -865 +865 @@
 }
 
 /**
- * Private, do not use
+ * Get the base URL of the uploads directory.
+ *
+ * @since 4.4.0
+ * @access private
+ *
+ * @return string The base URL.
  */
 function _wp_upload_dir_baseurl() {
         static $baseurl = null;
@@ -879 +884 @@
 }
 
 /**
- * Private, do not use
+ * Get the image's size from its meta data.
+ *
+ * Used for responsive images.
+ *
+ * @since 4.4.0
+ * @access private
+ *
+ * @param string $size       Image size. Accepts any valid image size name (thumbnail, medium, etc.),
+ *                           or an array of width and height values in pixels (in that order).
+ * @param array  $image_meta The image meta data.
+ * @return array|false Array of width and height values in pixels (in that order)
+ *                     or false if the size doesn't exist.
  */
 function _wp_get_image_size_from_meta( $size, $image_meta ) {
         if ( $size === 'full' ) {
@@ -902 +918 @@
  *
  * @since 4.4.0
  *
-
- * @param int          $attachment_id Optional. Image attachment ID.
- * @param array|string $size          Image size. Accepts any valid image size, or an array of width and height
- *                                    values in pixels (in that order). Default 'medium'.
+ * @param int          $attachment_id Image attachment ID.
+ * @param array|string $size          Optional. Image size. Accepts any valid image size, or an array of
+ *                                    width and height values in pixels (in that order). Default 'medium'.
  * @param array        $image_meta    Optional. The image meta data.
  * @return string|bool A 'srcset' value string or false.
  */