Changeset 58130

Timestamp:

05/10/2024 06:57:53 PM (5 months ago)

Author:

swissspidy

Message:

REST API: Ensure attachments are uploaded to the post's year/month folder.

If organizing uploads into month- and year-based folders, uploading an attachment to an existing post should store the file in wp-content/uploads/<year>/<month> based on the post's publish date. This is in line with the behavior in classic editor / the media modal.

Props swissspidy, adamsilverstein, timothyblynjacobs, skithund, sergeybiryukov, patricia70.
Fixes #61189.

Location:

trunk

Files:

• src/wp-admin/includes/file.php (modified) (2 diffs)
• src/wp-includes/functions.php (modified) (3 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (5 diffs)
• tests/phpunit/tests/rest-api/rest-attachments-controller.php (modified) (1 diff)

trunk/src/wp-admin/includes/file.php

@@ -1090 +1090 @@
  *                               to override default variables. Default false.
  *                               See _wp_handle_upload() for accepted values.
- * @param string      $time      Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
  * @return array See _wp_handle_upload() for return value.
  */
@@ -1121 +1121 @@
  *                               to override default variables. Default false.
  *                               See _wp_handle_upload() for accepted values.
- * @param string      $time      Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @param string|null $time      Optional. Time formatted in 'yyyy/mm'. Default null.
  * @return array See _wp_handle_upload() for return value.
  */

trunk/src/wp-includes/functions.php

@@ -2345 +2345 @@
  * @uses _wp_upload_dir()
  *
- * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
- * @param bool   $create_dir Optional. Whether to check and create the uploads directory.
- *                           Default true for backward compatibility.
- * @param bool   $refresh_cache Optional. Whether to refresh the cache. Default false.
+ * @param string|null $time          Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @param bool        $create_dir    Optional. Whether to check and create the uploads directory.
+ *                                   Default true for backward compatibility.
+ * @param bool        $refresh_cache Optional. Whether to refresh the cache. Default false.
  * @return array {
  *     Array of information about the upload directory.
@@ -2420 +2420 @@
  * @access private
  *
- * @param string $time Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @param string|null $time Optional. Time formatted in 'yyyy/mm'. Default null.
  * @return array See wp_upload_dir()
  */
@@ -2872 +2872 @@
  * @param null|string $deprecated Never used. Set to null.
  * @param string      $bits       File content
- * @param string      $time       Optional. Time formatted in 'yyyy/mm'. Default null.
+ * @param string|null $time       Optional. Time formatted in 'yyyy/mm'. Default null.
  * @return array {
  *     Information about the newly-uploaded file.

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

@@ -255 +255 @@
         $headers = $request->get_headers();
 
+        $time = null;
+
+        // Matches logic in media_handle_upload().
+        if ( ! empty( $request['post'] ) ) {
+            $post = get_post( $request['post'] );
+            // The post date doesn't usually matter for pages, so don't backdate this upload.
+            if ( $post && 'page' !== $post->post_type && substr( $post->post_date, 0, 4 ) > 0 ) {
+                $time = $post->post_date;
+            }
+        }
+
         if ( ! empty( $files ) ) {
-            $file = $this->upload_from_file( $files, $headers );
+            $file = $this->upload_from_file( $files, $headers, $time );
         } else {
-            $file = $this->upload_from_data( $request->get_body(), $headers );
+            $file = $this->upload_from_data( $request->get_body(), $headers, $time );
         }
 
@@ -1036 +1047 @@
      *
      * @since 4.7.0
-     *
-     * @param string $data    Supplied file data.
-     * @param array  $headers HTTP headers from the request.
+     * @since 6.6.0 Added the `$time` parameter.
+     *
+     * @param string      $data    Supplied file data.
+     * @param array       $headers HTTP headers from the request.
+     * @param string|null $time    Optional. Time formatted in 'yyyy/mm'. Default null.
      * @return array|WP_Error Data from wp_handle_sideload().
      */
-    protected function upload_from_data( $data, $headers ) {
+    protected function upload_from_data( $data, $headers, $time = null ) {
         if ( empty( $data ) ) {
             return new WP_Error(
@@ -1129 +1142 @@
         );
 
-        $sideloaded = wp_handle_sideload( $file_data, $overrides );
+        $sideloaded = wp_handle_sideload( $file_data, $overrides, $time );
 
         if ( isset( $sideloaded['error'] ) ) {
@@ -1247 +1260 @@
      *
      * @since 4.7.0
-     *
-     * @param array $files   Data from the `$_FILES` superglobal.
-     * @param array $headers HTTP headers from the request.
+     * @since 6.6.0 Added the `$time` parameter.
+     *
+     * @param array       $files   Data from the `$_FILES` superglobal.
+     * @param array       $headers HTTP headers from the request.
+     * @param string|null $time    Optional. Time formatted in 'yyyy/mm'. Default null.
      * @return array|WP_Error Data from wp_handle_upload().
      */
-    protected function upload_from_file( $files, $headers ) {
+    protected function upload_from_file( $files, $headers, $time = null ) {
         if ( empty( $files ) ) {
             return new WP_Error(
@@ -1294 +1309 @@
         require_once ABSPATH . 'wp-admin/includes/file.php';
 
-        $file = wp_handle_upload( $files['file'], $overrides );
+        $file = wp_handle_upload( $files['file'], $overrides, $time );
 
         if ( isset( $file['error'] ) ) {

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

@@ -2076 +2076 @@
     }
 
+    /**
+     * @ticket 61189
+     * @requires function imagejpeg
+     */
+    public function test_create_item_year_month_based_folders() {
+        update_option( 'uploads_use_yearmonth_folders', 1 );
+
+        wp_set_current_user( self::$editor_id );
+
+        $published_post = self::factory()->post->create(
+            array(
+                'post_status'   => 'publish',
+                'post_date'     => '2017-02-14 00:00:00',
+                'post_date_gmt' => '2017-02-14 00:00:00',
+            )
+        );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/media' );
+        $request->set_header( 'Content-Type', 'image/jpeg' );
+        $request->set_header( 'Content-Disposition', 'attachment; filename=canola.jpg' );
+        $request->set_param( 'title', 'My title is very cool' );
+        $request->set_param( 'caption', 'This is a better caption.' );
+        $request->set_param( 'description', 'Without a description, my attachment is descriptionless.' );
+        $request->set_param( 'alt_text', 'Alt text is stored outside post schema.' );
+        $request->set_param( 'post', $published_post );
+
+        $request->set_body( file_get_contents( self::$test_file ) );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+
+        update_option( 'uploads_use_yearmonth_folders', 0 );
+
+        $this->assertSame( 201, $response->get_status() );
+
+        $attachment = get_post( $data['id'] );
+
+        $this->assertSame( $attachment->post_parent, $data['post'] );
+        $this->assertSame( $attachment->post_parent, $published_post );
+        $this->assertSame( wp_get_attachment_url( $attachment->ID ), $data['source_url'] );
+        $this->assertStringContainsString( '2017/02', $data['source_url'] );
+    }
+
+
+    /**
+     * @ticket 61189
+     * @requires function imagejpeg
+     */
+    public function test_create_item_year_month_based_folders_page_post_type() {
+        update_option( 'uploads_use_yearmonth_folders', 1 );
+
+        wp_set_current_user( self::$editor_id );
+
+        $published_post = self::factory()->post->create(
+            array(
+                'post_type'     => 'page',
+                'post_status'   => 'publish',
+                'post_date'     => '2017-02-14 00:00:00',
+                'post_date_gmt' => '2017-02-14 00:00:00',
+            )
+        );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/media' );
+        $request->set_header( 'Content-Type', 'image/jpeg' );
+        $request->set_header( 'Content-Disposition', 'attachment; filename=canola.jpg' );
+        $request->set_param( 'title', 'My title is very cool' );
+        $request->set_param( 'caption', 'This is a better caption.' );
+        $request->set_param( 'description', 'Without a description, my attachment is descriptionless.' );
+        $request->set_param( 'alt_text', 'Alt text is stored outside post schema.' );
+        $request->set_param( 'post', $published_post );
+
+        $request->set_body( file_get_contents( self::$test_file ) );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+
+        update_option( 'uploads_use_yearmonth_folders', 0 );
+
+        $time   = current_time( 'mysql' );
+        $y      = substr( $time, 0, 4 );
+        $m      = substr( $time, 5, 2 );
+        $subdir = "/$y/$m";
+
+        $this->assertSame( 201, $response->get_status() );
+
+        $attachment = get_post( $data['id'] );
+
+        $this->assertSame( $attachment->post_parent, $data['post'] );
+        $this->assertSame( $attachment->post_parent, $published_post );
+        $this->assertSame( wp_get_attachment_url( $attachment->ID ), $data['source_url'] );
+        $this->assertStringNotContainsString( '2017/02', $data['source_url'] );
+        $this->assertStringContainsString( $subdir, $data['source_url'] );
+    }
+
     public function filter_rest_insert_attachment( $attachment ) {
         ++self::$rest_insert_attachment_count;