Responsive images: add inline docs for private functions.

Props swissspidy.
See #34430.
Built from https://develop.svn.wordpress.org/trunk@35426


git-svn-id: http://core.svn.wordpress.org/trunk@35390 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Andrew Ozz 2015-10-28 21:55:24 +00:00
parent ce23a01aa8
commit d7da5970fa
2 changed files with 23 additions and 8 deletions

View File

@ -869,7 +869,12 @@ function wp_get_attachment_image_url( $attachment_id, $size = 'thumbnail', $icon
} }
/** /**
* 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() { function _wp_upload_dir_baseurl() {
static $baseurl = null; static $baseurl = null;
@ -883,18 +888,28 @@ function _wp_upload_dir_baseurl() {
} }
/** /**
* Private, do not use * 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, $image_meta ) { function _wp_get_image_size_from_meta( $size_name, $image_meta ) {
if ( $size === 'full' ) { if ( $size_name === 'full' ) {
return array( return array(
absint( $image_meta['width'] ), absint( $image_meta['width'] ),
absint( $image_meta['height'] ), absint( $image_meta['height'] ),
); );
} elseif ( ! empty( $image_meta['sizes'][$size] ) ) { } elseif ( ! empty( $image_meta['sizes'][$size_name] ) ) {
return array( return array(
absint( $image_meta['sizes'][$size]['width'] ), absint( $image_meta['sizes'][$size_name]['width'] ),
absint( $image_meta['sizes'][$size]['height'] ), absint( $image_meta['sizes'][$size_name]['height'] ),
); );
} }

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-beta2-35425'; $wp_version = '4.4-beta2-35426';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.