Merge pull request #192 from ernilambar/116-fix-image-size

schlessera · web-flow · commit 210cccf80f4f · 2024-03-14T10:04:20.000+01:00
diff --git a/features/media-image-size.feature b/features/media-image-size.feature
@@ -28,6 +28,53 @@ Feature: List image sizes
       | thumbnail      | 150       | 150       | hard   | 1:1   |
     And STDERR should be empty
 
+  @require-wp-5.3
+  Scenario: Basic usage with plugin which registers custom image size
+    Given a WP install
+    # Differing themes can have differing default image sizes. Let's stick to one.
+    And I try `wp theme install twentynineteen --activate`
+    And a wp-content/plugins/foo-bar.php file:
+      """
+      <?php
+      /**
+        * Plugin Name: Foo Bar
+        * Plugin URI: https://example.com
+        * Description: Custom plugin.
+        * Version: 0.1.0
+        * Author: John Doe
+        * Author URI: https://johndoe.com/
+        * License: GPL-2.0+
+        * License URI: https://www.gnu.org/licenses/gpl-2.0.txt
+        */
+
+      add_action(
+        'after_setup_theme',
+        function () {
+          add_image_size( 'foo-bar-thumb', 50, 50, true );
+        }
+      );
+      """
+    And I try `wp plugin activate foo-bar.php`
+
+    When I run `wp media image-size`
+    Then STDOUT should be a table containing rows:
+      | name           | width     | height    | crop   | ratio |
+      | full           |           |           | N/A    | N/A   |
+      | 2048x2048      | 2048      | 2048      | soft   | N/A   |
+      | post-thumbnail | 1568      | 9999      | soft   | N/A   |
+      | large          | 1024      | 1024      | soft   | N/A   |
+      | medium_large   | 768       | 0         | soft   | N/A   |
+      | medium         | 300       | 300       | soft   | N/A   |
+      | thumbnail      | 150       | 150       | hard   | 1:1   |
+      | foo-bar-thumb  | 50        | 50        | hard   | 1:1   |
+    And STDERR should be empty
+
+    When I run `wp media image-size --format=csv`
+    Then STDOUT should not contain:
+      """
+      ,0,0,
+      """
+
   # Behavior changed with WordPress 5.3+, so we're adding separate tests for previous versions.
   # Change that impacts this:
   # https://core.trac.wordpress.org/ticket/43524
diff --git a/src/Media_Command.php b/src/Media_Command.php
@@ -960,60 +960,92 @@ private function get_images( $args = array(), $additional_mime_types = array() )
 		return new WP_Query( $query_args );
 	}
 
