\MatthiasWeb\UtilsPackageLocalization

Base i18n management for backend and frontend for a package.

For non-utils packages you need to extend from this class and properly fill the constructor.

Summary

Methods
Properties
Constants
getLanguageFromFile()
load_textdomain_mofile()
hooks()
getPotLanguages()
getRootSlug()
getPackage()
getPackageDir()
instance()
$PACKAGE_INFO_FRONTEND
$PACKAGE_INFO_BACKEND
No constants found
getPackageInfo()
__construct()
No protected properties found
N/A
No private methods found
$rootSlug
$packageDir
N/A

Properties

$PACKAGE_INFO_FRONTEND

$PACKAGE_INFO_FRONTEND :

Type

$PACKAGE_INFO_BACKEND

$PACKAGE_INFO_BACKEND :

Type

$rootSlug

$rootSlug :

Type

$packageDir

$packageDir :

Type

Methods

getLanguageFromFile()

getLanguageFromFile(string  $file)

Obtain language key from a file name.

Parameters

string $file

load_textdomain_mofile()

load_textdomain_mofile(string  $mofile,string  $domain)

Never load `.mo` files from `wp-content/plugins/languages` as we do manage all our translations ourself.

TODO: make this configurable per plugin?

Parameters

string $mofile
string $domain

hooks()

hooks()

Add filters to WordPress runtime.

getPotLanguages()

getPotLanguages()

Get the languages which are available in the POT file. Why multiple? Imagine you want to use the pot file for `en_US` and `en_GB`. This can be useful for the `@devowl-wp/multilingual` package, especially the `TemporaryTextDomain` feature.

getRootSlug()

getRootSlug(): string

Getter.

Returns

string

getPackage()

getPackage(): string

Get package name.

Returns

string

getPackageDir()

getPackageDir(): string

Getter.

Returns

string

instance()

instance(string  $rootSlug,string  $packageDir): \MatthiasWeb\Utils\PackageLocalization

New instance.

Parameters

string $rootSlug
string $packageDir

Returns

\MatthiasWeb\Utils\PackageLocalization

getPackageInfo()

getPackageInfo(string  $type): array<mixed,string>

Get the directory where the languages folder exists.

Parameters

string $type

Returns

array<mixed,string>

__construct()

__construct(string  $rootSlug,string  $packageDir)

C'tor.

Parameters

string $rootSlug

Your workspace scope name.

string $packageDir

Absolute path to your package.