Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getolympus/hermes-translator
Ἑρμῆς — Olympus Hermes Translator is a bundle used to translate all messages from your WordPress website, its plugins and Olympus bundles.
https://github.com/getolympus/hermes-translator
hermes json noop olympus olympus-bundle php translator wordpress
Last synced: about 1 month ago
JSON representation
Ἑρμῆς — Olympus Hermes Translator is a bundle used to translate all messages from your WordPress website, its plugins and Olympus bundles.
- Host: GitHub
- URL: https://github.com/getolympus/hermes-translator
- Owner: GetOlympus
- License: mit
- Created: 2020-02-01T07:29:45.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-10T07:55:17.000Z (almost 5 years ago)
- Last Synced: 2024-12-05T15:49:29.819Z (about 2 months ago)
- Topics: hermes, json, noop, olympus, olympus-bundle, php, translator, wordpress
- Language: PHP
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Olympus Hermes Translator
> **Olympus Hermes Translator** is a bundle used to translate all messages from your WordPress website, its plugins and Olympus bundles.
```sh
composer require getolympus/olympus-hermes-translator
```
---
[![Olympus Component][olympus-image]][olympus-url]
[![CodeFactor Grade][codefactor-image]][codefactor-url]
[![Packagist Version][packagist-image]][packagist-url]
[![MIT][license-image]][license-blob]
---
## Features
+ Better and secure folder structure
+ Dependency management with [**Composer**](https://getcomposer.org)
## How to
You can easily use the `Hermes` translator thanks to its functions:
```php
namespace MyCustomPackage;
use GetOlympus\Hermes\Hermes;
/**
* Load translations.
*
* @param array $translations
* @param string $locale
*/
Hermes::l([
'my-custom-domain' => '/absolute/path/to/custom/domain/directory/languages',
'my-other-domain' => '/absolute/path/to/other/domain/directory/languages',
'my-latest-domain' => '/absolute/path/to/latest/domain/directory/languages',
// (...)
], 'en_US');
/**
* Noop typo from WordPress.
*
* @param string $single
* @param string $plural
* @param integer $number
* @param string $domain
*
* @return string
*/
echo Hermes::n('%s message', '%s messages', 3, 'my-custom-domain');
/**
* Prepare noop typo from WordPress.
*
* @param string $single
* @param string $plural
*
* @return string
*/
echo Hermes::noop('My %s uniq message', 'My %s messages', 'my-custom-domain');
/**
* Translate typo.
*
* @param string $message
* @param string $domain
*
* @return string
*/
echo Hermes::t('My custom message to translate', 'my-custom-domain');
```
## Release History
See [**CHANGELOG.md**][changelog-blob] for all details.
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new Pull Request
---
**Built with ♥ by [Achraf Chouk](http://github.com/crewstyle "Achraf Chouk") ~ (c) since a long time.**
[olympus-image]: https://img.shields.io/badge/for-Olympus-44cc11.svg?style=flat-square
[olympus-url]: https://github.com/GetOlympus
[changelog-blob]: https://github.com/GetOlympus/Hermes-Translator/blob/master/CHANGELOG.md
[codefactor-image]: https://www.codefactor.io/repository/github/GetOlympus/Hermes-Translator/badge?style=flat-square
[codefactor-url]: https://www.codefactor.io/repository/github/getolympus/Hermes-Translator
[license-blob]: https://github.com/GetOlympus/Hermes-Translator/blob/master/LICENSE
[license-image]: https://img.shields.io/badge/license-MIT_License-blue.svg?style=flat-square
[packagist-image]: https://img.shields.io/packagist/v/getolympus/olympus-Hermes-Translator.svg?style=flat-square
[packagist-url]: https://packagist.org/packages/getolympus/olympus-Hermes-Translator