brightnucleus/localization

WordPress localization for Bright Nucleus components.

Bright Nucleus Localization

, _(*1)

WordPress localization for Bright Nucleus components., _(*2)

Table Of Contents

• Installation
• Basic Usage
• Filters
• Contributing
• License

Installation

The best way to use this package is through Composer:, _(*3)

composer require brightnucleus/localization

Basic Usage

This package provides a trait to be used within Bright Nucleus components to load the translation files (compiled *.mo-files) for a given locale., _(*4)

To use the trait, import it into your class, and call the loadLocalization( $domain, $path ) method., _(*5)

Example:, _(*6)

<?php namespace Localization\Example;

use BrightNucleus\Localization\LocalizationTrait;

class TranslatedClass {

    use LocalizationTrait;

    public function register() {

        $this->loadLocalization(
            'bn-localization-example',
            __DIR__ . '/../languages'
        );

        // Your normal registration comes here, knowing that all `gettext`
        // strings have already been translated.
    }
}

Filters

Each loading of localization files passes through two filters:, _(*7)

1. Localization::LOCALE_FILTER - Filter the locale of a Bright Nucleus library., _(*8)

   Arguments:, _(*9)

   • $locale (string) - The plugin's current locale.
   • $domain (string) - Text domain. Unique identifier for retrieving translated strings.

   Return value:, _(*10)

   • $locale (string) - Filtered locale.

2. Localization::MOFILE_FILTER - Filter the name of the MO-file of a Bright Nucleus library., _(*11)

   Arguments:, _(*12)

   • $path (string) - Path to the MO-file.
   • $locale (string) - The plugin's current locale.
   • $domain (string) - Text domain. Unique identifier for retrieving translated strings.

   Return value:, _(*13)

   • $path (string) - Fitlered path to the MO-file.

Contributing

All feedback / bug reports / pull requests are welcome., _(*14)

License

Copyright (c) 2016 Alain Schlesser, Bright Nucleus, _(*15)

This code is licensed under the MIT License., _(*16)