About this plugin
This plugin provides a powerful widget, shortcode (with shortcode builder tool), and template tags for easily retrieving and displaying custom field values for posts or pages.
The power of custom fields gives this plugin the potential to be dozens of plugins all rolled into one.
This plugin allows you to harness the power of custom fields/meta data. Use the “Get Custom Field” widget, the [custom_field] shortcode (which has a post editor sidebar widget to help you build the shortcode), or one of six template tags to retrieve and display custom fields. Find a custom field for the current post, a specified post, a recent post, or randomly.
And for the custom field values found by the plugin, you may optionally specify text or HTML to appear before and after the results. If nothing is found, then nothing is display (unless you define text to appear when no results are found). If multiple results are found, only the first will be displayed unless you specify a string to be used to join the results together (such as “,”), in which case all will be returned.
Visit the Examples section to see how this plugin can be cast in dozens of different ways.
There are six template tags provided by this plugin. Here they are, with an explanation of when they are appropriate for use:
- c2c_get_custom(): Use this inside “the loop” to retrieve a custom field value for a post
- c2c_get_current_custom(): This is only available on the permalink post template (single.php) and page template (page.php). Can be used inside or outside “the loop”. Useful for using custom field to define text you want to include on a post or page’s header, footer, or sidebar.
- c2c_get_post_custom(): Useful when you know the ID of the post whose custom field value you want.
- c2c_get_random_custom(): Retrieve the value of a random instance of the specified custom field key, as long as the field is associated with a published posted, non-passworded post (you can modify a setting in the plugin file to search passworded posts as well).
- c2c_get_random_post_custom(): Retrieves the value of random custom field(s) from a post when you know the ID of the post you’re interested in.
- c2c_get_recent_custom(): Retrieves the most recent (according to the associated post’s publish date) value of the specified custom field.
You can filter the custom field values that the plugin would display. Add filters for ‘ the_meta ‘ to filter custom field data (see the end of the code file for commented out samples you may wish to include). You can also add per-meta filters by hooking ‘ the_meta_$sanitized_field ‘.
$sanitized_field is a clean version of the value of $field where everything but alphanumeric and underscore characters have been removed. So to filter the value of the “Related Posts” custom field, you would need to add a filter for ‘ the_meta_RelatedPosts ‘.
Links: Plugin Homepage | Plugin Directory Page | GitHub | Author Homepage
Developer Documentation
md. That documentation covers the numerous template tags, hooks, and shortcode provided by the plugin.
As an overview, these are the template tags provided the plugin:
- c2c_get_custom(): Template tag for use inside “the loop” and applies to the currently listed post.
- c2c_get_current_custom(): Template tag for use on permalink (aka single) page templates for posts and pages.
- c2c_get_post_custom(): Template tag for use when you know the ID of the post you’re interested in.
- c2c_get_random_custom(): Template tag for use to retrieve a random custom field value.
- c2c_get_random_post_custom(): Template tag for use to retrieve random custom field value(s) from a post when you know the ID of the post you’re interested in.
- c2c_get_recent_custom(): Template tag for use outside “the loop” and applies for custom fields regardless of post.
These are the hooks provided by the plugin:
- c2c_get_custom_field_values_shortcode: Filter to customize the name of the plugin’s shortcode.
- c2c_get_custom_field_values_post_types: Filter to customize the post types that should support the shortcode builder metabox.
- get_custom_field_values/can_author_use_shortcodes: Filter to customize if post author can make use of the ‘custom_field’ shortcode.
- get_custom_field_values/show_metabox: Filter to customize if the shortcode builder metabox is shown.
The shortcode provided is [custom-field], which has a number of attributes to customize its behavior and output.