Changeset 35426

Timestamp:

10/28/2015 09:54:04 PM (9 years ago)

Author:

azaozz

Message:

Responsive images: add inline docs for private functions.

Props swissspidy.
See #34430.

File:

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

trunk/src/wp-includes/media.php

@@ -870 +870 @@
 
 /**
- * Private, do not use
+ * Caches and returns the base URL of the uploads directory.
+ *
+ * @since 4.4.0
+ * @access private
+ *
+ * @return string The base URL, cached.
  */
 function _wp_upload_dir_baseurl() {
@@ -884 +889 @@
 
 /**
- * Private, do not use
- */
-function _wp_get_image_size_from_meta( $size, $image_meta ) {
-    if ( $size === 'full' ) {
+ * Get the image size as array from its meta data.
+ *
+ * Used for responsive images.
+ *
+ * @since 4.4.0
+ * @access private
+ *
+ * @param string $size_name  Image size. Accepts any valid image size name (thumbnail, medium, etc.).
+ * @param array  $image_meta The image meta data.
+ * @return array|bool 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_name, $image_meta ) {
+    if ( $size_name === 'full' ) {
         return array(
             absint( $image_meta['width'] ),
             absint( $image_meta['height'] ),
         );
-    } elseif ( ! empty( $image_meta['sizes'][$size] ) ) {
+    } elseif ( ! empty( $image_meta['sizes'][$size_name] ) ) {
         return array(
-            absint( $image_meta['sizes'][$size]['width'] ),
-            absint( $image_meta['sizes'][$size]['height'] ),
+            absint( $image_meta['sizes'][$size_name]['width'] ),
+            absint( $image_meta['sizes'][$size_name]['height'] ),
         );
     }