Changeset 60917 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

Timestamp:

10/09/2025 05:21:12 AM (11 months ago)

Author:

ramonopoly

Message:

Attachments REST API endpoint: add support for filtering attachments by multiple media types

This patch enhances the REST API media endpoint to allow filtering by multiple values for the media_type and mime_type parameters. String, comma-separated values and array are supported.

Props abcd95, ramonopoly, andrewserong, mukesh27, adamsilverstein, timothyblynjacobs, swissspidy.

Fixes #63668.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (4 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php

@@ -71 +71 @@
          *
          * @since 4.7.0
+         * @since 6.9.0 Extends the `media_type` and `mime_type` request arguments to support array values.
          *
          * @param array           $prepared_args Optional. Array of prepared arguments. Default empty array.
@@ -83 +84 @@
                 }
 
-                $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['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'];
-                        }
+                $all_mime_types = array();
+                $media_types    = $this->get_media_types();
+
+                if ( ! empty( $request['media_type'] ) && is_array( $request['media_type'] ) ) {
+                        foreach ( $request['media_type'] as $type ) {
+                                if ( isset( $media_types[ $type ] ) ) {
+                                        $all_mime_types = array_merge( $all_mime_types, $media_types[ $type ] );
+                                }
+                        }
+                }
+
+                if ( ! empty( $request['mime_type'] ) && is_array( $request['mime_type'] ) ) {
+                        foreach ( $request['mime_type'] as $mime_type ) {
+                                $parts = explode( '/', $mime_type );
+                                if ( isset( $media_types[ $parts[0] ] ) && in_array( $mime_type, $media_types[ $parts[0] ], true ) ) {
+                                        $all_mime_types[] = $mime_type;
+                                }
+                        }
+                }
+
+                if ( ! empty( $all_mime_types ) ) {
+                        $query_args['post_mime_type'] = array_values( array_unique( $all_mime_types ) );
                 }
 
@@ -1343 +1355 @@
          *
          * @since 4.7.0
+         * @since 6.9.0 Extends the `media_type` and `mime_type` request arguments to support array values.
          *
          * @return array Query parameters for the attachment collection as an array.
@@ -1350 +1363 @@
                 $params['status']['default']       = 'inherit';
                 $params['status']['items']['enum'] = array( 'inherit', 'private', 'trash' );
-                $media_types                       = $this->get_media_types();
+                $media_types                       = array_keys( $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 a particular media type or media types.' ),
+                        'type'        => 'array',
+                        'items'       => array(
+                                'type' => 'string',
+                                'enum' => $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 a particular MIME type or MIME types.' ),
+                        'type'        => 'array',
+                        'items'       => array(
+                                'type' => 'string',
+                        ),
                 );