Changeset 45892

Timestamp:

08/25/2019 10:20:57 PM (5 years ago)

Author:

azaozz

Message:

Docs: Improve and update the description of multi_resize() to explain changes and expected use.

See #40439.

Location:

trunk/src/wp-includes

Files:

• class-wp-image-editor-gd.php (modified) (1 diff)
• class-wp-image-editor-imagick.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-image-editor-gd.php

@@ -198 +198 @@
 
     /**
-     * Resize multiple images from a single source.
+     * Create multiple smaller images from a single source.
+     *
+     * Attempts to create all sub-sizes and returns the meta data at the end. This
+     * may result in the server running out of resources. When it fails there may be few
+     * "orphaned" images left over as the meta data is never returned and saved.
+     *
+     * As of 5.3.0 the preferred way to do this is with `make_subsize()`. It creates
+     * the new images one at a time and allows for the meta data to be saved after
+     * each new image is created.
      *
      * @since 3.5.0
      *
      * @param array $sizes {
-     *     An array of image size arrays. Default sizes are 'small', 'medium', 'medium_large', 'large'.
+     *     An array of image size data arrays.
      *
      *     Either a height or width must be provided.
      *     If one of the two is set to null, the resize will
-     *     maintain aspect ratio according to the provided dimension.
+     *     maintain aspect ratio according to the source image.
      *
      *     @type array $size {

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -411 +411 @@
 
     /**
-     * Resize multiple images from a single source.
+     * Create multiple smaller images from a single source.
+     *
+     * Attempts to create all sub-sizes and returns the meta data at the end. This
+     * may result in the server running out of resources. When it fails there may be few
+     * "orphaned" images left over as the meta data is never returned and saved.
+     *
+     * As of 5.3.0 the preferred way to do this is with `make_subsize()`. It creates
+     * the new images one at a time and allows for the meta data to be saved after
+     * each new image is created.
      *
      * @since 3.5.0
      *
      * @param array $sizes {
-     *     An array of image size arrays. Default sizes are 'thumbnail', 'medium', 'medium_large', 'large'.
+     *     An array of image size data arrays.
      *
      *     Either a height or width must be provided.