-	/**
-	 * Get the metadata for the passed intermediate image size.
-	 *
-	 * @param string $size The image size to get the metadata for.
-	 *
-	 * @return array The image size metadata.
-	 */
-	private function get_intermediate_size_metadata( $size ) {
-		$width  = intval( get_option( "{$size}_size_w" ) );
-		$height = intval( get_option( "{$size}_size_h" ) );
-		$crop   = get_option( "{$size}_crop" );
-
-		return array(
-			'name'   => $size,
-			'width'  => $width,
-			'height' => $height,
-			'crop'   => false !== $crop ? 'hard' : 'soft',
-			'ratio'  => false !== $crop ? $this->get_ratio( $width, $height ) : 'N/A',
-		);
-	}
-
 	/**
 	 * Get all the registered image sizes along with their dimensions.
 	 *
-	 * @global array $_wp_additional_image_sizes The additional image sizes to parse.
-	 *
-	 * @link https://wordpress.stackexchange.com/a/251602 Original solution.
-	 *
 	 * @return array $image_sizes The image sizes
 	 */
 	private function get_registered_image_sizes() {
-		global $_wp_additional_image_sizes;
+		$image_sizes = array();
 
-		$image_sizes         = array();
-		$default_image_sizes = get_intermediate_image_sizes();
+		$all_sizes = $this->wp_get_registered_image_subsizes();
 
-		foreach ( $default_image_sizes as $size ) {
-			$image_sizes[] = $this->get_intermediate_size_metadata( $size );
+		foreach ( $all_sizes as $size => $size_args ) {
+			$crop = filter_var( $size_args['crop'], FILTER_VALIDATE_BOOLEAN );
+
+			$image_sizes[] = array(
+				'name'   => $size,
+				'width'  => $size_args['width'],
+				'height' => $size_args['height'],
+				'crop'   => empty( $crop ) || is_array( $size_args['crop'] ) ? 'soft' : 'hard',
+				'ratio'  => empty( $crop ) || is_array( $size_args['crop'] ) ? 'N/A' : $this->get_ratio( $size_args['width'], $size_args['height'] ),
+			);
 		}
 
-		if ( is_array( $_wp_additional_image_sizes ) ) {
-			foreach ( $_wp_additional_image_sizes as $size => $size_args ) {
-				$crop          = filter_var( $size_args['crop'], FILTER_VALIDATE_BOOLEAN );
-				$image_sizes[] = array(
-					'name'   => $size,
-					'width'  => $size_args['width'],
-					'height' => $size_args['height'],
-					'crop'   => empty( $crop ) || is_array( $size_args['crop'] ) ? 'soft' : 'hard',
-					'ratio'  => empty( $crop ) || is_array( $size_args['crop'] ) ? 'N/A' : $this->get_ratio( $size_args['width'], $size_args['height'] ),
-				);
+		return $image_sizes;
+	}
+
+	/**
+	* Returns a normalized list of all currently registered image sub-sizes.
+	*
+	* If exists, uses output of wp_get_registered_image_subsizes() function (introduced in WP 5.3).
+	* Definition of this method is modified version of core function wp_get_registered_image_subsizes().
+	*
+	* @global array $_wp_additional_image_sizes
+	*
+	* @return array[] Associative array of arrays of image sub-size information, keyed by image size name.
+	*/
+	private function wp_get_registered_image_subsizes() {
+		if ( Utils\wp_version_compare( '5.3', '>=' ) ) {
+			return wp_get_registered_image_subsizes();
+		}
+
+		global $_wp_additional_image_sizes;
+
+		$additional_sizes = $_wp_additional_image_sizes ? $_wp_additional_image_sizes : array();
+
+		$all_sizes = array();
+
+		foreach ( get_intermediate_image_sizes() as $size_name ) {
+			$size_data = array(
+				'width'  => 0,
+				'height' => 0,
+				'crop'   => false,
+			);
+
+			if ( isset( $additional_sizes[ $size_name ]['width'] ) ) {
+				// For sizes added by plugins and themes.
+				$size_data['width'] = (int) $additional_sizes[ $size_name ]['width'];
+			} else {
+				// For default sizes set in options.
+				$size_data['width'] = (int) get_option( "{$size_name}_size_w" );
 			}
+
+			if ( isset( $additional_sizes[ $size_name ]['height'] ) ) {
+				$size_data['height'] = (int) $additional_sizes[ $size_name ]['height'];
+			} else {
+				$size_data['height'] = (int) get_option( "{$size_name}_size_h" );
+			}
+
+			if ( empty( $size_data['width'] ) && empty( $size_data['height'] ) ) {
+				// This size isn't set.
+				continue;
+			}
+
+			if ( isset( $additional_sizes[ $size_name ]['crop'] ) ) {
+				$size_data['crop'] = $additional_sizes[ $size_name ]['crop'];
+			} else {
+				$size_data['crop'] = get_option( "{$size_name}_crop" );
+			}
+
+			if ( ! is_array( $size_data['crop'] ) || empty( $size_data['crop'] ) ) {
+				$size_data['crop'] = (bool) $size_data['crop'];
+			}
+
+			$all_sizes[ $size_name ] = $size_data;
 		}
 
-		return $image_sizes;
+		return $all_sizes;
 	}
 
 	/**
