coffee2code

Extended Description

Installation

Filters

The plugin exposes four filters for hooking. Typically, customizations utilizing these hooks would be put into your active theme’s functions.php file, or used by another plugin.

c2c_blog_time (filter)

The ‘c2c_blog_time’ hook allows you to use an alternative approach to safely invoke c2c_blog_time() in such a way that if the plugin were deactivated or deleted, then your calls to the function won’t cause errors in your site.

Arguments:

• same as for c2c_blog_time()

Example:

Instead of:

`<?php c2c_blog_time(); ?>`

Do:

`<?php echo apply_filters( 'c2c_blog_time', '' ); ?>`

blog_time_format (filter)

The ‘blog_time_format’ hook allows you to customize the default format for the blog time. By default this is ‘g:i A’ (though this may be different if modified by localization). NOTE: This currently only applies to the static clock and not the dynamic clock.

Arguments:

• $format (string): The default format for the blog time.

Example:

// Change the default blog time string
add_filter( 'blog_time_format', 'change_blog_time_format' );
function change_blog_time_format( $format ) {
    return 'b, g:i A';
}

c2c_blog_time_toolbar_widget_for_user (filter)

The ‘c2c_blog_time_toolbar_widget_for_user’ hook allows you to control if the admin toolbar clock widget should be shown, on a per-user basis. By default the admin toolbar clock is shown to everyone who can see the admin toolbar.

Arguments:

• $shown (boolean): Whether the admin toolbar clock widget should be shown. Default of true.

Example:

// Only show the admin toolbar clock for the 'boss' user.
add_filter( 'c2c_blog_time_toolbar_widget_for_user', 'restrict_blog_time_widget_appearance' );
function restrict_blog_time_widget_appearance( $show ) {
    return 'boss' == get_current_user()->user_login;
}

c2c_blog_time_active_clock (filter)

The ‘c2c_blog_time_active_clock’ hook returns the boolean value indicating if the Javascript-powered dynamic clock introduced in v2.0 should be enabled or if instead the v1.x era behavior of a static timestamp that can be clicked to update the timestamp via AJAX should be enabled. By default the dynamic clock is enabled.

Arguments:

• $allow (boolean): Boolean indicating if the admin widget should be a dynamic clock. Default is true.

Example:

// Disable the dynamic clock and use the static timestamp (whcih can be clicked to update the time via AJAX) instead.
add_filter( 'c2c_blog_time_active_clock', '__return_false' );

Frequently Asked Questions

Q. How do I customize the format of the time string?
A. The widget and template tag allow you specify a time format directly. The default value for the time format, and the one used by the display of the blog time in the static admin widget, can be overridden by adding a filter to ‘blog_time_format’ and returning the desired time format. See php.net/date for more information regarding the time format.

NOTE: The time string is currently only configurable for the static clock and the widget, not the dynamic admin toolbar clock enabled by default.

Q. Why is the time not changing in the sidebar widget?
A. This plugin does not (yet) provide an active clock that continues to update to reflect the current time as time passes for the sidebar widget. It merely displays the current time, according to your server, at the time the page was created and sent to your browser. You can click on the time itself to see it dynamically refresh (without a page reload) to the current time. Or if the page gets manually reloaded you’ll see a new current time. The dynamic clock is currently only available to the admin toolbar widget.

Q. The time matches my computer’s time; how do I know this thing is working?
A. Your machine may well be synced with the server’s clock. One test you can perform is to change the blog’s time zone (under Settings -> General). The blog’s time will then be set to a different hour, which should then be reflected by the widget.

Q. How do I go back to having the static timestamp as opposed to the dynamic clock?
A. See the Filters section for the c2c_blog_time_active_clock filter, which includes an example line of code you’ll need to add to your theme.

Release Log

3.0

