Webseite Zeit

Beschreibung

This plugin adds a dynamic, functional clock to the the admin bar (at top of all admin pages) to show the server time for the blog. The clock automatically updates as time passes, as you would expect of a digital clock.

This plugin also supports a static mode which puts a timestamp string at the top of all admin pages instead of the dynamic clock. This static admin time widget is AJAX-ified so that if you click the timestamp, it updates in place (without a page reload) to show the new current server time.

Also provided is a „Blog Time“ widget providing the same functionality as the admin widget, but for your sidebars. You may also utilize the plugin’s functionality directly within a theme template via use of the template tag c2c_blog_time().

NOTE: For the front-end widget, if the „Use dynamic clock?“ configuration option is unchecked, this plugin generates a timestamp and NOT a clock. The time being displayed is the time of the page load, or if clicked, the time when the widget last retrieved the time. It won’t actively increment time on the display. By default the widget displays a dynamic clock that does increment time.

This is most useful to see the server/blog time to judge when a time sensitive post, comment, or action would be dated by the blog (i.e. such as monitoring for when to close comments on a contest post, or just accounting for the server being hosted in a different timezone). Or, when used statically as a timestamp and not a clock, it can indicate/preserve when the page was loaded.

Thanks to Moment.js for the JavaScript date handling library.

Links: Plugin Homepage | Plugin Directory Page | GitHub | Author Homepage

Template Tags

The plugin provides one template tag for use in your theme templates, functions.php, or plugins.

Functions

  • <?php function c2c_blog_time( $time_format = '', $echo = true ) ?>
    Gets the formatted time for the site.

Arguments

  • $time_format (string)
    Optional. PHP-style time format string. See https://php.net/date for more info. Default is “ (which, unless otherwise modified, uses the default time forat: ‚g:i A‘).

  • $echo (bool)
    Optional. Echo the template info? Default is true.

Examples

  • <?php // Output the site's current time.
    c2c_blog_time();
    ?>

  • <?php // Retrieve the value for use in code, so don't display/echo it.
    $site_date = c2c_blog_time( 'M d, Y', false );
    ?>

Hooks

The plugin exposes four filters for hooking. Code using these filters should ideally be put into a mu-plugin or site-specific plugin (which is beyond the scope of this readme to explain). Less ideally, you could put them in your active theme’s functions.php file.

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.

Anpassung:

  • same as for c2c_blog_time()

Beispiel:

Instead of:

<?php c2c_blog_time(); ?>

Do:

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

c2c_blog_time_format (filter)

The ‚c2c_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).

Anpassung:

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

Beispiel:

/**
 * Change the default blog time string
 *
 * @param string $format The default time format.
 * @return string
 */
function change_blog_time_format( $format ) {
    return 'b, g:i A';
}
add_filter( 'c2c_blog_time_format', 'change_blog_time_format' );

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.

Anpassung:

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

Beispiel:

/**
 * Only show the admin toolbar clock for the 'boss' user.
 *
 * @param $show bool Status of whether the admin toolbar clock should be shown.
 * @return bool
 */
function restrict_blog_time_widget_appearance( $show ) {
    return 'boss' == get_current_user()->user_login;
}
add_filter( 'c2c_blog_time_toolbar_widget_for_user', 'restrict_blog_time_widget_appearance' );

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.

Anpassung:

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

Beispiel:

// 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' );

Screenshots

  • A screenshot of the blog time being displayed in the admin toolbar.
  • A screenshot of the 'Webseite Zeit' widget.

Installation

  1. Install via the built-in WordPress plugin installer or download and unzip blog-time.zip inside the plugins directory for your site (typically wp-content/plugins/)
  2. Activate the plugin through the ‚Plugins‘ admin menu in WordPress
  3. Optionally use the ‚Blog Time‘ widget or the template tag c2c_blog_time() in a theme template file to display the blog’s time at the time of the page’s rendering.

FAQ

How do I customize the format of the time string?

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 ‚c2c_blog_time_format‘ and returning the desired time format. See https://php.net/date for more information regarding the time format.

Why is the time not changing in the sidebar widget?

The widget’s „Use dynamic clock?“ configuration setting may not be checked (which it is by default).

The time matches my computer’s time; how do I know this thing is working?

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.

How do I go back to having the legacy static timestamp as opposed to the dynamic clock?

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.

How can I show the blog’s date instead of the time?

You could do something like this:

/* Insert the following code in the active theme's functions.php or, even better,
in a site-specific plugin. */

// Disable dynamic clock since a clock is not being displayed.
add_filter( 'c2c_blog_time_active_clock', '__return_false' );
// Change the datetime format string used by the plugin.
add_filter( 'c2c_blog_time_format', 'my_blog_time_format' );

/**
 * Returns a custom datetime format string for default use
 * by the Blog Time plugin.
 *
 * See https://php.net/date for more information regarding the time format.
 *
 * @param string $format Original format string (ignored)
 * @return string New format string
 */
function my_blog_time_format( $format ) {
    return 'M d, Y';
}

Rezensionen

