Featured Image Caption makes it simple to show a caption with the featured image of a post or page. It works seamlessly with most themes, with no coding required. If you like to mess about in the code, it supports that too.
- Upload the
featured-image-captiondirectory to your site’s
- Activate the plugin through the
Pluginsmenu in WordPress.
- Review the plugin options found in
Featured Image Caption.
Where do I find the documentation for this plugin?
Documentation is maintained on the plugin’s GitHub wiki. I don’t want to maintain two separate sets of documentation and run the risk of conflicting/outdated information, and all of the plugin development happens on GitHub.
Contributors & Developers
“Featured Image Caption” is open source software. The following people have contributed to this plugin.Contributors
Interested in development?
- Tested up to WordPress 5.7.
- Fix how the plugin checks that PHP is a compatible version.
- Replace the Composer autoloader with an inline autoloader, to reduce plugin size and improve performance.
- Fix an error caused by a relative include path.
- Fix an error thrown due to a deprecated function call for the WP REST API.
- Fix an issue with empty caption data causing
Undefined Indexerrors for the REST API.
- Fix a bug with the REST API throwing errors for posts with no caption data.
- Add support for the WordPress REST API. The caption fields are added as properties in the
postsresponse. See plugin documentation for the REST API for usage information.
- When automatic caption appending is enabled, the plugin can optionally only append the caption when viewing a single post.
- Improved validation of supported PHP version. If PHP is too old, the plugin is deactivated and a warning is displayed.
- Bug fixes and improvements.
Restricts the automatic caption insertion to only occur in The Loop.
- Changes the name of the shortcode from
ccfic. This was done for a few reasons. First, WordPress documentation advises against hyphens in shortcode names, so in order to follow best practices the hyphens have been removed. Second, it’s easier to type the abbreviation when using the shortcode. Please note, the old shortcode name still works for now, but you should expect that it will be removed entirely by the time this plugin reaches its 1.0.0 release. As such, please update all the locations that you use the shortcode. Please see the shortcode documentation for usage information.
- Fixes the activation process so that initial configuration is saved properly in the database.
Fixes a bug in upgrading plugin options.
Fixes missing dependency.
Fixes bug in handling HTML tags in caption data that was introduced in the last release. Bug fixes related to activation.
Adds support for HTML tags to be used in caption and source text. HTML tags are filtered, and only tags allowed in post content are allowed in caption and source text.
Fixes issue with incorrectly escaped characters for the meta box fields.
Fixes a bug introduced in 0.6.0 in the theme function.
A shortcode has been added for easy insertion of caption information into a post or page. Debugging information is now displayed on the plugin settings page. Minor bug fixes.
** Major Release / Breaking Changes **
Plugin can automatically add the caption after the featured image, removing the need to modify theme files. If you are upgrading from a previous option this will be disabled by default, otherwise it is enabled by default. Theme function
cc_featured_image_caption() is not needed if you have automatic caption insertion turned on. If this option is enabled, the function won’t display anything. You can, however, still use it to
return the caption data. CSS classes have changed. See the FAQ for information about the new markup and CSS classes.
- Added the option to have the source link open in a new window. This option is on a post-by-post basis. Thanks to avluis for the suggestion.
- Every time you save a post, the “new window” setting is saved to your user options as the default for your user for that setting.
- Restructured the plugin to improve performance.
- Fixed a bug with nonce verification when saving the caption data.
Added support for custom post types. Thanks to anlutro for the contribution.
Removed image source attribution pre-text.
Only display caption text data if it has been set.
Dedicated fields for image source attribution. When formatted text is requested, the source information has its own CSS class.
- SYNTAX CHANGE: The theme function
cc_featured_image_caption()no longer needs to be used with
echobut instead defaults to echo. If you’d like to return the result, add
falseas an argument for the function like so:
cc_featured_image_caption( false );
- Allow HTML tags in the caption. Only permits tags that WordPress allows in post content.
- A new function has been added to check whether a caption is set for the post. Use the function
trueif a caption is set, and
falseif a caption is not set.
Theme function checks whether the caption data returned to it is false. If false, the theme function also returns false. If not false, the theme function returns a formatted caption string.
Fixed bug in declaring
<span> around the rendered caption to allow for CSS formatting.