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

Timestamp:

11/08/2016 04:28:47 AM (10 years ago)

Author:

rmccue

Message:

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 #38679.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-attachments-controller.php (modified) (3 diffs)

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

@@ -248 +248 @@
                 $prepared_attachment = parent::prepare_item_for_database( $request );
 
+                // Attachment caption (post_excerpt internally)
                 if ( isset( $request['caption'] ) ) {
-                        $prepared_attachment->post_excerpt = $request['caption'];
-                }
-
+                        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'] );
+                        }
+                }
+
+                // Attachment description (post_content internally)
                 if ( isset( $request['description'] ) ) {
-                        $prepared_attachment->post_content = $request['description'];
+                        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'] );
+                        }
                 }
 
@@ -277 +287 @@
                 $data = $response->get_data();
 
+                $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,
+                );
+
                 $data['alt_text']      = get_post_meta( $post->ID, '_wp_attachment_image_alt', true );
-                $data['caption']       = $post->post_excerpt;
-                $data['description']   = $post->post_content;
                 $data['media_type']    = wp_attachment_is_image( $post->ID ) ? 'image' : 'file';
                 $data['mime_type']     = $post->post_mime_type;
@@ -367 +388 @@
 
                 $schema['properties']['caption'] = array(
-                        'description'     => __( 'The caption for the resource.' ),
-                        'type'            => 'string',
-                        'context'         => array( 'view', 'edit' ),
-                        'arg_options'     => array(
-                                'sanitize_callback' => 'wp_filter_post_kses',
+                        '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()
                         ),
+                        '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,
+                                ),
+                        ),
                 );
 
                 $schema['properties']['description'] = array(
-                        'description'     => __( 'The description for the resource.' ),
-                        'type'            => 'string',
-                        'context'         => array( 'view', 'edit' ),
-                        'arg_options'     => array(
-                                'sanitize_callback' => 'wp_filter_post_kses',
+                        '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()
+                        ),
+                        '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,
+                                ),
                         ),
                 );