• Move admin widget into admin toolbar
• Discontinue inclusion of jqClock jQuery plugin and instead use custom developed code
• Fix bug with incorrect hour being shown for dynamic clock
• Change JavaScript to detect if ‘c2c-blog-time-dynamic’ class is present on span to determine if clock should be dynamic
• Add support for dynamic clock in sidebar widget
• Support multiple occurrences of widget (admin and/or sidebar) on single page
• Update widget to use C2C_Widget base class (v005)
• Clear link title attribute when using dynamic clock since instructions for clicking to update don’t apply
• Enqueue JavaScript (which has been moved into new js/blog-time.js)
• Enqueue JavaScript on front-end also if admin toolbar or widget are being shown
• Add filter ‘c2c_blog_time_toolbar_widget_for_user’ for per-user control of admin toolbar widget (default is true)
• Remove support for ‘c2c_blog_time_js_insert_action’ filter
• Remove support for ‘c2c_blog_time_target’ filter
• Add version() to return plugin version
• Add admin_bar_menu(), is_wp_login(), show_in_toolbar_for_user()
• Remove load_textdomain(), add_js()
• Remove support for deprecated blog_time()
• Code reformatting (function reorganization)
• Note compatibility through WP 3.3+
• Drop support for versions of WP older than 3.3
• Create ‘lang’ subdirectory and move .pot file into it
• Regenerate .pot
• Change description
• Add ‘Domain Path’ directive to top of main plugin file
• Add link to plugin directory page to readme.txt
• Update screenshots (now based on WP 3.3)
• Update copyright date (2012)

2.0.1

• Fix bug relating to showing time in incorrect timezone

2.0

• Integrate jqClock to provide dynamic clock in admin section
• Add filter ‘c2c_blog_time_js_insert_action’ to allow overriding default JS insertion method used to insert admin widget onto page
• Add filter ‘c2c_blog_time_target’ to allow overriding target relative to which the JS insertion of the admin widget is performed
• Add filter ‘c2c_blog_time_active_clock’ to allow disabling dynamic Javascript clock and use v1.x era static timestamp (that can be click to update time)
• Display admin blog time widget even if JS is disabled
• Create add_js() and use it to output JS (code moved from add_widget())
• Hook add_widget() to ‘in_admin_header’ action
• Add additional CSS rules to maintain appearance in latest WP
• Remove unused JS variable wpcontenturl
• Note compatibility through WP 3.2+
• Drop support for versions of WP older than 3.1
• Tiny code formatting change (spacing)
• Documentation updates to reflect recent changes
• Add Credits section to readme.txt
• Fix plugin homepage and author links in description in readme.txt

1.2

• Fix UI compatibility issue introduced by WP 3.1
• Use class variable to store ID for the admin widget (and change it from previous value)
• Switch from object instantiation to direct class invocation
• Explicitly declare all functions public and class variables private
• Move template tag functions and class initialization call within primary if(class_exists())
• Output CSS in a single line
• Rename widget class from ‘BlogTimeWidget’ to ‘c2c_BlogTimeWidget’
• Note compatibility through WP 3.1+
• Update copyright date (2011)

1.1

• Rename blog_time() template tag to c2c_blog_time()
• Deprecate blog_time() template tag, but retain it for backwards compatibility
• Add hook ‘c2c_blog_time’ (filter) to respond to the function of the same name so that users can use the apply_filters() notation for invoking template tag
• Move most of the code in constructor into init()
• Invoke add_widget() against ‘admin_print_footer_scripts’ hook rather than ‘admin_footer’
• Fix PHP warnings/notices in widget code
• Full support for localization
• Rename class from ‘BlogTime’ to ‘c2c_BlogTime’
• Note compatibility with WP 2.9+, 3.0+
• Drop support for versions of WP older than 2.8
• Assign object instance to global variable, $c2c_blog_time as global, to allow for external manipulation
• Remove docs from top of plugin file (all that and more are in readme.txt)
• Minor code reformatting (spacing)
• Add PHPDoc documentation
• Add package info
• Remove trailing whitespace in header docs
• Update copyright date
• Add Changelog, Filters, and Upgrade Notice sections to readme.txt
• Add .pot file

1.0

• Initial release

Copyright & Disclaimer