Skip to content

Fix incorrect image sizes in media image-size command #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schlessera merged 3 commits into from
Mar 14, 2024
Merged

Fix incorrect image sizes in media image-size command #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce4087f
Use core image subsizes function for image-size subcommand
ernilambar Feb 22, 2024
2a59fca
Add feature test for updated media image size
ernilambar Feb 22, 2024
38cf73a
Merge branch 'main' into 116-fix-image-size
danielbachhuber Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions features/media-image-size.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: http://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
Expand Down
114 changes: 73 additions & 41 deletions src/Media_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}

/**
Expand Down