wp_timezone_string(): string

Retrieves the timezone of the site as a string.

Contents

Description

Uses the timezone_string option to get a proper timezone name if available, otherwise falls back to a manual UTC ± offset.

Example return values:

  • ‘Europe/Rome’
  • ‘America/North_Dakota/New_Salem’
  • ‘UTC’
  • ‘-06:30’
  • ‘+00:00’
  • ‘+08:45’

Top ↑

Return

string PHP timezone name or a ±HH:MM offset.

Top ↑

Source

File: wp-includes/functions.php. View all references 

function wp_timezone_string() {
	$timezone_string = get_option( 'timezone_string' );

	if ( $timezone_string ) {
		return $timezone_string;
	}

	$offset  = (float) get_option( 'gmt_offset' );
	$hours   = (int) $offset;
	$minutes = ( $offset - $hours );

	$sign      = ( $offset < 0 ) ? '-' : '+';
	$abs_hour  = abs( $hours );
	$abs_mins  = abs( $minutes * 60 );
	$tz_offset = sprintf( '%s%02d:%02d', $sign, $abs_hour, $abs_mins );

	return $tz_offset;
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
get_option() wp-includes/option.php

Retrieves an option value based on an option name.

Top ↑

Used By

Used By
Used By Description
wp_timezone() wp-includes/functions.php

Retrieves the timezone of the site as a DateTimeZone object.
WP_Debug_Data::debug_data() wp-admin/includes/class-wp-debug-data.php

Static function for generating site debug data when required.

Top ↑

Changelog

Changelog
Version Description
5.3.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note
    Contributed by Fida Al Hasan — 
    /**
 * If you want to show both timezone_string & gmt_offset
 * Preview: Asia/Dhaka [+06:00] or +06:00
 */

// function goes to theme's functions.php file or plugin's file
function wpdocs_custom_timezone_string() {
    $timezone_string = get_option( 'timezone_string' );
    $offset  = (float) get_option( 'gmt_offset' );
    $hours   = (int) $offset;
    $minutes = ( $offset - $hours );
    $sign      = ( $offset < 0 ) ? '-' : '+';
    $abs_hour  = abs( $hours );
    $abs_mins  = abs( $minutes * 60 );
    $tz_offset = sprintf( '%s%02d:%02d', $sign, $abs_hour, $abs_mins );
    $timezone = $timezone_string ? $timezone_string . ' [' . $tz_offset . ']' : $tz_offset;

    return $timezone;
}

// Usage
echo esc_html( wpdocs_custom_timezone_string() );

You must log in before being able to contribute a note or feedback.