Changeset 37915 for trunk/tests/phpunit/tests/post/thumbnails.php

Timestamp:

06/29/2016 05:28:00 PM (5 years ago)

Author:

joemcgill

Message:

Post Thumbnails: Add helper functions for attachment captions.

This adds three new functions for getting/displaying attachment captions:

• wp_get_attachment_caption - Retrieves a caption for a specific attachment.
• get_the_post_thumbnail_caption() - Returns the post thumbnail caption.
• the_post_thumbnail_caption() - Displays the post thumbnail caption.

These are helpful for displaying a caption associated with an image directly
in a template, rather than using the caption shortcode.

This also introduces two new filters:

• wp_get_attachment_caption - Filters the value of wp_get_attachment_caption().
• the_post_thumbnail_caption - Filters the display of the post thumbnail caption.

the_post_thumbnail_caption() is automatically filtered by wptexturize(),
convert_smilies(), and convert_chars() in wp-includes/default-filters.php.

Props flixos90, joemcgill.
Fixes #12235.

File:

• trunk/tests/phpunit/tests/post/thumbnails.php (modified) (1 diff)

trunk/tests/phpunit/tests/post/thumbnails.php

@@ -75 +75 @@
     }
 
+    /**
+     * @ticket 12235
+     */
+    function test_get_the_post_thumbnail_caption() {
+        $this->assertEquals( '', get_the_post_thumbnail_caption() );
+
+        $caption = 'This is a caption.';
+
+        $post_id = self::factory()->post->create();
+        $attachment_id = self::factory()->attachment->create_object( 'image.jpg', $post_id, array(
+            'post_mime_type' => 'image/jpeg',
+            'post_type'      => 'attachment',
+            'post_excerpt'   => $caption,
+        ) );
+
+        set_post_thumbnail( $post_id, $attachment_id );
+
+        $this->assertEquals( $caption, get_the_post_thumbnail_caption( $post_id ) );
+    }
+
+    /**
+     * @ticket 12235
+     */
+    function test_get_the_post_thumbnail_caption_empty() {
+        $post_id = self::factory()->post->create();
+        $attachment_id = self::factory()->attachment->create_object( 'image.jpg', $post_id, array(
+            'post_mime_type' => 'image/jpeg',
+            'post_type'      => 'attachment',
+            'post_excerpt'   => '',
+        ) );
+
+        set_post_thumbnail( $post_id, $attachment_id );
+
+        $this->assertEquals( '', get_the_post_thumbnail_caption( $post_id ) );
+    }
+
+    /**
+     * @ticket 12235
+     */
+    function test_the_post_thumbnail_caption() {
+        $caption = 'This is a caption.';
+
+        $post_id = self::factory()->post->create();
+        $attachment_id = self::factory()->attachment->create_object( 'image.jpg', $post_id, array(
+            'post_mime_type' => 'image/jpeg',
+            'post_type'      => 'attachment',
+            'post_excerpt'   => $caption,
+        ) );
+
+        set_post_thumbnail( $post_id, $attachment_id );
+
+        ob_start();
+        the_post_thumbnail_caption( $post_id );
+
+        $this->assertEquals( $caption, ob_get_clean() );
+    }
+
     function test_get_the_post_thumbnail() {
         $this->assertEquals( '', get_the_post_thumbnail() );