function system_time_zones

Generate an array of time zones and their local time&date.

Parameters

mixed $blank: If evaluates true, prepend an empty time zone option to the array.

bool $grouped: (optional) Whether the timezones should be grouped by region.

Return value

array An array or nested array containing time zones, keyed by the system name.

File

core/modules/system/system.module, line 1262

Code

function system_time_zones($blank = NULL, $grouped = FALSE) {
    $zonelist = timezone_identifiers_list();
    $zones = $blank ? [
        '' => t('- None selected -'),
    ] : [];
    foreach ($zonelist as $zone) {
        // Because many time zones exist in PHP only for backward compatibility
        // reasons and should not be used, the list is filtered by a regular
        // expression.
        if (preg_match('!^((Africa|America|Antarctica|Arctic|Asia|Atlantic|Australia|Europe|Indian|Pacific)/|UTC$)!', $zone)) {
            $zones[$zone] = t('@zone', [
                '@zone' => t(str_replace('_', ' ', $zone)),
            ]);
        }
    }
    // Sort the translated time zones alphabetically.
    asort($zones);
    if ($grouped) {
        $grouped_zones = [];
        foreach ($zones as $key => $value) {
            $split = explode('/', $value);
            $city = array_pop($split);
            $region = array_shift($split);
            if (!empty($region)) {
                $grouped_zones[$region][$key] = empty($split) ? $city : $city . ' (' . implode('/', $split) . ')';
            }
            else {
                $grouped_zones[$key] = $value;
            }
        }
        foreach ($grouped_zones as $key => $value) {
            if (is_array($grouped_zones[$key])) {
                asort($grouped_zones[$key]);
            }
        }
        $zones = $grouped_zones;
    }
    return $zones;
}