wppaste
WordPress

wp_timezone(): DateTimeZone

Since
5.3.0
Source
wp-includes/functions.php:152
Retrieves the timezone of the site as a DateTimeZone object.

Description

Timezone can be based on a PHP timezone string or a ±HH:MM offset.

Compatibility

WordPress
since 5.3.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

DateTimeZone
Timezone object.

Performance profile

How much work a call to wp_timezone() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
6

Executed per call on PHP 8.5. The body compiles to 6.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
10

10 places in core call this, so the cost is paid more often than your own code shows.

What it touches

  • optionoption read or writeget_option()one call below wp_timezone()

Further down the call graph this can also reach hook, cache, serialize, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_timezone() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always6wp_timezone_string()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev660
8.5660
8.466018 fewer instructions than PHP 8.3
8.324180
8.224180
8.124180
7.424180

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Used by · 10

  • WP_Date_Query::build_mysql_datetime()Builds a MySQL format date/time based on some query parameters.
  • current_datetime()Retrieves the current time as an object using the site's timezone.
  • current_time()Retrieves the current time based on specified type.
  • date_i18n()Retrieves the date in localized format, based on a sum of Unix timestamp and timezone offset in seconds.
  • get_date_from_gmt()Given a date in UTC or GMT timezone, returns that date in the timezone of the site.
  • get_gmt_from_date()Given a date in the timezone of the site, returns that date in UTC.
  • get_post_datetime()Retrieves post published or modified time as a `DateTimeImmutable` object instance.
  • iso8601_to_datetime()Given an ISO 8601 (Ymd\TH:i:sO) date, returns a MySQL DateTime (Y-m-d H:i:s) format used by post_date[_gmt].
  • mysql2date()Converts given MySQL date string into a different format.
  • wp_date()Retrieves the date, in localized format.

Source code

View on Trac View on GitHub 

function wp_timezone() {	return new DateTimeZone( wp_timezone_string() );}

Changelog

Introduced in 5.3.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.