Skip to content

REST API: Support multiple media types and MIME types when listing media #9211

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

Closed
himanshupathak95 wants to merge 4 commits into from
Closed

REST API: Support multiple media types and MIME types when listing media #9211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1faea18
Media: support multiple media types and MIME types in attachments query
himanshupathak95 Jul 7, 2025
f242f5e
Tests: Add tests for multiple media types support in attachments query
himanshupathak95 Jul 8, 2025
ff91633
Tests: Add test for multiple MIME types support and combination with …
himanshupathak95 Jul 8, 2025
5fe24dd
Fix linting
himanshupathak95 Jul 8, 2025
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
45 changes: 32 additions & 13 deletions src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,31 @@ protected function prepare_items_query( $prepared_args = array(), $request = nul
$query_args['post_status'] = 'inherit';
}

$media_types = $this->get_media_types();
$all_mime_types = array();
Copy link
Member

@ramonjd ramonjd Sep 30, 2025

Choose a reason for hiding this comment

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

Needs a @since 6.9.0 annotation in the doc block. 🤞🏻 this makes it to 6.9!

E.g., @since 6.9.0 Extends the media_type and mime_type request arguments to support array values.

$media_types = $this->get_media_types();

if ( ! empty( $request['media_type'] ) && isset( $media_types[ $request['media_type'] ] ) ) {
$query_args['post_mime_type'] = $media_types[ $request['media_type'] ];
if ( ! empty( $request['media_type'] ) ) {
$media_type_input = is_array( $request['media_type'] )
? $request['media_type']
: explode( ',', $request['media_type'] );

foreach ( array_map( 'trim', $media_type_input ) as $type ) {
if ( isset( $media_types[ $type ] ) ) {
$all_mime_types = array_merge( $all_mime_types, $media_types[ $type ] );
}
}
}

if ( ! empty( $request['mime_type'] ) ) {
$parts = explode( '/', $request['mime_type'] );
if ( isset( $media_types[ $parts[0] ] ) && in_array( $request['mime_type'], $media_types[ $parts[0] ], true ) ) {
$query_args['post_mime_type'] = $request['mime_type'];
}
$mime_type_input = is_array( $request['mime_type'] )
? $request['mime_type']
: explode( ',', $request['mime_type'] );

$all_mime_types = array_merge( $all_mime_types, array_map( 'trim', $mime_type_input ) );
Comment on lines +101 to +105
Copy link
Member

@ramonjd ramonjd Sep 30, 2025

Choose a reason for hiding this comment

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

Do we still need the former check to see if the mime type prefix part is available in $media_types?

}

if ( ! empty( $all_mime_types ) ) {
$query_args['post_mime_type'] = array_values( array_unique( $all_mime_types ) );
}

// Filter query clauses to include filenames.
Expand Down Expand Up @@ -1285,19 +1299,24 @@ public function get_collection_params() {
$params = parent::get_collection_params();
$params['status']['default'] = 'inherit';
$params['status']['items']['enum'] = array( 'inherit', 'private', 'trash' );
$media_types = $this->get_media_types();

$params['media_type'] = array(
'default' => null,
'description' => __( 'Limit result set to attachments of a particular media type.' ),
'type' => 'string',
'enum' => array_keys( $media_types ),
'description' => __( 'Limit result set to attachments of particular media types.' ),
Copy link
Member

@ramonjd ramonjd Sep 30, 2025

Choose a reason for hiding this comment

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

Similar to above, this method's docblock needs an annotation:

'type' => array( 'string', 'array' ),
'items' => array(
'type' => 'string',
'enum' => array_keys( $this->get_media_types() ),
),
);

$params['mime_type'] = array(
'default' => null,
'description' => __( 'Limit result set to attachments of a particular MIME type.' ),
'type' => 'string',
'description' => __( 'Limit result set to attachments of particular MIME types.' ),
'type' => array( 'string', 'array' ),
'items' => array(
'type' => 'string',
),
);

return $params;
Expand Down
149 changes: 148 additions & 1 deletion tests/phpunit/tests/rest-api/rest-attachments-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ public function test_registered_query_params() {
'audio',
'text',
);
$this->assertSameSets( $media_types, $data['endpoints'][0]['args']['media_type']['enum'] );
$this->assertSameSets( $media_types, $data['endpoints'][0]['args']['media_type']['items']['enum'] );
}

public function test_registered_get_item_params() {
Expand Down Expand Up @@ -441,6 +441,153 @@ public function test_get_items_mime_type() {
$this->assertSame( $id1, $data[0]['id'] );
}

/**
* Test multiple media types support with various input formats.
*
* @ticket 63668
*/
public function test_get_items_multiple_media_types() {
$image_id = self::factory()->attachment->create_object(
self::$test_file,
0,
array(
'post_mime_type' => 'image/jpeg',
)
);

$video_id = self::factory()->attachment->create_object(
self::$test_file,
0,
array(
'post_mime_type' => 'video/mp4',
)
);

$audio_id = self::factory()->attachment->create_object(
self::$test_file,
0,
array(
'post_mime_type' => 'audio/mpeg',
)
);

$request = new WP_REST_Request( 'GET', '/wp/v2/media' );

// Test single media type
$request->set_param( 'media_type', 'image' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( 1, $data );
$this->assertSame( $image_id, $data[0]['id'] );

// Test multiple media types with comma-separated string
$request->set_param( 'media_type', 'image,video' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( 2, $data );
$ids = wp_list_pluck( $data, 'id' );
$this->assertContains( $image_id, $ids );
$this->assertContains( $video_id, $ids );
$this->assertNotContains( $audio_id, $ids );

// Test multiple media types with array format
$request->set_param( 'media_type', array( 'image', 'video', 'audio' ) );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( 3, $data );
$ids = wp_list_pluck( $data, 'id' );
$this->assertContains( $image_id, $ids );
$this->assertContains( $video_id, $ids );
$this->assertContains( $audio_id, $ids );

// Test invalid media type mixed with valid ones
$request->set_param( 'media_type', 'image,invalid,video' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( 2, $data );
$ids = wp_list_pluck( $data, 'id' );
$this->assertContains( $image_id, $ids );
$this->assertContains( $video_id, $ids );
}

/**
* Test multiple MIME types support and combination with media types.
*
* @ticket 63668
*/
public function test_get_items_multiple_mime_types_and_combination() {
$jpeg_id = self::factory()->attachment->create_object(
self::$test_file,
0,
array(
'post_mime_type' => 'image/jpeg',
)
);

$png_id = self::factory()->attachment->create_object(
self::$test_file2,
0,
array(
'post_mime_type' => 'image/png',
)
);

$mp4_id = self::factory()->attachment->create_object(
self::$test_file,
0,
array(
'post_mime_type' => 'video/mp4',
)
);

$pdf_id = self::factory()->attachment->create_object(
self::$test_file,
0,
array(
'post_mime_type' => 'application/pdf',
)
);

$request = new WP_REST_Request( 'GET', '/wp/v2/media' );

// Test single MIME type
$request->set_param( 'mime_type', 'image/jpeg' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( 1, $data );
$this->assertSame( $jpeg_id, $data[0]['id'] );

// Test multiple MIME types with comma-separated string
$request->set_param( 'mime_type', 'image/jpeg,image/png' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( 2, $data );
$ids = wp_list_pluck( $data, 'id' );
$this->assertContains( $jpeg_id, $ids );
$this->assertContains( $png_id, $ids );

// Test multiple MIME types with array format
$request->set_param( 'mime_type', array( 'image/jpeg', 'video/mp4' ) );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( 2, $data );
$ids = wp_list_pluck( $data, 'id' );
$this->assertContains( $jpeg_id, $ids );
$this->assertContains( $mp4_id, $ids );

// Test multiple media types with multiple MIME types
$request->set_param( 'media_type', 'image,video' );
$request->set_param( 'mime_type', 'application/pdf' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$this->assertCount( 4, $data );
$ids = wp_list_pluck( $data, 'id' );
$this->assertContains( $jpeg_id, $ids );
$this->assertContains( $png_id, $ids );
$this->assertContains( $mp4_id, $ids );
$this->assertContains( $pdf_id, $ids );
}

public function test_get_items_parent() {
$post_id = self::factory()->post->create( array( 'post_title' => 'Test Post' ) );
$attachment_id = self::factory()->attachment->create_object(
Expand Down
Loading