Changeset 37035

Timestamp:

03/18/2016 08:04:19 PM (10 years ago)

Author:

azaozz

Message:

Media: fix erroneously inserting a rel attribute in get_image_send_to_editor(). Reverts most of [34259] and [34260] and adds a unit test.

Props joemcgill, azaozz.
Fixes #36084.

Location:

trunk

Files:

• src/wp-admin/includes/ajax-actions.php (modified) (2 diffs)
• src/wp-admin/includes/media.php (modified) (3 diffs)
• tests/phpunit/tests/media.php (modified) (1 diff)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -2576 +2576 @@
         }
 
-        $rel = '';
         $url = empty( $attachment['url'] ) ? '' : $attachment['url'];
-        if ( strpos( $url, 'attachment_id') || get_attachment_link( $id ) == $url ) {
-                $rel = 'attachment wp-att-' . $id;
-        }
+        $rel = ( strpos( $url, 'attachment_id') || get_attachment_link( $id ) == $url );
 
         remove_filter( 'media_send_to_editor', 'image_media_send_to_editor' );
@@ -2601 +2598 @@
         } else {
                 $html = isset( $attachment['post_title'] ) ? $attachment['post_title'] : '';
+                $rel = $rel ? ' rel="attachment wp-att-' . $id . '"' : ''; // Hard-coded string, $id is already sanitized
+
                 if ( ! empty( $url ) ) {
-                        $html = '<a href="' . esc_url( $url ) . '"' . 'rel="' . esc_attr( $rel ) . '">' . $html . '</a>';
+                        $html = '<a href="' . esc_url( $url ) . '"' . $rel . '">' . $html . '</a>';
                 }
         }

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

@@ -112 +112 @@
  * @param string       $align   Image CSS alignment property.
  * @param string       $url     Optional. Image src URL. Default empty.
- * @param string       $rel     Optional. Image rel attribute. Default empty.
+ * @param bool|string  $rel     Optional. Value for rel attribute or whether to add a dafault value. Default false.
  * @param string|array $size    Optional. Image size. Accepts any valid image size, or an array of width
  *                              and height values in pixels (in that order). Default 'medium'.
@@ -118 +118 @@
  * @return string The HTML output to insert into the editor.
  */
-function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $rel = '', $size = 'medium', $alt = '' ) {
-
-        $html = get_image_tag($id, $alt, '', $align, $size);
-
-        if ( ! $rel ) {
-                $rel = ' rel="attachment wp-att-' . esc_attr( $id ) . '"';
+function get_image_send_to_editor( $id, $caption, $title, $align, $url = '', $rel = false, $size = 'medium', $alt = '' ) {
+
+        $html = get_image_tag( $id, $alt, '', $align, $size );
+
+        if ( $rel ) {
+                if ( is_string( $rel ) ) {
+                        $rel = ' rel="' . esc_attr( $rel ) . '"';
+                } else {
+                        $rel = ' rel="attachment wp-att-' . intval( $id ) . '"';
+                }
         } else {
-                $rel = ' rel="' . esc_attr( $rel ) . '"';
+                $rel = '';
         }
 
         if ( $url )
-                $html = '<a href="' . esc_attr($url) . "\"$rel>$html</a>";
+                $html = '<a href="' . esc_attr( $url ) . '"' . $rel . '>' . $html . '</a>';
 
         /**
@@ -1167 +1171 @@
                 $size = !empty($attachment['image-size']) ? $attachment['image-size'] : 'medium';
                 $alt = !empty($attachment['image_alt']) ? $attachment['image_alt'] : '';
-                $rel = ( $url == get_attachment_link($attachment_id) );
+                $rel = ( strpos( $url, 'attachment_id') || $url === get_attachment_link( $attachment_id ) );
 
                 return get_image_send_to_editor($attachment_id, $attachment['post_excerpt'], $attachment['post_title'], $align, $url, $rel, $size, $alt);

trunk/tests/phpunit/tests/media.php

@@ -1540 +1540 @@
                 $this->assertSame( $expected, $actual );
         }
+
+        /**
+         * @ticket 36084
+         */
+        function test_get_image_send_to_editor_defaults() {
+                $id      = self::$large_id;
+                $caption = '';
+                $title   = 'A test title value.';
+                $align   = 'left';
+
+                // Calculate attachment data (default is medium).
+                $attachment = wp_get_attachment_image_src( $id, 'medium' );
+
+                $html = '<img src="%1$s" alt="" width="%2$d" height="%3$d" class="align%4$s size-medium wp-image-%5$d" />';
+                $expected = sprintf( $html, $attachment[0], $attachment[1], $attachment[2], $align, $id );
+
+                $this->assertSame( $expected, get_image_send_to_editor( $id, $caption, $title, $align ) );
+
+                $this->assertSame( $expected, get_image_send_to_editor( $id, $caption, $title, $align ) );
+        }
+
+        /**
+         * @ticket 36084
+         */
+        function test_get_image_send_to_editor_defaults_with_optional_params() {
+                $id      = self::$large_id;
+                $caption = 'A test caption.';
+                $title   = 'A test title value.';
+                $align   = 'left';
+                $url     = get_permalink( $id );
+                $rel     = true;
+                $size    = 'thumbnail';
+                $alt     = 'An example alt value.';
+
+                // Calculate attachment data.
+                $attachment = wp_get_attachment_image_src( $id, $size );
+
+                $html = '<a href="%1$s" rel="%2$s"><img src="%3$s" alt="%4$s" width="%5$d" height="%6$d" class="size-%8$s wp-image-%9$d" /></a>';
+                $html = '[caption id="attachment_%9$d" align="align%7$s" width="%5$d"]' . $html . ' %10$s[/caption]';
+
+                $expected = sprintf( $html, $url, 'attachment wp-att-' . $id, $attachment[0], $alt, $attachment[1], $attachment[2], $align, $size, $id, $caption );
+
+                $this->assertSame( $expected, get_image_send_to_editor( $id, $caption, $title, $align, $url, $rel, $size, $alt ) );
+        }
+
+        /**
+         * @ticket 36084
+         */
+        function test_get_image_send_to_editor_defaults_no_caption_no_rel() {
+                $id      = self::$large_id;
+                $caption = '';
+                $title   = 'A test title value.';
+                $align   = 'left';
+                $url     = get_permalink( $id );
+                $rel     = '';
+                $size    = 'thumbnail';
+                $alt     = 'An example alt value.';
+
+                // Calculate attachment data.
+                $attachment = wp_get_attachment_image_src( $id, $size );
+
+                $html = '<a href="%1$s"><img src="%2$s" alt="%3$s" width="%4$d" height="%5$d" class="align%6$s size-%7$s wp-image-%8$d" /></a>';
+
+                $expected = sprintf( $html, $url, $attachment[0], $alt, $attachment[1], $attachment[2], $align, $size, $id );
+
+                $this->assertSame( $expected, get_image_send_to_editor( $id, $caption, $title, $align, $url, $rel, $size, $alt ) );
+        }
 }