WP User Timezone

WordPress has a site-level timezone setting configured from the admin back-end. All dates and times displayed on the front-end are typically displayed in this timezone.

This plugin enables the display of dates/times in the front-end using the browser’s timezone. This is done by overriding the WordPress’s ‘timezone_string’ and ‘gmt_offset’ options to match the user’s timezone for the duration of a particular request

ONLY on the front-end interface.

Browser Timezone Detection

The browser’s timezone is detected using one of the following two methods

• jsTimezoneDetect (default)

• HTML5 Geolocation API and Google Timezone API

jsTimezoneDetect (default)

This is the default timezone detection mechanism. Please refer to the script home page

for the compatibility and other notes

HTML5 Geolocation API

getCurrentPosition. The location thus detected will be sent to the Google Timezone API

which returns the timezone id – similar to “Asia/Kolkata”.

This method requires you to

• Enable the “Google Timezone API” option on the plugin options page

• Specify a valid Google API Key

• The key should be a browser key

• The “Accepted HTTP Referrers” should include the domain name used by the hosting wordpress site or left blank to allow all referrers

If the required options for the usage of Google Timezone API are not met, the detection mechanism falls back to the default one.

Post Timezone Detection

• If the browser’s timezone id is not detected successfully, everything else behaves as if this plugin is not installed.

• If the browser’s timezone id is detected, the following actions take place

• A cookie will be set in the browser, based on the cookie options specified on the plugin options page

• If a cookie already exists previously with the same id, no action is taken

• If a cookie doesn’t already exist previously or exists with a different timezone id, then a window.reload is triggered to refresh the page so that the dates/times on the page are updated

EventON Hook

This plugin provides a feature to hook into the EventON plugin. When enabled, all EventON dates/times are updated to reflect the browser’s timezone.

Shortcodes

This plugin defines the below shortcodes

• [wp_user_timezone_id] => Returns the timezone id of the browser or null if not available.

• [wp_user_timezone_offset] => Returns the timezone’s gmt offset in hours of the browser or null if not available.

Options

This plugin defines the below options to retrieve the original timezone_string and gmt_offset defined at the site level

• get_option( ‘site_timezone_string’ ) => Returns the original timezone_string option for the site

• get_option( ‘site_gmt_offset’ ) => Returns the original gmt_offset option for the site

Actions/Hooks

This plugin defines the below filters/hooks

• apply_filters( ‘wp_user_timezone_id’, $tz_id ) => Allows you to override the timezone string determined by the plugin. This filter can be used to apply user’s timezone preference. If any plugin or wordpress core implements a feature to accept and store user’s preferred timezone, the ‘wp_user_timezone_id’ can be used to apply that timezone value to the front-end. Reference: Add user-level timezone setting ).

Admin Backend Dates/Times

Important: The admin back-end is not modified by this plugin. All dates/times displayed in the back-end are still in the original timezone specified by the WordPress General Settings.