Skip to content

Media: Avoid undefined array key warnings in wp_image_src_get_dimensions() #14863

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

Open
abhishekfdd wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Media: Avoid undefined array key warnings in wp_image_src_get_dimensions() #14863

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/wp-includes/media.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1818,7 +1818,7 @@ function wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id =

// Is it a full size image?
if (
isset( $image_meta['file'] ) &&
isset( $image_meta['file'], $image_meta['width'], $image_meta['height'] ) &&
str_contains( $image_src, wp_basename( $image_meta['file'] ) )
) {
$dimensions = array(
Expand Down
95 changes: 95 additions & 0 deletions tests/phpunit/tests/media/wpImageSrcGetDimensions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<?php

/**
* Tests for the `wp_image_src_get_dimensions()` function.
*
* @group media
* @covers ::wp_image_src_get_dimensions
*/
class Tests_Media_wpImageSrcGetDimensions extends WP_UnitTestCase {

protected static $attachment_id;

public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
self::$attachment_id = $factory->attachment->create_object(
array(
'file' => '2024/10/image.svg',
'post_mime_type' => 'image/svg+xml',
)
);
}

/**
* Tests that `wp_image_src_get_dimensions()` returns the full size dimensions from the image meta.
*
* @ticket 62312
*/
public function test_should_return_full_size_dimensions() {
wp_update_attachment_metadata(
self::$attachment_id,
array(
'file' => '2024/10/image.svg',
'width' => 640,
'height' => 480,
)
);

$this->assertSame(
array( 640, 480 ),
wp_image_src_get_dimensions(
'http://example.org/wp-content/uploads/2024/10/image.svg',
wp_get_attachment_metadata( self::$attachment_id ),
self::$attachment_id
)
);
}

/**
* Tests that `wp_image_src_get_dimensions()` returns false without raising warnings
* when the full size image meta is missing width or height.
*
* @ticket 62312
*
* @dataProvider data_should_return_false_when_full_size_dimensions_are_missing
*
* @param array $image_meta The image meta data.
*/
public function test_should_return_false_when_full_size_dimensions_are_missing( $image_meta ) {
wp_update_attachment_metadata( self::$attachment_id, $image_meta );

$this->assertFalse(
wp_image_src_get_dimensions(
'http://example.org/wp-content/uploads/2024/10/image.svg',
wp_get_attachment_metadata( self::$attachment_id ),
self::$attachment_id
)
);
}

/**
* Data provider.
*
* @return array[]
*/
public function data_should_return_false_when_full_size_dimensions_are_missing() {
return array(
'width and height missing' => array(
'image_meta' => array(
'file' => '2024/10/image.svg',
),
),
'width missing' => array(
'image_meta' => array(
'file' => '2024/10/image.svg',
'height' => 480,
),
),
'height missing' => array(
'image_meta' => array(
'file' => '2024/10/image.svg',
'width' => 640,
),
),
);
}
}
Loading