Remove return descriptions from the DocBlocks for `add_image_size()` and `set_post_thumbnail_size()` as they don't return anything.

Also document the `$_wp_additional_image_sizes` global, leveraged in `add_image_size()`.

Props stevegrunwell.
Fixes #30511.

Built from https://develop.svn.wordpress.org/trunk@30633


git-svn-id: http://core.svn.wordpress.org/trunk@30623 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-30 05:49:23 +00:00
parent 74175fb08c
commit c512f1d916
2 changed files with 4 additions and 3 deletions

View File

@ -214,12 +214,13 @@ function image_downsize($id, $size = 'medium') {
* *
* @since 2.9.0 * @since 2.9.0
* *
* @global array $_wp_additional_image_sizes Associative array of additional image sizes.
*
* @param string $name Image size identifier. * @param string $name Image size identifier.
* @param int $width Image width in pixels. * @param int $width Image width in pixels.
* @param int $height Image height in pixels. * @param int $height Image height in pixels.
* @param bool|array $crop Optional. Whether to crop images to specified height and width or resize. * @param bool|array $crop Optional. Whether to crop images to specified height and width or resize.
* An array can specify positioning of the crop area. Default false. * An array can specify positioning of the crop area. Default false.
* @return bool|array False, if no image was created. Metadata array on success.
*/ */
function add_image_size( $name, $width = 0, $height = 0, $crop = false ) { function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
global $_wp_additional_image_sizes; global $_wp_additional_image_sizes;
@ -268,13 +269,13 @@ function remove_image_size( $name ) {
* Registers an image size for the post thumbnail. * Registers an image size for the post thumbnail.
* *
* @since 2.9.0 * @since 2.9.0
*
* @see add_image_size() for details on cropping behavior. * @see add_image_size() for details on cropping behavior.
* *
* @param int $width Image width in pixels. * @param int $width Image width in pixels.
* @param int $height Image height in pixels. * @param int $height Image height in pixels.
* @param bool|array $crop Optional. Whether to crop images to specified height and width or resize. * @param bool|array $crop Optional. Whether to crop images to specified height and width or resize.
* An array can specify positioning of the crop area. Default false. * An array can specify positioning of the crop area. Default false.
* @return bool|array False, if no image was created. Metadata array on success.
*/ */
function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) { function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
add_image_size( 'post-thumbnail', $width, $height, $crop ); add_image_size( 'post-thumbnail', $width, $height, $crop );

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30632'; $wp_version = '4.1-beta2-30633';
/** /**
* 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.