This extension implements options to make Magento 2 stores compatible with Japanese locales with full translations. Supports Japanese names and addresses, prefectures, fonts, currency, and more. From Community Engineering and Veriteworks.
OverviewBack to top
Magento Community Engineering is happy to present the Japanese Localization extension - a collaboration between Magento Community Engineering and Veriteworks Inc. This combination of modules implements basic modifications required to make a Magento 2 installation compatible with Japanese locales with full Japanese translations.
These features provide Hiragana and Katakana name support, Japanese address formats and prefectures, automatic populating of address information for entered postal codes, Japanese fonts for PDF generation, currency support, and much more. Payment provider integration is not included in this extension.
The modifications are intentionally basic to give extension builders and solution providers an opportunity to extend features and a base for developing truly sublime experiences. After installation, Japanese translations of all standard text strings will be applied to the Admin and Storefront, including necessary changes in data and the UI to accommodate local standards and formatting.
Storefront & Admin Panel Japanese Translation
The localization package shipped with the Japanese Localization extension provides translations developed by the Magento Community through the Magento Crowdin project. Translations include Open Source Admin and Storefront strings.
Japanese System Configuration
The CommunityEngineering_JapaneseDefaultConfig module provides common configurations to apply Japanese stores such as locale, time zone, measurement units, currency, etc.
Hiragana & Katakana For Names
Japanese names usually written with Kanji do not provide enough information for addressing customers in conversations. Hiragana and Katakana adds phonetic information about customer names.
The CommunityEngineering_JapaneseName module extends customer contact and address forms as well as address forms at checkout and admin panel with fields that accept Hiragana, Katakana, or both to specify correct spelling of customer name.
Behavior of implementation may be changed at Admin Panel at Stores > Settings > Configuration > Customers > Customer Configuration > Name Kana Options:
- Use Kana — defines if kana fields will be displayed for the customer.
- Require Kana on frontend — defines if Kana is required for customer information.
- Acceptable Kana character type on frontend — specifies the allowed Kana syllabary for customer information. Options include Only Katakana, Only Hiragana, and Both.
Japanese Prefectures Dictionary
The CommunityEngineering_JapaneseRegion module adds and displays a list of Japanese prefectures in a traditional order from north to south.
Japanese Postal Codes
The CommunityEngineering_JapanesePostalCode module automatically populates address fields such as prefecture, city, and street based on the entered postal code.
Japanese Addresses Format
The CommunityEngineering_JapaneseAddress module provides several improvements to addresses forms and display formats. It applies Japanese traditional address formatting. It also rearranges fields on all address input forms to correspond to a common Japanese order.
By default for Japanese customers, the address is required to register to a site. You can configure this setting at Stores > Settings > Configuration > Customers > Customer Configuration > Create New Account Options > Show Address on Customer Registration Form.
As current implementations are limited to only stores with Japan as a target market, the country field is hidden on address forms on the Storefront by default. You can configure this setting at Stores > Settings > Configuration > Customers > Customer Configuration > Name and Address Options > Show Country.
Configurable Store Address
By default, Magento renders the store address in USA format. The CommunityEngineering_JapaneseStoreAddress supports a traditional Japanese address formatting.
Configure the format through the Admin at Stores > Settings > Configuration > General > General > Store Address Template.
PDF Generation With Japanese Fonts
Default Magento implementation of PDF generation does not support Japanese characters. To solve this limitation, Japanese Localization extension ships the CommunityEngineering_ConfigurablePdfFont that allows to change fonts for Admin PDF generation.
The font used in PDF generation is used from the list of available at Stores > Settings > Configuration > Sales > PDF Print-outs > Font > Font.
Note: Each module containing fonts has a non-standard Magento License and is licensed according to font requirements.
More Accurate Handling Of Currency Precision
The CommunityEngineering_CurrencyPrecision module adds improvements to the Magento Open Source modules to handle currencies without subunits or with subunits that are not 1/100 from major currency. The implementation uses the ICU library and does not require additional configuration.
The Rounding method for currencies may be configured at Stores > Settings > Configuration > General > Currency Setup > Currency Options. Options:
- Up — round away from zero.
- Ceiling — round towards positive infinity.
- Down — round towards zero. (default)
- Floor — round towards negative infinity.
- Half Down — round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.
- Half Even — round towards "nearest neighbor" unless both neighbors are equidistant, in which case round towards the even neighbor.
- Half Up — round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.
Configurable Japanese Yen Formatting
Japanese Yens may be formatted in several ways. CommunityEngineering_JapaneseYenFormatting provides possibility for administrator to switch from international (￥123) to local (123 円) format at Stores > Settings > Configuration > General > Currency Setup > Japanese Yen Formatting.
Human Readable URLs With Japanese Characters
Magento applies special rules to transform titles of products, product categories, and CMS pages to default URLs. As part of transformation, all text is transliterated to ASCII symbols.
With Japanese text, transformations can be complicated and difficult to define conventional transliteration rules for Kanji. To solve this limitation, the CommunityEngineering_JapaneseUrlRewrite module provides the capability to transliterate Katakana and Hiragana names and use Kanji names in URLs. All modern browsers correctly handle national symbols in URLs, and the user sees the correct text in a browser bar instead of URL encoded symbols.
Japanese Tokenizer For Elasticsearch
The default Elasticsearch tokenizer used by Magento is unable to parse Japanese text and leads to incorrect search results. The CommunityEngineering_Kuromoji module configures Elasticsearch to use a proper tokenizer. To use this module, your system administrator should also install Japanese (kuromoji) Analysis Plugin for Elasticsearch.
Elasticsearch with installed Kuromoji plugin is recommended search engine for Japanese merchants. Yet, it is possible to use MySQL search. But in this case MySQL 5.7 or above should be used with installed MeCab Full-Text Parser Plugin.
The Japanese Localization extension consists of independent modules, each one providing features and may be used separately. For the best experience of Japanese customers and merchants, we recommend using the entire suite.
To install all Japanese Localization modules, install the available extension through Marketplace or install with a single line Composer package:
For Elasticsearch support, we recommend installing the Japanese (kuromoji) Analysis Plugin.
Please use the GitHub repository to track the ongoing development of the extension or submit reproducible issues.
To discuss the extension with the Magento Community Engineering team and our amazing family of contributors, join the #japanese-localization channel in the Magento Community Engineering Slack Workspace.
This extension is developed, maintained, and supported by the Magento Community Engineering team. Support SLA is not offered for this extension. If you have high support requirements, please make sure your development team is able to cover additional support.
We would like to thank our friends at Veriteworks Inc. and Hirokazu Nishi personally for contributing their code that became the basis of this extension, as well as for providing help and ongoing support in refactoring it and getting it to a stable and shippable state. Arigato, Nishi-san!
Release NotesBack to top
- Compatible with Open Source (CE) : 2.3
- Stability: Beta Build
- Added Magento_CheckoutAddressSearch compatibility
- Added multisite support
- Improved documentation
- Fixed customer export error on customer grid page
- Fixed OrderKanaLoad feature
- Fixed issue with missing method argument type
- Fixed PDF font and checkout template
- Compatible with Open Source (CE) : 2.3
- Stability: Beta Build
- Japanese translations
- Japanese system configuration
- Japanese addresses and names support
- Japanese PDF generation and fonts
- Japanese currency support
- Japanese tokenizer for Elasticsearch
- Human readable URLs with Japanese characters