Changeset 58447

Timestamp:

06/20/2024 04:02:10 PM (4 months ago)

Author:

adamsilverstein

Message:

Media: improve titles when inserting via REST API.

Match the naming behavior for uploaded media in the REST API to the way media is named when uploading in the media library. Fix an issue where dashes were replacing spaces unnecessarily.

Props abitofmind, kadamwhite, spacedmonkey, adamsilverstein, audrasjb, hellofromTonya.
Fixes #57957.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-attachments-controller.php (modified) (1 diff)

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

@@ -305 +305 @@
         $attachment->guid           = $url;
 
+        // If the title was not set, use the original filename.
+        if ( empty( $attachment->post_title ) && ! empty( $files['file']['name'] ) ) {
+            // Remove the file extension (after the last `.`)
+            $tmp_title = substr( $files['file']['name'], 0, strrpos( $files['file']['name'], '.' ) );
+
+            if ( ! empty( $tmp_title ) ) {
+                $attachment->post_title = $tmp_title;
+            }
+        }
+
+        // Fall back to the original approach.
         if ( empty( $attachment->post_title ) ) {
             $attachment->post_title = preg_replace( '/\.[^.]+$/', '', wp_basename( $file ) );

trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php

@@ -2016 +2016 @@
 
     /**
+     * Tests that the naming behavior of REST media uploads matches core media uploads.
+     *
+     * In particular, filenames with spaces should maintain the spaces rather than
+     * replacing them with hyphens.
+     *
+     * @ticket 57957
+     *
+     * @covers WP_REST_Attachments_Controller::insert_attachment
+     * @dataProvider rest_upload_filename_spaces
+     */
+    public function test_rest_upload_filename_spaces( $filename, $expected ) {
+        wp_set_current_user( self::$editor_id );
+        $request = new WP_REST_Request( 'POST', '/wp/v2/media' );
+        $request->set_header( 'Content-Type', 'image/jpeg' );
+        $request->set_body( file_get_contents( self::$test_file ) );
+        $request->set_file_params(
+            array(
+                'file' => array(
+                    'file'     => file_get_contents( self::$test_file2 ),
+                    'name'     => $filename,
+                    'size'     => filesize( self::$test_file2 ),
+                    'tmp_name' => self::$test_file2,
+                ),
+            )
+        );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+        $this->assertSame( 201, $response->get_status(), 'The file was not uploaded.' );
+        $this->assertSame( $expected, $data['title']['raw'], 'An incorrect filename was returned.' );
+    }
+
+    /**
+     * Data provider for text_rest_upload_filename_spaces.
+     *
+     * @return array
+     */
+    public function rest_upload_filename_spaces() {
+        return array(
+            'filename with spaces'  => array(
+                'Filename With Spaces.jpg',
+                'Filename With Spaces',
+            ),
+            'filename.with.periods' => array(
+                'Filename.With.Periods.jpg',
+                'Filename.With.Periods',
+            ),
+            'filename-with-dashes'  => array(
+                'Filename-With-Dashes.jpg',
+                'Filename-With-Dashes',
+            ),
+        );
+    }
+
+    /**
      * Ensure the `rest_after_insert_attachment` and `rest_insert_attachment` hooks only fire
      * once when attachments are updated.