coffee2code

Extended Description

Installation

Filters

The plugin is further customizable via two filters. Typically, these customizations would be put into your active theme’s functions.php file, or used by another plugin.

stealth_update_meta_key (filter)

The ‘stealth_update_meta_key’ filter allows you to override the name of the custom field key used by the plugin to store a post’s stealth update status. This isn’t a common need.

Arguments:

• $custom_field_key (string): The custom field key to be used by the plugin. By default this is ‘_stealth-update’.

Example:

add_filter( 'stealth_update_meta_key', 'override_stealth_update_key' );
function override_stealth_update_key( $custom_field_key ) {
    return '_my_custom_stealth-update';
}

c2c_stealth_update_default (filter)

The ‘c2c_stealth_update_default’ filter allows you to override the default state of the ‘Stealth Update?’ checkbox.

Arguments:

• $state (boolean): The default state of the checkbox. By default this is false.
• $post (WP_Post): The post currently being created/edited.

Example:

// Have the Stealth Update? checkbox checked by default.
add_filter( 'c2c_stealth_update_default', '__return_true' );

Frequently Asked Questions

Q. Why would I want to stealth update a post?
A. This update dates for posts are used by feeds to indicate the latest update to each post or to report the latest updated post. Plugins and other manual uses of some of WordPress’s template tags may also reference the post modification date to call attention to posts that have been updated. However, if an update is such that you don’t want it to be recorded in the post_modified date field (perhaps due to the update being a small formatting/editing change or fix, or if you just want to keep quiet about an update), then this plugin is for you.

Q. Can I have the checkbox checked by default?
A. Yes. See the Filters section (under Other Notes) and look for the example using the ‘c2c_stealth_update_default’ filter. You’ll have to put that code into your active theme’s functions.php file.

Release Log

2.2.1

• Add version() to return plugin’s version
• Update readme with example and documentation for new filter
• Note compatibility through WP 3.3+
• Update screenshots for WP 3.3
• Use DIRECTORY_SEPARATOR instead of hardcoded ‘/’
• Create ‘lang’ subdirectory and move .pot file into it
• Regenerate .pot
• Add ‘Domain Path’ directive to top of main plugin file
• Add link to plugin directory page to readme.txt
• Update copyright date (2012)

2.2

• Add filter ‘c2c_stealth_update_default’ to allow configuring checkbox to be checked by default
• Note compatibility through WP 3.2+
• Minor code formatting changes (spacing)
• Fix plugin homepage and author links in description in readme.txt

2.1

• Switch from object instantiation to direct class invocation
• Explicitly declare all functions public static and class variables private static
• Note compatibility through WP 3.1+
• Update copyright date (2011)

2.0.2

• Bugfix for auto-save losing value of stealth update status

2.0.1

• Define Text Domain plugin header
• Supply textdomain to localization functions
• Rename class from ‘StealthUpdate’ to ‘c2c_StealthUpdate’
• Add Frequently Asked Questions and Filters sections to readme.txt
• Readme updates
• Add .pot file

2.0

• Add checkbox labeled ‘Stealth update?’ to Publish meta_box rather than requiring direct use of custom fields
• Add class of ‘c2c-stealth-update’ to admin UI div containing checkbox
• Add filter ‘stealth_update_meta_key’ to allow overriding custom field key name
• Re-implemented entire approach
• Remove functions add_js(), admin_menu(), add_meta_box()
• Store plugin instance in global variable, $c2c_stealth_update, to allow for external manipulation
• Full support for localization
• Remove docs from top of plugin file (all that and more are in readme.txt)
• Minor code reformatting (spacing)
• Add PHPDoc documentation
• Note compatibility with WP 3.0+
• Drop compatibility with versions of WP older than 2.9
• Update screenshots
• Update copyright date
• Add package info to top of plugin file
• Add Changelog and Upgrade Notice sections to readme.txt
• First commit to WP plugin repository

1.0

• Initial release

Copyright & Disclaimer