From 5a573f28f27f4690528f6acbdfc623d8967ac1f7 Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Sat, 17 Oct 2020 14:54:05 +0000 Subject: [PATCH] Docs: Miscellaneous docblock fixes. See #50768 Built from https://develop.svn.wordpress.org/trunk@49181 git-svn-id: http://core.svn.wordpress.org/trunk@48943 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/media.php | 13 +++++++------ wp-admin/includes/plugin-install.php | 2 +- wp-includes/class-wp-customize-control.php | 2 +- wp-includes/version.php | 2 +- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php index 65890ac578..7990f0aec8 100644 --- a/wp-admin/includes/media.php +++ b/wp-admin/includes/media.php @@ -960,11 +960,11 @@ function wp_media_upload_handler() { } /** - * Downloads an image from the specified URL and attaches it to a post. + * Downloads an image from the specified URL, saves it as an attachment, and optionally attaches it to a post. * * @since 2.6.0 * @since 4.2.0 Introduced the `$return` parameter. - * @since 4.8.0 Introduced the 'id' option within the `$return` parameter. + * @since 4.8.0 Introduced the 'id' option for the `$return` parameter. * @since 5.3.0 The `$post_id` parameter was made optional. * @since 5.4.0 The original URL of the attachment is stored in the `_source_url` * post meta value. @@ -974,7 +974,8 @@ function wp_media_upload_handler() { * @param string $desc Optional. Description of the image. * @param string $return Optional. Accepts 'html' (image tag html) or 'src' (URL), * or 'id' (attachment ID). Default 'html'. - * @return string|WP_Error Populated HTML img tag on success, WP_Error object otherwise. + * @return string|int|WP_Error Populated HTML img tag, attachment ID, or attachment source + * on success, WP_Error object otherwise. */ function media_sideload_image( $file, $post_id = 0, $desc = null, $return = 'html' ) { if ( ! empty( $file ) ) { @@ -2273,9 +2274,9 @@ function media_upload_form( $errors = null ) { * * @since 2.5.0 * - * @param string $type - * @param object $errors - * @param int $id + * @param string $type + * @param object $errors + * @param int|WP_Error $id */ function media_upload_type_form( $type = 'file', $errors = null, $id = null ) { diff --git a/wp-admin/includes/plugin-install.php b/wp-admin/includes/plugin-install.php index 018fe64dc1..1e6f2b075b 100644 --- a/wp-admin/includes/plugin-install.php +++ b/wp-admin/includes/plugin-install.php @@ -240,7 +240,7 @@ function plugins_api( $action, $args = array() ) { * @since 2.7.0 * * @param array $args - * @return array + * @return array|WP_Error */ function install_popular_tags( $args = array() ) { $key = md5( serialize( $args ) ); diff --git a/wp-includes/class-wp-customize-control.php b/wp-includes/class-wp-customize-control.php index 52ffc30d58..25964fb7bc 100644 --- a/wp-includes/class-wp-customize-control.php +++ b/wp-includes/class-wp-customize-control.php @@ -60,7 +60,7 @@ class WP_Customize_Control { * The primary setting for the control (if there is one). * * @since 3.4.0 - * @var string + * @var string|WP_Customize_Setting|null */ public $setting = 'default'; diff --git a/wp-includes/version.php b/wp-includes/version.php index da9d6cf0de..80b0ffa522 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.6-alpha-49180'; +$wp_version = '5.6-alpha-49181'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.