Download the PHP package yoast/i18n-module without Composer
On this page you can find all versions of the php package yoast/i18n-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download yoast/i18n-module
More information about yoast/i18n-module
Files in yoast/i18n-module
Package i18n-module
Short Description Handle i18n for WordPress plugins.
License GPL-2.0-or-later
Homepage https://github.com/Yoast/i18n-module
Informations about the package i18n-module
⚠️ Update September 28th 2023 ⚠️
We have discontinued development on this project. If you're interested in this module, we happily refer you to a well-maintained fork by @mte90 at https://github.com/WPBP/i18n-notice.
Yoast i18n module
Promote your own translation site for people who are using your plugin in another language than en_US
.
Example of the rendered promo box
The image, the name of your plugin and the name of your translation project are all configurable (see example below). The name of the language is retrieved from your GlotPress install, as is the percentage translated. The box doesn't display when a language has been translated for 90% or more.
How to use this module
Include it in your project using composer:
Alternatively you can include the library as a submodule. Make sure the class is loaded and instantiate it like this:
If the service you are using doesn't follow the GlotPress conventions for the URLs, you may want to pass directly the full api_url
to get the list of available translations, instead of letting the class build it from glotpress_url
:
Because translate.wordpress.org is also a GlotPress installation you can use the i18n-module to promote translation your plugin on there. To do this you can use the dedicated wordpress.org class:
Customize where and when to render the message
Since 3.0.0 you can also decide to render the message in a message-box of your own, just provide the second argument to the constructor as false
to disable the showing of the box by the module itself.