Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions src/wp-admin/edit-form-blocks.php
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ static function ( $classes ) {
'/?_fields=' . implode(
',',
array(
'animated_image_subsizes',
'description',
'gmt_offset',
'home',
Expand Down
1 change: 1 addition & 0 deletions src/wp-admin/site-editor.php
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ static function ( $classes ) {
'/?_fields=' . implode(
',',
array(
'animated_image_subsizes',
'description',
'gmt_offset',
'home',
Expand Down
21 changes: 21 additions & 0 deletions src/wp-includes/rest-api/class-wp-rest-server.php
Original file line number Diff line number Diff line change
Expand Up @@ -1378,6 +1378,27 @@ public function get_index( $request ) {

/** This filter is documented in wp-admin/includes/image.php */
$available['image_size_threshold'] = (int) apply_filters( 'big_image_size_threshold', 2560, array( 0, 0 ), '', 0 );

/**
* Filters whether sub-sizes of animated images should keep their animation.
*
* By default, sub-sizes of animated images (e.g. animated GIFs) are static,
* generated from the first frame only. Re-encoding every frame per sub-size
* is very resource intensive, so animated sub-sizes are opt-in.
*
* This currently only affects the client-side media processing path,
* where all frames can be decoded and re-encoded in the browser. Only
* uncropped sub-sizes keep their animation; cropped sizes (such as
* `thumbnail`) are always generated from the first frame. Uploads that
* take the server-side path also still produce static sub-sizes, as
* neither GD nor Imagick resizing preserves animation in core.
*
* @since 7.2.0
*
* @param bool $animated_image_subsizes Whether to generate animated sub-sizes
* for animated images. Default false.
*/
$available['animated_image_subsizes'] = (bool) apply_filters( 'wp_generate_animated_image_subsizes', false );
}

$response = new WP_REST_Response( $available );
Expand Down
58 changes: 58 additions & 0 deletions tests/phpunit/tests/rest-api/rest-server.php
Original file line number Diff line number Diff line change
Expand Up @@ -1207,6 +1207,64 @@ public function test_get_index() {
$this->assertArrayHasKey( 'site_icon_url', $data );
}

/**
* @ticket 65656
*
* @covers WP_REST_Server::get_index
*/
public function test_get_index_should_include_animated_image_subsizes(): void {
$user_id = self::factory()->user->create( array( 'role' => 'administrator' ) );
$this->assertIsInt( $user_id );
wp_set_current_user( $user_id );
add_filter( 'wp_client_side_media_processing_enabled', '__return_true' );

$server = new WP_REST_Server();
$request = new WP_REST_Request( 'GET', '/' );
$index = $server->dispatch( $request );
$data = $index->get_data();
$this->assertIsArray( $data );

$this->assertArrayHasKey( 'animated_image_subsizes', $data );
$this->assertFalse( $data['animated_image_subsizes'] );
}

/**
* @ticket 65656
*
* @covers WP_REST_Server::get_index
*/
public function test_get_index_should_not_include_animated_image_subsizes_without_caps(): void {
add_filter( 'wp_client_side_media_processing_enabled', '__return_true' );

$server = new WP_REST_Server();
$request = new WP_REST_Request( 'GET', '/' );
$index = $server->dispatch( $request );
$data = $index->get_data();
$this->assertIsArray( $data );

$this->assertArrayNotHasKey( 'animated_image_subsizes', $data );
}

/**
* @ticket 65656
*
* @covers WP_REST_Server::get_index
*/
public function test_get_index_should_honor_animated_image_subsizes_filter(): void {
$user_id = self::factory()->user->create( array( 'role' => 'administrator' ) );
$this->assertIsInt( $user_id );
wp_set_current_user( $user_id );
Comment on lines +1254 to +1256

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$user_id = self::factory()->user->create( array( 'role' => 'administrator' ) );
$this->assertIsInt( $user_id );
wp_set_current_user( $user_id );
wp_set_current_user( self::$admin_id );

Reuse admin that already created in wpSetUpBeforeClass

add_filter( 'wp_client_side_media_processing_enabled', '__return_true' );
add_filter( 'wp_generate_animated_image_subsizes', '__return_true' );

$server = new WP_REST_Server();
$request = new WP_REST_Request( 'GET', '/' );
$index = $server->dispatch( $request );
$data = $index->get_data();

$this->assertTrue( $data['animated_image_subsizes'] );
}

/**
* @ticket 57902
*
Expand Down
1 change: 1 addition & 0 deletions tests/qunit/fixtures/wp-api-generated.js
Original file line number Diff line number Diff line change
Expand Up @@ -13061,6 +13061,7 @@ mockedApiResponse.Schema = {
}
},
"image_size_threshold": 2560,
"animated_image_subsizes": false,
"site_logo": 0,
"site_icon": 0,
"site_icon_url": ""
Expand Down
Loading