Changeset 37915 for trunk/src/wp-includes/default-filters.php

Timestamp:

06/29/2016 05:28:00 PM (9 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/src/wp-includes/default-filters.php (modified) (1 diff)

trunk/src/wp-includes/default-filters.php

@@ -143 +143 @@
 add_filter( 'the_excerpt',     'shortcode_unautop');
 add_filter( 'get_the_excerpt', 'wp_trim_excerpt'  );
+
+add_filter( 'the_post_thumbnail_caption', 'wptexturize'     );
+add_filter( 'the_post_thumbnail_caption', 'convert_smilies' );
+add_filter( 'the_post_thumbnail_caption', 'convert_chars'   );
 
 add_filter( 'comment_text', 'wptexturize'            );