<!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>[39154] trunk: REST API: Change attachment caption & description to objects.</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 { 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/39154">39154</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/39154","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rmccue</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-11-08 04:28:47 +0000 (Tue, 08 Nov 2016)</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: Change attachment caption & description to objects.
Just like excerpt and content for regular posts, these have transformations applied that can make the content significantly different from the raw value.
Props jnylen0.
Fixes <a href="https://core.trac.wordpress.org/ticket/38679">#38679</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestattachmentscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/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">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2016-11-07 21:46:43 UTC (rev 39153)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php 2016-11-08 04:28:47 UTC (rev 39154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -247,12 +247,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected function prepare_item_for_database( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_attachment = parent::prepare_item_for_database( $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Attachment caption (post_excerpt internally)
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['caption'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_attachment->post_excerpt = $request['caption'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_string( $request['caption'] ) ) {
+ $prepared_attachment->post_excerpt = wp_filter_post_kses( $request['caption'] );
+ } elseif ( isset( $request['caption']['raw'] ) ) {
+ $prepared_attachment->post_excerpt = wp_filter_post_kses( $request['caption']['raw'] );
+ }
</ins><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">+ // Attachment description (post_content internally)
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['description'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $prepared_attachment->post_content = $request['description'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( is_string( $request['description'] ) ) {
+ $prepared_attachment->post_content = wp_filter_post_kses( $request['description'] );
+ } elseif ( isset( $request['description']['raw'] ) ) {
+ $prepared_attachment->post_content = wp_filter_post_kses( $request['description']['raw'] );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['post'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -276,9 +286,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = parent::prepare_item_for_response( $post, $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data['description'] = array(
+ 'raw' => $post->post_content,
+ /** This filter is documented in wp-includes/post-template.php */
+ 'rendered' => apply_filters( 'the_content', $post->post_content ),
+ );
+
+ /** This filter is documented in wp-includes/post-template.php */
+ $caption = apply_filters( 'the_excerpt', apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ) );
+ $data['caption'] = array(
+ 'raw' => $post->post_excerpt,
+ 'rendered' => $caption,
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $data['alt_text'] = get_post_meta( $post->ID, '_wp_attachment_image_alt', true );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data['caption'] = $post->post_excerpt;
- $data['description'] = $post->post_content;
</del><span class="cx" style="display: block; padding: 0 10px"> $data['media_type'] = wp_attachment_is_image( $post->ID ) ? 'image' : 'file';
</span><span class="cx" style="display: block; padding: 0 10px"> $data['mime_type'] = $post->post_mime_type;
</span><span class="cx" style="display: block; padding: 0 10px"> $data['media_details'] = wp_get_attachment_metadata( $post->ID );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -366,21 +387,47 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $schema['properties']['caption'] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'description' => __( 'The caption for the resource.' ),
- 'type' => 'string',
- 'context' => array( 'view', 'edit' ),
- 'arg_options' => array(
- 'sanitize_callback' => 'wp_filter_post_kses',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'description' => __( 'The caption for the resource.' ),
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'arg_options' => array(
+ 'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'properties' => array(
+ 'raw' => array(
+ 'description' => __( 'Caption for the resource, as it exists in the database.' ),
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ 'rendered' => array(
+ 'description' => __( 'HTML caption for the resource, transformed for display.' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit', 'embed' ),
+ 'readonly' => true,
+ ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $schema['properties']['description'] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'description' => __( 'The description for the resource.' ),
- 'type' => 'string',
- 'context' => array( 'view', 'edit' ),
- 'arg_options' => array(
- 'sanitize_callback' => 'wp_filter_post_kses',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'description' => __( 'The description for the resource.' ),
+ 'type' => 'object',
+ 'context' => array( 'view', 'edit' ),
+ 'arg_options' => array(
+ 'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'properties' => array(
+ 'raw' => array(
+ 'description' => __( 'Description for the object, as it exists in the database.' ),
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ 'rendered' => array(
+ 'description' => __( 'HTML description for the object, transformed for display.' ),
+ 'type' => 'string',
+ 'context' => array( 'view', 'edit' ),
+ 'readonly' => true,
+ ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $schema['properties']['media_type'] = array(
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestattachmentscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/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">--- trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2016-11-07 21:46:43 UTC (rev 39153)
+++ trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php 2016-11-08 04:28:47 UTC (rev 39154)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -460,14 +460,31 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_create_item() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( self::$author_id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'POST', '/wp/v2/media' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_header( 'Content-Type', 'image/jpeg' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_header( 'Content-Disposition', 'attachment; filename=canola.jpg' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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.' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $request->set_body( file_get_contents( $this->test_file ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 201, $response->get_status() );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'image', $data['media_type'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $attachment = get_post( $data['id'] );
+ $this->assertEquals( 'My title is very cool', $data['title']['raw'] );
+ $this->assertEquals( 'My title is very cool', $attachment->post_title );
+ $this->assertEquals( 'This is a better caption.', $data['caption']['raw'] );
+ $this->assertEquals( 'This is a better caption.', $attachment->post_excerpt );
+ $this->assertEquals( 'Without a description, my attachment is descriptionless.', $data['description']['raw'] );
+ $this->assertEquals( 'Without a description, my attachment is descriptionless.', $attachment->post_content );
+ $this->assertEquals( 'Alt text is stored outside post schema.', $data['alt_text'] );
+ $this->assertEquals( 'Alt text is stored outside post schema.', get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_create_item_default_filename_title() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -650,9 +667,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $attachment = get_post( $data['id'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'My title is very cool', $data['title']['raw'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'My title is very cool', $attachment->post_title );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 'This is a better caption.', $data['caption'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 'This is a better caption.', $data['caption']['raw'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'This is a better caption.', $attachment->post_excerpt );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 'Without a description, my attachment is descriptionless.', $data['description'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 'Without a description, my attachment is descriptionless.', $data['description']['raw'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Without a description, my attachment is descriptionless.', $attachment->post_content );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Alt text is stored outside post schema.', $data['alt_text'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Alt text is stored outside post schema.', get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -775,7 +792,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'author', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'alt_text', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'caption', $properties );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'raw', $properties['caption']['properties'] );
+ $this->assertArrayHasKey( 'rendered', $properties['caption']['properties'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'description', $properties );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'raw', $properties['description']['properties'] );
+ $this->assertArrayHasKey( 'rendered', $properties['description']['properties'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'comment_status', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'date', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'date_gmt', $properties );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -794,6 +815,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'slug', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'source_url', $properties );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'title', $properties );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayHasKey( 'raw', $properties['title']['properties'] );
+ $this->assertArrayHasKey( 'rendered', $properties['title']['properties'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'type', $properties );
</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">@@ -891,9 +914,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_post_data( $attachment, $data, $context = 'view', $links ) {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::check_post_data( $attachment, $data, $context, $links );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertArrayNotHasKey( 'content', $data );
+ $this->assertArrayNotHasKey( 'excerpt', $data );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ), $data['alt_text'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $attachment->post_excerpt, $data['caption'] );
- $this->assertEquals( $attachment->post_content, $data['description'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'edit' === $context ) {
+ $this->assertEquals( $attachment->post_excerpt, $data['caption']['raw'] );
+ $this->assertEquals( $attachment->post_content, $data['description']['raw'] );
+ } else {
+ $this->assertFalse( isset( $data['caption']['raw'] ) );
+ $this->assertFalse( isset( $data['description']['raw'] ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( isset( $data['media_details'] ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $attachment->post_parent ) {
</span></span></pre>
</div>
</div>
</body>
</html>