Docs: Miscellaneous docblock fixes.

johnbillion · johnbillion · commit ff18031d1ba4 · 2020-10-17T14:52:04.000Z
See #50768 git-svn-id: https://develop.svn.wordpress.org/trunk@49181 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-admin/includes/media.php b/src/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/src/wp-admin/includes/plugin-install.php b/src/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/src/wp-includes/class-wp-customize-control.php b/src/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';
 

Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,7 @@ function plugins_api( $action, $args = array() ) {`
`240`	`240`	`* @since 2.7.0`
`241`	`241`	`*`
`242`	`242`	`* @param array $args`
`243`		`- * @return array`
	`243`	`+ * @return array\|WP_Error`
`244`	`244`	`*/`
`245`	`245`	`function install_popular_tags( $args = array() ) {`
`246`	`246`	`$key = md5( serialize( $args ) );`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ class WP_Customize_Control {`
`60`	`60`	`* The primary setting for the control (if there is one).`
`61`	`61`	`*`
`62`	`62`	`* @since 3.4.0`
`63`		`- * @var string`
	`63`	`+ * @var string\|WP_Customize_Setting\|null`
`64`	`64`	`*/`
`65`	`65`	`public $setting = 'default';`
`66`	`66`