coffee2code

Extended Description

Installation

Tips & Examples

• With this simple invocation, you can echo the value of any metadata field (where, of course, ‘mymood’ is the custom field key of interest):

  <?php echo c2c_get_custom('mymood'); ?>

• Want the behavior of a moods plugins?
  <?php echo c2c_get_custom('mood', '(Current mood : ', ')'); ?>

  Example results:
  [if 'mood' is set to 'happy!'] (Current mood: happy!)
  (add filters if you wish to use smilies, etc)

• <?php echo c2c_get_recent_custom('mymood', 'Most recent mood: '); ?>
• Want the behavior of a currently reading/currently listening to plugin?

  <?php echo c2c_get_custom('reading', 'Currently reading :'); ?>

  [if value for 'reading' is 'Cujo'] Currently reading: Cujo

  <?php echo c2c_get_custom('reading', 'Currently reading: <i>', '</i>', '', '</i>, <i>'); ?>

  [if three 'reading' fields were defined, with values 'Carrie', 'Cujo', and 'The Shining']
  Currently reading: Carrie, Cujo, The Shining

  <?php echo c2c_get_custom('listening', 'Now playing ', ' on my stereo.', 'nothing'); ?>

  [if value for 'listening' is 'The Beatles'] Now playing The Beatles on my stereo.
  [if no value defined for 'listening'] Now playing nothing on my stereo.

• Want the behavior of a Post Icon plugin (image to display for the post, not derived from category)?

  <?php echo c2c_get_custom('post_icon', '<img alt="post icon" class="posticon" src="/wp-images/posticons/', '.gif" />', 'blank'); ?>

  Which would yield:

  [if value for 'post_icon' is 'wordpress']
  <img alt="post icon" class="posticon" src="/wp-images/posticons/wordpress.gif" />

• Want to do per-post customized ‘more’ text? (to override the default “Read the rest of this entry >>”) (This example will show that default, which you can of course change, if you don’t define the custom field ‘more’ for a post)

  In index.php, look for this function: <?php the_content(); ?>

  Replace it with this:

  <?php the_content(c2c_get_custom('more', '<span class="more">', '</span>', 'Read the rest of this entry »')); ?>

• <?php echo c2c_get_custom('todays_link', '<a class="tlink" href="', '" >Today\'s Link</a>'); ?>

• <?php echo c2c_get_custom('related_offsite_links', 
    'Here\'s a list of offsite links related to this post:<ol><li><a href="',
    '">Related</a></li></ol>',
    '',
    '">Related</a></li><li><a href="'); ?>

• <?php echo c2c_get_custom('more_pictures',
    'Pictures I\'ve taken today:<br /><div class="more_pictures"><img alt="[photo]" src="',
    '" /></div>',
    '',
    '" /> : <img alt="[photo]" src="'); ?>

Template Tags

Functions

• <?php function c2c_get_custom( $field, $before='', $after='', $none='', $between='', $before_last='' ) ?>
  Template tag for use inside “the loop” and applies to the currently listed post.
• <?php function c2c_get_recent_custom( $field, $before='', $after='', $none='', $between=', ', $before_last='', $limit=1, $unique=false, $order='DESC', $include_pages=true, $show_pass_post=false ) ?>
  Template tag for use outside “the loop” and applies for custom fields regardless of post.
• <?php function c2c_get_post_custom( $post_id, $field, $before='', $after='', $none='', $between='', $before_last='' ) ?>
  Template tag for use when you know the ID of the post you’re interested in.
• <?php function c2c_get_random_custom( $field, $before='', $after='', $none='' ) ?>
  Template tag for use to retrieve a random custom field value.
• <?php function c2c_get_random_post_custom( $post_id, $field, $limit=1, $before='', $after='', $none='', $between='', $before_last='' ) ?>
  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.
• <?php function c2c_get_recent_custom( $field, $before='', $after='', $none='', $between=', ', $before_last='', $limit=1, $unique=false, $order='DESC', $include_pages=true, $show_pass_post=false ) ?>
  Template tag for use outside “the loop” and applies for custom fields regardless of post.

Arguments

• $post_id
  Required argument (only used in c2c_get_post_custom()). The ID of the post from which the custom field should be obtained.
• $field
  Required argument. The custom field key of interest.
• $before
  Optional argument. The text to display before all field value(s).
• $after
  Optional argument. The text to display after all field value(s).
• $none
  Optional argument. The text to display in place of the field value should no field value exists; if defined as ” and no field value exists, then nothing (including no $before and $after) gets displayed.
• $between
  Optional argument. The text to display between multiple occurrences of the custom field; if defined as ”, then only the first instance will be used.
• $before_last
  Optional argument. The text to display between the next-to-last and last items listed when multiple occurrences of the custom field; $between MUST be set to something other than ” for this to take effect.

Arguments that only apply to c2c_get_recent_custom():

• $limit
  Optional argument. The limit to the number of custom fields to retrieve.
• $unique
  Optional argument. Boolean (’true’ or ‘false’) to indicate if each custom field value in the results should be unique.
• $order
  Optional argument. Indicates if the results should be sorted in chronological order (’ASC’) (the earliest custom field value listed first), or reverse chronological order (’DESC’) (the most recent custom field value listed first).
• $include_pages
  Optional argument. Boolean (’true’ or ‘false’) to indicate if pages should be included when retrieving recent custom values; default is ‘true’.
• $show_pass_post
  Optional argument. Boolean (’true’ or ‘false’) to indicate if password protected posts should be included when retrieving recent custom values; default is ‘false’.

Frequently Asked Questions

• Q: I added the template tag to my template and the post has the custom field I’m asking for but I don’t see anything about it on the page; what gives?

  A: Did you echo the return value of the function, e.g. <?php echo c2c_get_custom('mood', 'My mood: '); ?>

• Q: Can I achieve all the functionality allowed by the six template functions using the widget?

  A: Except for c2c_get_custom() (which is only available inside “the loop”), yes, by carefully setting the appropriate settings for the widget.

• Q: How do I configure the widget to match up with the template functions?

  A:

  • c2c_get_custom() : not achievable via the widget
  • c2c_get_current_custom() : set the “Post ID” field to `0`, leave “Pick random value?” unchecked, and set other values as desired.
  • c2c_get_post_custom() : set the “Post ID” field to the ID of the post you want to reference and set other values as desired.
  • c2c_get_random_custom() : leave “Post ID” blank, check “Pick random value?”, and set other values as desired.
  • c2c_get_random_post_custom() : set the “Post ID” field to the ID of the post you want to reference, check “Pick random value?”, and set other values as desired.
  • c2c_get_recent_custom() : leave “Post ID” blank and set other values as desired.
• Q: Why can’t I see the widget or shortcode builder as mentioned in the features listing?

  A: Those features are only available if you are running WordPress 2.8 or later.

Release Log

Copyright & Disclaimer

Acknowledgements

Thanks to all those who have contributed feedback and support!