Docs: Fix syntax and properly mark optional parameters as such in the DocBlock for `get_image_send_to_editor()`.

Also fixes the return description, and adds the `$size` default value, missed in [35055].

See #34257. See #32246.

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


git-svn-id: http://core.svn.wordpress.org/trunk@35021 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-10-12 16:11:24 +00:00
parent 16738bf325
commit 4aea111b29
2 changed files with 11 additions and 10 deletions

View File

@ -106,17 +106,18 @@ function the_media_upload_tabs() {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @param int $id image attachment id * @param int $id Image attachment id.
* @param string $caption image caption * @param string $caption Image caption.
* @param string $title image title attribute * @param string $title Image title attribute.
* @param string $align image css alignment property * @param string $align Image CSS alignment property.
* @param string $url image src url * @param string $url Optional. Image src URL. Default empty.
* @param string $rel image rel attribute * @param string $rel Optional. Image rel attribute. Default empty.
* @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width * @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width
* and height values in pixels (in that order). * and height values in pixels (in that order). Default 'medium'.
* @return string the html to insert into editor * @param string $alt Optional. Image alt attribute. Default empty.
* @return string The HTML output to insert into the editor.
*/ */
function get_image_send_to_editor( $id, $caption, $title, $align, $url='', $rel = '', $size='medium', $alt = '' ) { function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $rel = '', $size = 'medium', $alt = '' ) {
$html = get_image_tag($id, $alt, '', $align, $size); $html = get_image_tag($id, $alt, '', $align, $size);

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-35055'; $wp_version = '4.4-alpha-35056';
/** /**
* 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.