Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I18N: localize 'jS' to day+ordinal in 'date_i18n' #7975

Open
wants to merge 6 commits into
base: trunk
Choose a base branch
from

Conversation

jayaddison
Copy link

The built-in PHP NumberFormatter can localize numbers to include ordinal suffixes; however the return value always includes both the numeric value and also the suffix -- e.g. it is not currently possible to request only the suffix.

In the case of date formatting, it's fairly typical that if ordinals are expected, then they will be output for the calendar day number (e.g. the 11 in 2024-01-11) - and that the suffix should appear directly adjacent (e.g. 11th).

Day-of-month should be restricted to values no larger than 31, and should all be integer values, so we shouldn't need to worry about any locale-specific introduction of thousands or decimal place markers.

Based on the above, we can implement limited/restricted localization of day-number-plus-ordinal-suffix in the WordPress date_i18n function by special-case detecting an S (ordinal format) character symbol immediately preceded by a j (day of the month) format code.

Trac ticket: https://core.trac.wordpress.org/ticket/22225


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

The built-in PHP `NumberFormatter` can localize numbers to include
ordinal suffixes; however the return value always includes both the
numeric value and also the suffix -- e.g. it is not currently
possible to request only the suffix.

In the case of date formatting, it's fairly typical that if
ordinals are expected, then they will be output for the calendar
day number (e.g. the `11` in `2024-01-11`) - and that the suffix
should appear directly adjacent (e.g. `11th`).

Day-of-month should be restricted to values no larger than `31`, and
should all be integer values, so we shouldn't need to worry about any
locale-specific introduction of thousands or decimal place markers.

Based on the above, we can implement limited/restricted localization
of day-number-plus-ordinal-suffix in the WordPress `date_i18n`
function by special-case detecting an `S` (ordinal format) character
symbol immediately preceded by a `j` (day of the month) format code.

Refs:
- https://www.php.net/manual/en/class.numberformatter.php
- https://www.php.net/manual/en/datetime.format.php

Closes: https://core.trac.wordpress.org/ticket/22225
Copy link

github-actions bot commented Dec 8, 2024

Hi @jayaddison! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

Copy link

github-actions bot commented Dec 8, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @jayaddison.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

github-actions bot commented Dec 8, 2024

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@jayaddison

This comment was marked as resolved.

@jayaddison jayaddison marked this pull request as draft December 8, 2024 16:45
@jayaddison
Copy link
Author

(also: the documentation will need to be updated alongside this modification)

@jayaddison

This comment was marked as resolved.

@jayaddison jayaddison marked this pull request as ready for review December 8, 2024 17:48
@jayaddison
Copy link
Author

The error that appears is:

With the latest pushed commits in this PR, this error is resolved - a NumberFormatter is only constructed if the class exists (in the global namespace) according to check_exists.

One other question I have is whether the logic, if acceptable (it's not exactly an elegant solution) should use get_locale or get_user_locale -- I'm not sure about that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant