Changeset 47065

Timestamp:

01/12/2020 04:54:56 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for wp_save_image_file() and related functions.

See #48303.

File:

• trunk/src/wp-admin/includes/image-edit.php (modified) (6 diffs)

trunk/src/wp-admin/includes/image-edit.php

@@ -12 +12 @@
  * @since 2.9.0
  *
- * @param int         $post_id Post ID.
+ * @param int         $post_id Attachment post ID.
  * @param bool|object $msg     Optional. Message to display for image editor updates or errors.
  *                             Default false.
@@ -316 +316 @@
  * @since 2.9.0
  *
- * @param string $filename
- * @param WP_Image_Editor $image
- * @param string $mime_type
- * @param int $post_id
- * @return bool
+ * @param string          $filename  Name of the file to be saved.
+ * @param WP_Image_Editor $image     The image editor instance.
+ * @param string          $mime_type The mime type of the image.
+ * @param int             $post_id   Attachment post ID.
+ * @return bool True on success, false on failure.
  */
 function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
@@ -338 +338 @@
          * @param mixed           $override  Value to return instead of saving. Default null.
          * @param string          $filename  Name of the file to be saved.
-         * @param WP_Image_Editor $image     WP_Image_Editor instance.
-         * @param string          $mime_type Image mime type.
-         * @param int             $post_id   Post ID.
+         * @param WP_Image_Editor $image     The image editor instance.
+         * @param string          $mime_type The mime type of the image.
+         * @param int             $post_id   Attachment post ID.
          */
         $saved = apply_filters( 'wp_save_image_editor_file', null, $filename, $image, $mime_type, $post_id );
@@ -367 +367 @@
          * @param mixed           $override  Value to return instead of saving. Default null.
          * @param string          $filename  Name of the file to be saved.
-         * @param WP_Image_Editor $image     WP_Image_Editor instance.
-         * @param string          $mime_type Image mime type.
-         * @param int             $post_id   Post ID.
+         * @param WP_Image_Editor $image     The image editor instance.
+         * @param string          $mime_type The mime type of the image.
+         * @param int             $post_id   Attachment post ID.
          */
         $saved = apply_filters_deprecated( 'wp_save_image_file', array( null, $filename, $image, $mime_type, $post_id ), '3.5.0', 'wp_save_image_editor_file' );
@@ -618 +618 @@
 /**
  * Streams image in post to browser, along with enqueued changes
- * in $_REQUEST['history']
- *
- * @since 2.9.0
- *
- * @param int $post_id
- * @return bool
+ * in `$_REQUEST['history']`.
+ *
+ * @since 2.9.0
+ *
+ * @param int $post_id Attachment post ID.
+ * @return bool True on success, false on failure.
  */
 function stream_preview_image( $post_id ) {
@@ -748 +748 @@
 
 /**
- * Saves image to post along with enqueued changes
- * in $_REQUEST['history']
- *
- * @since 2.9.0
- *
- * @param int $post_id
- * @return \stdClass
+ * Saves image to post, along with enqueued changes
+ * in `$_REQUEST['history']`.
+ *
+ * @since 2.9.0
+ *
+ * @param int $post_id Attachment post ID.
+ * @return stdClass
  */
 function wp_save_image( $post_id ) {