Skip to content

Commit

Permalink
First pass at adding timezone offset display value.
Browse files Browse the repository at this point in the history
  • Loading branch information
@afercia
afercia committed Nov 17, 2023
1 parent c9cad59 commit 6912663
Show file tree
Hide file tree
Showing 5 changed files with 111 additions and 8 deletions.
101 changes: 101 additions & 0 deletions lib/compat/wordpress-6.5/script-loader.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
<?php
/**
* Updates the script-loader.php file
*
* @package gutenberg
*/

/**
* Updates the registered inline script `wp-date` required for moment.js localization.
* Changes to the inline script output should be synced with Core in the file
* src/wp-includes/script-loader.php in `wp_default_packages_inline_scripts()`.
*
* @since 6.5.0
*
* @global WP_Locale $wp_locale WordPress date and time locale object.
*
* @param WP_Scripts $scripts WP_Scripts object.
*/
function gutenberg_update_wp_date_timezone_settings( $scripts ) {
if ( $scripts->query( 'wp-date', 'registered' ) ) {
global $wp_locale;
// Calculate the timezone abbr (EDT, PST) if possible.
$timezone_string = get_option( 'timezone_string', 'UTC' );
$timezone_abbr = '';

if ( ! empty( $timezone_string ) ) {
$timezone_date = new DateTime( 'now', new DateTimeZone( $timezone_string ) );
$timezone_abbr = $timezone_date->format( 'T' );
}

$gmt_offset = get_option( 'gmt_offset', 0 );

$scripts->registered['wp-date']->extra['after'] = array(
false,
sprintf(
'wp.date.setSettings( %s );',
wp_json_encode(
array(
'l10n' => array(
'locale' => get_user_locale(),
'months' => array_values( $wp_locale->month ),
'monthsShort' => array_values( $wp_locale->month_abbrev ),
'weekdays' => array_values( $wp_locale->weekday ),
'weekdaysShort' => array_values( $wp_locale->weekday_abbrev ),
'meridiem' => (object) $wp_locale->meridiem,
'relative' => array(
/* translators: %s: Duration. */
'future' => __( '%s from now', 'gutenberg' ),
/* translators: %s: Duration. */
'past' => __( '%s ago', 'gutenberg' ),
/* translators: One second from or to a particular datetime, e.g., "a second ago" or "a second from now". */
's' => __( 'a second', 'gutenberg' ),
/* translators: %s: Duration in seconds from or to a particular datetime, e.g., "4 seconds ago" or "4 seconds from now". */
'ss' => __( '%d seconds', 'gutenberg' ),
/* translators: One minute from or to a particular datetime, e.g., "a minute ago" or "a minute from now". */
'm' => __( 'a minute', 'gutenberg' ),
/* translators: %s: Duration in minutes from or to a particular datetime, e.g., "4 minutes ago" or "4 minutes from now". */
'mm' => __( '%d minutes', 'gutenberg' ),
/* translators: %s: One hour from or to a particular datetime, e.g., "an hour ago" or "an hour from now". */
'h' => __( 'an hour', 'gutenberg' ),
/* translators: %s: Duration in hours from or to a particular datetime, e.g., "4 hours ago" or "4 hours from now". */
'hh' => __( '%d hours', 'gutenberg' ),
/* translators: %s: One day from or to a particular datetime, e.g., "a day ago" or "a day from now". */
'd' => __( 'a day', 'gutenberg' ),
/* translators: %s: Duration in days from or to a particular datetime, e.g., "4 days ago" or "4 days from now". */
'dd' => __( '%d days', 'gutenberg' ),
/* translators: %s: One month from or to a particular datetime, e.g., "a month ago" or "a month from now". */
'M' => __( 'a month', 'gutenberg' ),
/* translators: %s: Duration in months from or to a particular datetime, e.g., "4 months ago" or "4 months from now". */
'MM' => __( '%d months', 'gutenberg' ),
/* translators: %s: One year from or to a particular datetime, e.g., "a year ago" or "a year from now". */
'y' => __( 'a year', 'gutenberg' ),
/* translators: %s: Duration in years from or to a particular datetime, e.g., "4 years ago" or "4 years from now". */
'yy' => __( '%d years', 'gutenberg' ),
),
'startOfWeek' => (int) get_option( 'start_of_week', 0 ),
),
'formats' => array(
/* translators: Time format, see https://www.php.net/manual/datetime.format.php */
'time' => get_option( 'time_format', __( 'g:i a', 'default' ) ),
/* translators: Date format, see https://www.php.net/manual/datetime.format.php */
'date' => get_option( 'date_format', __( 'F j, Y', 'default' ) ),
/* translators: Date/Time format, see https://www.php.net/manual/datetime.format.php */
'datetime' => __( 'F j, Y g:i a', 'default' ),
/* translators: Abbreviated date/time format, see https://www.php.net/manual/datetime.format.php */
'datetimeAbbreviated' => __( 'M j, Y g:i a', 'default' ),
),
'timezone' => array(
'offset' => (float) $gmt_offset,
'string' => $timezone_string,
'abbr' => $timezone_abbr,
'formattedOffset' => str_replace( array( '.25', '.5', '.75' ), array( ':15', ':30', ':45' ), (string) $gmt_offset ),
),
)
)
),
);
}
}

