https://github.com/jrfoell/recurring-timer-widget

Recurring timer widget for WP
https://github.com/jrfoell/recurring-timer-widget

Last synced: 15 days ago
JSON representation

Recurring timer widget for WP

• Host: GitHub
• URL: https://github.com/jrfoell/recurring-timer-widget
• Owner: jrfoell
• Created: 2014-09-23T01:15:07.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-09-26T02:17:52.000Z (about 6 years ago)
• Last Synced: 2024-05-02T00:12:48.588Z (7 months ago)
• Language: PHP
• Size: 87.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.txt

Awesome Lists containing this project

README

        
=== Recurring Timer Widget ===

Contributors: jrfoell

Tags: widget, timer, recurring, event, plugin

Requires at least: 4.6

Tested up to: 4.9

Stable tag: 1.7

Widget to display a countdown timer for a recurring event.

== Description ==

Displays a countdown until the event begins. Specify an event duration time and it will display a different message while the event is happening. After the event is over, the countdown will begin again.

Uses string-to-time (strtotime) formats which can be very simple or very complex.

The widget has many CSS classes to style it with, but it's been left purposely unstyled so you can format it in whatever way you want. The included recurring-timer-widget.css and recurring-timer-widget.css-example files show how you can move the time and labels around for a custom look. You can customize recurring-timer-widget.css by copying it to your active theme's folder.

Known issues:

* It requires a browser refresh before the "next next" event. i.e. If you're viewing the widget and the timer is set for a daily event, the timer will countdown to today's event, then countdown to tomorrow's event. But it will not countdown to the day after tomorrow's event unless the browser is refreshed.

* Events that occur more than once in a 24-hour period have not been tested and may not work.

== Installation ==

1. Unzip and upload the plugin to your 'wp-content/plugins' directory.

1. Activate the plugin through the 'Plugins' menu in WordPress.

1. Add the widget to your site through the 'Widgets' menu in WordPress (under 'Appearance').

1. Optionally copy recurring-timer-widget.css-example or recurring-timer-widget.css to recurring-timer-widget.css in your active theme folder to customize the style. You may also style the widget by customizing the stylesheet in your theme.

== Frequently Asked Questions ==

= Where do I find information about the time formats? =

* [http://php.net/strtotime](http://php.net/strtotime)

* [http://www.php.net/manual/en/datetime.formats.relative.php](http://www.php.net/manual/en/datetime.formats.relative.php)

* [http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html](http://www.gnu.org/software/tar/manual/html_node/Date-input-formats.html)

Please note this comment on php.net: [http://us.php.net/manual/en/datetime.formats.relative.php#98989](http://us.php.net/manual/en/datetime.formats.relative.php#98989) In my screenshot example I used "fourth thursday of this month" for the Event Day. This only works in PHP 5.3+. However, removing the 'of' and using "fourth thursday this month" works in earlier versions of PHP. Your mileage may vary, so you'll want to experiment if your timer is displaying negative time and/or counting up.

== Screenshots ==

1. Widget menu in WP-Admin with an example event.

2. An un-styled version of the widget (not very pretty).

3. The widget using the example CSS file for style.

== Changelog ==

= 1.8 =

* Removed deprecated create_function() call and put all hooks in widget class.

* WordPress Coding Standards Formatting

= 1.7 =

* Added more CSS classes for easier targeting/styling.

= 1.6 =

* Renamed files to support translations via [http://translate.wordpress.org]

* Fixed issue with monthly events showing up as today when they shouldn't.

= 1.5 =

* Replaced call to time() with current_time( 'timestamp' ) to insure correct comparison to local time set in Settings -> General -> Timezone.

= 1.4 =

* Make sure monthly events do not produce 'negative' countdowns after this month's event has occurred.

* Added default style with option to override in the theme.

= 1.3 =

* Refactored javascript to allow widget to be placed multiple times on a single page.

= 1.2 =

* Fixed misspelled variable affecting next event start.

= 1.1 =

* Changed dates to use GMT - let the user's browser determine the timezone.

* Added readme.txt and screenshots.

= 1.0 =

* Initial release.