3. Dezember 2018
We process time sensitive orders with employees logging in throughout the world, and this was exactly what I was looking for! Displays the current time in the admin bar, and even updates the time without reloading the page. Not sure why several negative reviews.. works 100% for me.
25. November 2017
For us it did not work as anticipated (in the admin bar) It loaded the server time correctly, but a few seconds later it started using the local client time instead. This defeated the purpose of the clock, so i blocked the c2c_blog_time_active_clock filter, and while not dynamic, allows the time to be updated when clicked. Also, adding the seconds has helped. It is a useful tool, and is worth keeping, but only in its modified form.
3. September 2016
Works just fine. My only complaint is that the widget header does not appear, and there is no space between it and the next widget (I semi-resolved this by putting a paragraph tag in the "text after" field, but it didn't quite work. Otherwise, 5 stars for me.
3. September 2016
I'm surprised that this hasn't had good reviews. It works just fine, adds a little clock right by your admin name in title bar so you can always see your blog time. Between having to deal with all the "timing" stuff we need to in WordPress, this little addon is quite nice to have. Thank you.
Lies alle 7 Rezensionen

Mitwirkende & Entwickler

„Webseite Zeit“ ist Open-Source-Software. Folgende Menschen haben an diesem Plugin mitgewirkt:

Mitwirkende

Übersetze „Webseite Zeit“ in deine Sprache.

Interessiert an der Entwicklung?

Durchstöbere den Code, sieh dir das SVN Repository an oder abonniere das Entwicklungsprotokoll per RSS.

Änderungsprotokoll

3.6 (2019-04-02)

  • Change: Use minimized version of Moment.js library to reduce resource usage
  • Change: Update Moment.js to v2.24.0
  • Change: Change handle for enqueuing Moment.js to allow only one copy of the library being enqueued now that WP packages the library
  • Change: Remove set_js_ajaxurl() and localize ajaxurl alongside other variables instead of outputting it directly
  • Change: Initialize plugin on plugins_loaded action instead of on load
  • Change: Merge do_init() into init()
  • Change: Update widget framework to 013
    • Add get_config() as a getter for config array
  • Change: Update widget to 008
    • Update to use v013 of the widget framework
  • Change: Cast return value of c2c_blog_time_toolbar_widget_for_user and c2c_blog_time_active_clock filters as boolean
  • Change: Ensure widget markup uses double-quotes rather than single-quotes for class attribute values
  • Unit tests:
    • Add unit test for add_widget()
    • Add unit tests for show_in_toolbar_for_user()
    • Add unit test for c2c_blog_time_active_clock filter
    • Add unit test for c2c_blog_time_toolbar_widget_for_user filter
    • Add unit tests for hooking of various actions
  • New: Add CHANGELOG.md file and move all but most recent changelog entries into it
  • New: Add inline documentation for hooks
  • Change: Use apply_filters_deprecated() when using the deprecated filter
  • Change: Note compatibility through WP 5.1+
  • Change: Update copyright date (2019)
  • Change: Update License URI to be HTTPS
  • Change: Split paragraph in README.md’s „Support“ section into two

3.5.1 (2018-07-09)

  • Change: Update Moment.js to v2.22.2
  • New: Add README.md
  • New: Add GitHub link to readme
  • New: Add LICENSE file
  • Change: Minor whitespace tweaks to unit test bootstrap
  • Change: Rename readme.txt section from ‚Filters‘ to ‚Hooks‘
  • Change: Modify formatting of hook name in readme to prevent being uppercased when shown in the Plugin Directory
  • Change: Update installation instruction to prefer built-in installer over .zip file
  • Change: Note compatibility through WP 4.9+
  • Change: Update copyright date (2018)

3.5 (2017-01-21)

  • New: Add ability for dynamic clock to honor custom time format.
    • Package Moment.js (v2.17.1), a datatime library for JS.
    • Add map_php_time_format_to_momentjs() to remap PHP time format tokens to Moment.js time format tokens.
    • Simplify blog-time.js to defer time handling to Moment.js.
    • Make time format and UTC offset available for JS usage.
    • Output time format when customized (such as via widget or template tag) in markup for use by JS.
    • Remove documentation indicating dynamic clock does not honor custom time format.
  • New: Add clock dashicon before adminbar time widget.
  • Change: Determine the dynamic clock update time interval based on time format string to reduce update frequency when possible.
  • Change: Move CSS into enqueued file.
    • CSS is now in file css/blog-time.css.
    • Remove add_css().
  • Change: Extract time format related code out of display_time() and into new get_time_format().
  • Chnage: Add context to handlers for time format and display.
    • Add $context arg to get_format_time() and display_time().
    • Add $context arg to ‚c2c_blog_time_format‘ filter.
    • Add ‚context‘ as configuration parameter for add_widget().
    • Set context everywhere context can be set.
  • Change: Update widget framework to 012, bumping c2c_BlogTimeWidget to 007.
  • Bugfix: Add ‚.ab-item‘ class to time link so it gets proper styles in adminbar when JS is disabled.
  • Change: Prevent dynamic adminbar clock from getting hover styling as if it were a link.
  • Change: Ensure linked timestamp in static widget does not abide by a:visited styling.
  • Change: Widget: Move register_c2c_BlogTimeWidget() to ‚c2c_BlogTimeWidget::register_widget()`.
  • Change: Sanitize the translated string used in an attribute.
  • Change: Enable more error output for unit tests.
  • Change: Default WP_TESTS_DIR to /tmp/wordpress-tests-lib rather than erroring out if not defined via environment variable.
  • Change: Note compatibility through WP 4.7+.
  • Change: Remove support for WordPress older than 4.6 (should still work for earlier versions though).
  • Change: Add ‚Template Tags‘ section to FAQ.
  • Change: Minor inline documentation improvements and reformatting.
  • Change: Update copyright date (2017).
  • Change: Update both screenshots.

Full changelog is available in CHANGELOG.md.