add_action( 'wp_default_scripts', 'gutenberg_update_wp_date_timezone_settings' );
1 change: 1 addition & 0 deletions lib/load.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,7 @@ function gutenberg_is_experiment_enabled( $name ) {
// WordPress 6.5 compat.
require __DIR__ . '/compat/wordpress-6.5/block-patterns.php';
require __DIR__ . '/compat/wordpress-6.5/class-wp-navigation-block-renderer.php';
require __DIR__ . '/compat/wordpress-6.5/script-loader.php';

// Experimental features.
require __DIR__ . '/experimental/block-editor-settings-mobile.php';
Expand Down
2 changes: 1 addition & 1 deletion packages/components/src/date-time/time/timezone.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ const TimeZone = () => {
const zoneAbbr =
'' !== timezone.abbr && isNaN( Number( timezone.abbr ) )
? timezone.abbr
: `UTC${ offsetSymbol }${ timezone.offset }`;
: `UTC${ offsetSymbol }${ timezone.formattedOffset }`;

const timezoneDetail =
'UTC' === timezone.string
Expand Down
13 changes: 7 additions & 6 deletions packages/date/src/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ import deprecated from '@wordpress/deprecated';

/**
* @typedef TimezoneConfig
* @property {string} offset Offset setting.
* @property {string} string The timezone as a string (e.g., `'America/Los_Angeles'`).
* @property {string} abbr Abbreviation for the timezone.
* @property {string} offset Offset setting.
* @property {string} string The timezone as a string (e.g., `'America/Los_Angeles'`).
* @property {string} abbr Abbreviation for the timezone.
* @property {string} formattedOffset Offset setting with decimals formatted to minutes.
*/

/* eslint-disable jsdoc/valid-types */
Expand Down Expand Up @@ -63,8 +64,8 @@ const WP_ZONE = 'WP';
// See: https://en.wikipedia.org/wiki/ISO_8601#Time_offsets_from_UTC
const VALID_UTC_OFFSET = /^[+-][0-1][0-9](:?[0-9][0-9])?$/;

// Changes made here will likely need to be made in `lib/client-assets.php` as
// well because it uses the `setSettings()` function to change these settings.
// Changes made here will likely need to be synced with Core in the file
// src/wp-includes/script-loader.php in `wp_default_packages_inline_scripts()`.
/** @type {DateSettings} */
let settings = {
l10n: {
Expand Down Expand Up @@ -132,7 +133,7 @@ let settings = {
datetime: 'F j, Y g: i a',
datetimeAbbreviated: 'M j, Y g: i a',
},
timezone: { offset: '0', string: '', abbr: '' },
timezone: { offset: '0', string: '', abbr: '', formattedOffset: '0' },
};

/**
Expand Down
2 changes: 1 addition & 1 deletion packages/editor/src/components/post-schedule/label.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ function getTimezoneAbbreviation() {
}

const symbol = timezone.offset < 0 ? '' : '+';
return `UTC${ symbol }${ timezone.offset }`;
return `UTC${ symbol }${ timezone.formattedOffset }`;
}

function isTimezoneSameAsSiteTimezone( date ) {
Expand Down

0 comments on commit 6912663

Please sign in to comment.