Date: add relative time translations for moment.js

[ramonjd]

Resolves #53888

What?

Overwrites wp-date script string to include new relativeTime translations.

The inline script is generated in Core here: https://github.com/WordPress/wordpress-develop/blob/bf00a673a5f1d7f4707a6f914e1408526a8dc06a/src/wp-includes/script-loader.php#L430 and will need to be synced.

See: https://momentjscom.readthedocs.io/en/latest/moment/07-customization/07-relative-time/

Why?

The settings strings were never synced to Core.

Now that we're using relativeTime in humanTimeDiff, we need the translations.

Unfortunately, %d minutes and others have not yet been translated.

How?

Hooking into wp_default_scripts and overwriting the settings of the registered wp-date script.

The other option is to re-add the inline script, which will also work, but it will output 2 x inline scripts, e.g.,

<script id="wp-date-js-after">
wp.date.setSettings( ...oldSettings );
wp.date.setSettings( ...newSettings );
</script>

Testing Instructions

Change your editor/site to another language via Settings > General
Since the relevant translations have not been added, you can check that the wp.date settings have been updated by heading to /wp-admin/site-editor.php and, in the browser console, running wp.date.getSettings()

The relative object should match the requirements of https://momentjscom.readthedocs.io/en/latest/moment/07-customization/07-relative-time/

{
    "l10n": {
        "locale": "de_DE",
        "months": [
            "Januar",
            "Februar",
            "März",
            "April",
            "Mai",
            "Juni",
            "Juli",
            "August",
            "September",
            "Oktober",
            "November",
            "Dezember"
        ],
        "monthsShort": [
            "Jan",
            "Feb",
            "Mrz",
            "Apr",
            "Mai",
            "Jun",
            "Jul",
            "Aug",
            "Sep",
            "Okt",
            "Nov",
            "Dez"
        ],
        "weekdays": [
            "Sonntag",
            "Montag",
            "Dienstag",
            "Mittwoch",
            "Donnerstag",
            "Freitag",
            "Samstag"
        ],
        "weekdaysShort": [
            "So",
            "Mo",
            "Di",
            "Mi",
            "Do",
            "Fr",
            "Sa"
        ],
        "meridiem": {
            "am": "am",
            "pm": "pm",
            "AM": "AM",
            "PM": "PM"
        },
        "relative": {
            "future": "%s ab jetzt",
            "past": "vor %s",
            "s": "a second",
            "ss": "%d seconds",
            "m": "a minute",
            "mm": "%d minutes",
            "h": "an hour",
            "hh": "%d hours",
            "d": "a day",
            "dd": "%d days",
            "M": "a month",
            "MM": "%d months",
            "y": "a year",
            "yy": "%d years"
        },
        "startOfWeek": 1
    },
    "formats": {
        "time": "g:i a",
        "date": "F j, Y",
        "datetime": "j. F Y G:i",
        "datetimeAbbreviated": "j. M. Y G:i"
    },
    "timezone": {
        "offset": 0,
        "string": "",
        "abbr": ""
    }
}

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/compat/wordpress-6.4/script-loader.php
❔ lib/load.php

[andrewserong]

Thanks so much for the fix @ramonjd!

✅ Confirmed the missing strings prior to applying this PR
✅ With this PR applied, the settings are identical as without it, except for the additional relative strings (when running JSON.stringify( wp.date.getSettings() ); to compare strings)
✅ Visually, the code here otherwise matches what's in core

LGTM! ✨

[t-hamano]

LGTM!

My concern is that this code might be better written in lib/compat/wordpress-6.4/script-loader.php.

I think this hook expects all relative times to translate correctly on all WordPress versions supported by the Gutenberg plugin. And if the minimum WordPress version that the Gutenberg plugin supports has this code, this hook will not be needed.

I think the lib/compat/wordpres-{X.Y} directory will be removed as the Gutenberg plugin supports more WordPress versions, so you can avoid forgetting to remove this hook.

What do you think?

[ramonjd]

I think this hook expects all relative times to translate correctly on all WordPress versions supported by the Gutenberg plugin. And if the minimum WordPress version that the Gutenberg plugin supports has this code, this hook will not be needed.

Yes, it totally makes more sense to store this under a compat folder. I'll move it there 👍🏻