Changeset 43862

Timestamp:

11/03/2018 02:13:16 PM (13 months ago)

Author:

danielbachhuber

Message:

REST API: Prevent duplicate firing of rest(_after)?_insert_attachment actions.

Props danielbachhuber, peterwilsoncc.
Fixes #45269.
See #42864.

Location:

branches/5.0

Files:

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

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

@@ -237 +237 @@
 
         $attachment = get_post( $request['id'] );
-
-        /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php */
-        do_action( 'rest_insert_attachment', $data, $request, false );
 
         $fields_update = $this->update_additional_fields_for_object( $attachment, $request );

branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -739 +739 @@
 
         $request->set_param( 'context', 'edit' );
+
+        // Filter is fired in WP_REST_Attachments_Controller subclass.
+        if ( 'attachment' === $this->post_type ) {
+            $response = $this->prepare_item_for_response( $post, $request );
+            return rest_ensure_response( $response );
+        }
 
         /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */

branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php

@@ -17 +17 @@
     protected static $contributor_id;
     protected static $uploader_id;
+    protected static $rest_after_insert_attachment_count;
+    protected static $rest_insert_attachment_count;
 
     public static function wpSetUpBeforeClass( $factory ) {
@@ -1307 +1309 @@
         }
 
+        remove_action( 'rest_insert_attachment', array( $this, 'filter_rest_insert_attachment' ) );
+        remove_action( 'rest_after_insert_attachment', array( $this, 'filter_rest_after_insert_attachment' ) );
+
         $this->remove_added_uploads();
     }
@@ -1438 +1443 @@
     }
 
+    /**
+     * Ensure the `rest_after_insert_attachment` and `rest_insert_attachment` hooks only fire
+     * once when attachments are created.
+     *
+     * @ticket 45269
+     */
+    public function test_rest_insert_attachment_hooks_fire_once_on_create() {
+        self::$rest_insert_attachment_count = 0;
+        self::$rest_after_insert_attachment_count = 0;
+        add_action( 'rest_insert_attachment', array( $this, 'filter_rest_insert_attachment' ) );
+        add_action( 'rest_after_insert_attachment', array( $this, 'filter_rest_after_insert_attachment' ) );
+
+        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_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_body( file_get_contents( $this->test_file ) );
+        $response = $this->server->dispatch( $request );
+        $data = $response->get_data();
+        $this->assertEquals( 201, $response->get_status() );
+
+        $this->assertSame( 1, self::$rest_insert_attachment_count );
+        $this->assertSame( 1, self::$rest_after_insert_attachment_count );
+    }
+
+    /**
+     * Ensure the `rest_after_insert_attachment` and `rest_insert_attachment` hooks only fire
+     * once when attachments are updated.
+     *
+     * @ticket 45269
+     */
+    public function test_rest_insert_attachment_hooks_fire_once_on_update() {
+        self::$rest_insert_attachment_count = 0;
+        self::$rest_after_insert_attachment_count = 0;
+        add_action( 'rest_insert_attachment', array( $this, 'filter_rest_insert_attachment' ) );
+        add_action( 'rest_after_insert_attachment', array( $this, 'filter_rest_after_insert_attachment' ) );
+
+        wp_set_current_user( self::$editor_id );
+        $attachment_id = $this->factory->attachment->create_object( $this->test_file, 0, array(
+            'post_mime_type' => 'image/jpeg',
+            'post_excerpt'   => 'A sample caption',
+            'post_author'    => self::$editor_id,
+        ) );
+        $request = new WP_REST_Request( 'POST', '/wp/v2/media/' . $attachment_id );
+        $request->set_param( 'title', 'My title is very cool' );
+        $response = $this->server->dispatch( $request );
+
+        $this->assertSame( 1, self::$rest_insert_attachment_count );
+        $this->assertSame( 1, self::$rest_after_insert_attachment_count );
+    }
+
+    public function filter_rest_insert_attachment( $attachment ) {
+        self::$rest_insert_attachment_count++;
+    }
+
+    public function filter_rest_after_insert_attachment( $attachment ) {
+        self::$rest_after_insert_attachment_count++;
+    }
 }