Prequel
Over the last few releases, WordPress has made huge steps in prioritizing internationalization and localization throughout around core Core is the set of software required to run WordPress. The Core Development Team builds WordPress.. To name a few highlights: language packs for core, language packs for plugins and themes, a language chooser, just-in-time loading for translations, and a user-specific language setting. But core isn’t the only place improvements have been made.
translate.wordpress.org is the platform for making WordPress available in as many languages as possible. Did you know that WordPress 4.6 is currently translated into 72 – s e v e n t y t w o – languages? Recently the number of unique translators passed the 10k mark. 🌎🌍🌏
The platform is powered by GlotPress, a collaborative, web-based software translation The process (or result) of changing text, words, and display formatting to support another language. Also see localization, internationalization. tool.
Internationalization is not a feature, it fixes a usability issue for many users whose primary language is not English. And that’s about 47% of our users.
The next big thing
As of today, WordPress doesn’t support a proper internationalization API An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. in JavaScript JavaScript or JS is an object-oriented computer programming language commonly used to create interactive effects within web browsers. WordPress makes extensive use of JS for a better user experience. While PHP is executed on the server, JS executes within a user’s browser. https://www.javascript.com/.. There are two, 4-year old tickets, #22229 and #20491, which request such an API. (The former one was closed as a duplicate of #20491 since an internationalization API in JavaScript should provide support for plurals by default.)
And that’s what this post is about: JavaScript Internationalization.
@swissspidy and I (@ocean90) have been thinking about and working on this topic, and now is the time to gather feedback on the direction and get help from everyone interested.
As you may have noticed in the prequel, internationalization spans more than WordPress core. We’ve split the task into four areas: Core, GlotPress, wp-i18n Internationalization, or the act of writing and preparing code to be fully translatable into other languages. Also see localization. Often written with a lowercase i so it is not confused with a lowercase L or the numeral 1. Often an acquired skill.-tools, and language packs.
Jed and wp.i18n (Core)
Since we didn’t want to reinvent any wheels, our proposal is to use Jed as the base library. Jed provides “Gettext Style i18n for Modern JavaScript Apps”.
wp.i18n
will be a wrapper for Jed and should be used by WordPress and plugins/themes. One of the biggest benefits of leveraging Jed is that the actual implementation is very similar to the one we already have for PHP The web scripting language in which WordPress is primarily architected. WordPress requires PHP 7.4 or higher code. The latest patch currently introduces these API functions:
wp.i18n.getLocale()
wp.i18n.loadLocaleData( data )
wp.i18n.addTranslations( domain, data )
wp.i18n.__( text, domain )
wp.i18n._x( text, context, domain )
wp.i18n._n( single, plural, number, domain )
wp.i18n._nx( single, plural, number, context, domain )
wp.i18n.esc_attr__( text, domain )
wp.i18n.esc_html__( text, domain )
wp.i18n.esc_attr_x( text, context, domain )
wp.i18n.esc_html_x( text, context, domain )
wp.i18n.numberFormat( number, decimals )
To do
- Rethink
WP_Scripts::load_translation_file()
and get_js_i18n_data()
, add tests.
- Get feedback on the proposed API. (That’s this post!)
- Apply the new API in our JS JavaScript, a web scripting language typically executed in the browser. Often used for advanced user interfaces and behaviors. files.
- There’s a POC patch that can be worked upon.
- Do not forget: Underscore templates.
- Include date of json JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML. files in update requests for language packs.
- See
wp_get_installed_translations()
.
- See
wp_get_json_file_data()
, maybe json_decode
() might be enough for this case.
- What’s the format for meta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. data? See this GitHub issue for discussion.
sprintf()
in JavaScript – useful for core?
- Ticket Created for both bug reports and feature development on the bug tracker.: #38147
GlotPress (translate.wordpress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/)
Jed supports JSON for translation files. GlotPress currently doesn’t support exporting translations in a JSON format. But there is a pull request which adds the required functionality to GlotPress. The format is going to support “simple” JSON (key -> value) and a Jed 1.x compatible format. The latter will be used by wp.i18n
.
To do
Get the PR merged. Done. 🎉
- Find a solution for the missing meta data, see the GitHub issue mentioned before.
- To enable exports like “get all translations for file common.js”, the current filter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. system in GlotPress needs to be improved to support search only in file references and search for multiple file references.
wp-i18n-tools (Meta)
A script named MakePOT parses PHP files to extract the original strings and their file references. This script needs to be extended to also parse JavaScript files. A POC has been created.
To do
- Convert the POC into nice code with tests.
- Fix #20881 because it’s important for the GlotPress export that all file references remain.
Language Packs (Meta)
Currently a language pack includes a .po and a .mo file. Support needs to be added so that a .json file gets bundled if a project has translations for JavaScript files.
To do
- Export Jed files when JS translations exist.
- Include JSON file in language packs.
- Update API to support version checks for JSON files.
Feedback
Thanks for reading, now it’s your turn. 🙂 Do you have any feedback? Are there things we should do differently? Do you have resources to help us? Please let us know in the comments!
There are currently no meetings scheduled but we’re happy to discuss any topics in #core-i18n. Just say “Hi”!
#i18n, #javascript