<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[43862] branches/5.0: REST API: Prevent duplicate firing of `rest(_after)?_insert_attachment` actions.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/43862">43862</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/43862","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>danielbachhuber</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-11-03 14:13:16 +0000 (Sat, 03 Nov 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>REST API: Prevent duplicate firing of `rest(_after)?_insert_attachment` actions.
Props danielbachhuber, peterwilsoncc.
Fixes <a href="https://core.trac.wordpress.org/ticket/45269">#45269</a>.
See <a href="https://core.trac.wordpress.org/ticket/42864">#42864</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches50srcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp">branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php</a></li>
<li><a href="#branches50srcwpincludesrestapiendpointsclasswprestpostscontrollerphp">branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#branches50testsphpunittestsrestapirestattachmentscontrollerphp">branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches50srcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2018-11-03 07:56:28 UTC (rev 43861)
+++ branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2018-11-03 14:13:16 UTC (rev 43862)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -237,9 +237,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment = get_post( $request['id'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php */
- do_action( 'rest_insert_attachment', $data, $request, false );
-
</del><span class="cx" style="display: block; padding: 0 10px"> $fields_update = $this->update_additional_fields_for_object( $attachment, $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $fields_update ) ) {
</span></span></pre></div>
<a id="branches50srcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2018-11-03 07:56:28 UTC (rev 43861)
+++ branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2018-11-03 14:13:16 UTC (rev 43862)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -739,6 +739,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'context', 'edit' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( "rest_after_insert_{$this->post_type}", $post, $request, false );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="branches50testsphpunittestsrestapirestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2018-11-03 07:56:28 UTC (rev 43861)
+++ branches/5.0/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2018-11-03 14:13:16 UTC (rev 43862)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -16,6 +16,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $author_id;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $contributor_id;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $uploader_id;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected static $rest_after_insert_attachment_count;
+ protected static $rest_insert_attachment_count;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass( $factory ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::$superadmin_id = $factory->user->create( array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1306,6 +1308,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unlink( $this->test_file2 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_action( 'rest_insert_attachment', array( $this, 'filter_rest_insert_attachment' ) );
+ remove_action( 'rest_after_insert_attachment', array( $this, 'filter_rest_after_insert_attachment' ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->remove_added_uploads();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1437,4 +1442,67 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_upload_limited_space', $response, 400 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * 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++;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>