<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* I18N: WP_Translation_Controller class.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage I18N

[5] Fix | Delete

* @since 6.5.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Class WP_Translation_Controller.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 6.5.0

[12] Fix | Delete

*/

[13] Fix | Delete

final class WP_Translation_Controller {

[14] Fix | Delete

/**

[15] Fix | Delete

* Current locale.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 6.5.0

[18] Fix | Delete

* @var string

[19] Fix | Delete

*/

[20] Fix | Delete

protected $current_locale = 'en_US';

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* Map of loaded translations per locale and text domain.

[24] Fix | Delete

*

[25] Fix | Delete

* [ Locale => [ Textdomain => [ ..., ... ] ] ]

[26] Fix | Delete

*

[27] Fix | Delete

* @since 6.5.0

[28] Fix | Delete

* @var array<string, array<string, WP_Translation_File[]>>

[29] Fix | Delete

*/

[30] Fix | Delete

protected $loaded_translations = array();

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* List of loaded translation files.

[34] Fix | Delete

*

[35] Fix | Delete

* [ Filename => [ Locale => [ Textdomain => WP_Translation_File ] ] ]

[36] Fix | Delete

*

[37] Fix | Delete

* @since 6.5.0

[38] Fix | Delete

* @var array<string, array<string, array<string, WP_Translation_File|false>>>

[39] Fix | Delete

*/

[40] Fix | Delete

protected $loaded_files = array();

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Container for the main instance of the class.

[44] Fix | Delete

*

[45] Fix | Delete

* @since 6.5.0

[46] Fix | Delete

* @var WP_Translation_Controller|null

[47] Fix | Delete

*/

[48] Fix | Delete

private static $instance = null;

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Utility method to retrieve the main instance of the class.

[52] Fix | Delete

*

[53] Fix | Delete

* The instance will be created if it does not exist yet.

[54] Fix | Delete

*

[55] Fix | Delete

* @since 6.5.0

[56] Fix | Delete

*

[57] Fix | Delete

* @return WP_Translation_Controller

[58] Fix | Delete

*/

[59] Fix | Delete

public static function get_instance(): WP_Translation_Controller {

[60] Fix | Delete

if ( null === self::$instance ) {

[61] Fix | Delete

self::$instance = new self();

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

return self::$instance;

[65] Fix | Delete

}

[66] Fix | Delete

[67] Fix | Delete

/**

[68] Fix | Delete

* Returns the current locale.

[69] Fix | Delete

*

[70] Fix | Delete

* @since 6.5.0

[71] Fix | Delete

*

[72] Fix | Delete

* @return string Locale.

[73] Fix | Delete

*/

[74] Fix | Delete

public function get_locale(): string {

[75] Fix | Delete

return $this->current_locale;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Sets the current locale.

[80] Fix | Delete

*

[81] Fix | Delete

* @since 6.5.0

[82] Fix | Delete

*

[83] Fix | Delete

* @param string $locale Locale.

[84] Fix | Delete

*/

[85] Fix | Delete

public function set_locale( string $locale ) {

[86] Fix | Delete

$this->current_locale = $locale;

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Loads a translation file for a given text domain.

[91] Fix | Delete

*

[92] Fix | Delete

* @since 6.5.0

[93] Fix | Delete

*

[94] Fix | Delete

* @param string $translation_file Translation file.

[95] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[96] Fix | Delete

* @param string $locale Optional. Locale. Default current locale.

[97] Fix | Delete

* @return bool True on success, false otherwise.

[98] Fix | Delete

*/

[99] Fix | Delete

public function load_file( string $translation_file, string $textdomain = 'default', ?string $locale = null ): bool {

[100] Fix | Delete

if ( null === $locale ) {

[101] Fix | Delete

$locale = $this->current_locale;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

$translation_file = realpath( $translation_file );

[105] Fix | Delete

[106] Fix | Delete

if ( false === $translation_file ) {

[107] Fix | Delete

return false;

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

if (

[111] Fix | Delete

isset( $this->loaded_files[ $translation_file ][ $locale ][ $textdomain ] ) &&

[112] Fix | Delete

false !== $this->loaded_files[ $translation_file ][ $locale ][ $textdomain ]

[113] Fix | Delete

) {

[114] Fix | Delete

return null === $this->loaded_files[ $translation_file ][ $locale ][ $textdomain ]->error();

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

if (

[118] Fix | Delete

isset( $this->loaded_files[ $translation_file ][ $locale ] ) &&

[119] Fix | Delete

array() !== $this->loaded_files[ $translation_file ][ $locale ]

[120] Fix | Delete

) {

[121] Fix | Delete

$moe = reset( $this->loaded_files[ $translation_file ][ $locale ] );

[122] Fix | Delete

} else {

[123] Fix | Delete

$moe = WP_Translation_File::create( $translation_file );

[124] Fix | Delete

if ( false === $moe || null !== $moe->error() ) {

[125] Fix | Delete

$moe = false;

[126] Fix | Delete

}

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

$this->loaded_files[ $translation_file ][ $locale ][ $textdomain ] = $moe;

[130] Fix | Delete

[131] Fix | Delete

if ( ! $moe instanceof WP_Translation_File ) {

[132] Fix | Delete

return false;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

if ( ! isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {

[136] Fix | Delete

$this->loaded_translations[ $locale ][ $textdomain ] = array();

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

$this->loaded_translations[ $locale ][ $textdomain ][] = $moe;

[140] Fix | Delete

[141] Fix | Delete

return true;

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

/**

[145] Fix | Delete

* Unloads a translation file for a given text domain.

[146] Fix | Delete

*

[147] Fix | Delete

* @since 6.5.0

[148] Fix | Delete

*

[149] Fix | Delete

* @param WP_Translation_File|string $file Translation file instance or file name.

[150] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[151] Fix | Delete

* @param string $locale Optional. Locale. Defaults to all locales.

[152] Fix | Delete

* @return bool True on success, false otherwise.

[153] Fix | Delete

*/

[154] Fix | Delete

public function unload_file( $file, string $textdomain = 'default', ?string $locale = null ): bool {

[155] Fix | Delete

if ( is_string( $file ) ) {

[156] Fix | Delete

$file = realpath( $file );

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

if ( null !== $locale ) {

[160] Fix | Delete

if ( isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {

[161] Fix | Delete

foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $i => $moe ) {

[162] Fix | Delete

if ( $file === $moe || $file === $moe->get_file() ) {

[163] Fix | Delete

unset( $this->loaded_translations[ $locale ][ $textdomain ][ $i ] );

[164] Fix | Delete

unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );

[165] Fix | Delete

return true;

[166] Fix | Delete

}

[167] Fix | Delete

}

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return true;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

foreach ( $this->loaded_translations as $l => $domains ) {

[174] Fix | Delete

if ( ! isset( $domains[ $textdomain ] ) ) {

[175] Fix | Delete

continue;

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

foreach ( $domains[ $textdomain ] as $i => $moe ) {

[179] Fix | Delete

if ( $file === $moe || $file === $moe->get_file() ) {

[180] Fix | Delete

unset( $this->loaded_translations[ $l ][ $textdomain ][ $i ] );

[181] Fix | Delete

unset( $this->loaded_files[ $moe->get_file() ][ $l ][ $textdomain ] );

[182] Fix | Delete

return true;

[183] Fix | Delete

}

[184] Fix | Delete

}

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

return false;

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

/**

[191] Fix | Delete

* Unloads all translation files for a given text domain.

[192] Fix | Delete

*

[193] Fix | Delete

* @since 6.5.0

[194] Fix | Delete

*

[195] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[196] Fix | Delete

* @param string $locale Optional. Locale. Defaults to all locales.

[197] Fix | Delete

* @return bool True on success, false otherwise.

[198] Fix | Delete

*/

[199] Fix | Delete

public function unload_textdomain( string $textdomain = 'default', ?string $locale = null ): bool {

[200] Fix | Delete

$unloaded = false;

[201] Fix | Delete

[202] Fix | Delete

if ( null !== $locale ) {

[203] Fix | Delete

if ( isset( $this->loaded_translations[ $locale ][ $textdomain ] ) ) {

[204] Fix | Delete

$unloaded = true;

[205] Fix | Delete

foreach ( $this->loaded_translations[ $locale ][ $textdomain ] as $moe ) {

[206] Fix | Delete

unset( $this->loaded_files[ $moe->get_file() ][ $locale ][ $textdomain ] );

[207] Fix | Delete

}

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

unset( $this->loaded_translations[ $locale ][ $textdomain ] );

[211] Fix | Delete

[212] Fix | Delete

return $unloaded;

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

foreach ( $this->loaded_translations as $l => $domains ) {

[216] Fix | Delete

if ( ! isset( $domains[ $textdomain ] ) ) {

[217] Fix | Delete

continue;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

$unloaded = true;

[221] Fix | Delete

[222] Fix | Delete

foreach ( $domains[ $textdomain ] as $moe ) {

[223] Fix | Delete

unset( $this->loaded_files[ $moe->get_file() ][ $l ][ $textdomain ] );

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

unset( $this->loaded_translations[ $l ][ $textdomain ] );

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

return $unloaded;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

/**

[233] Fix | Delete

* Determines whether translations are loaded for a given text domain.

[234] Fix | Delete

*

[235] Fix | Delete

* @since 6.5.0

[236] Fix | Delete

*

[237] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[238] Fix | Delete

* @param string $locale Optional. Locale. Default current locale.

[239] Fix | Delete

* @return bool True if there are any loaded translations, false otherwise.

[240] Fix | Delete

*/

[241] Fix | Delete

public function is_textdomain_loaded( string $textdomain = 'default', ?string $locale = null ): bool {

[242] Fix | Delete

if ( null === $locale ) {

[243] Fix | Delete

$locale = $this->current_locale;

[244] Fix | Delete

}

[245] Fix | Delete

[246] Fix | Delete

return isset( $this->loaded_translations[ $locale ][ $textdomain ] ) &&

[247] Fix | Delete

array() !== $this->loaded_translations[ $locale ][ $textdomain ];

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Translates a singular string.

[252] Fix | Delete

*

[253] Fix | Delete

* @since 6.5.0

[254] Fix | Delete

*

[255] Fix | Delete

* @param string $text Text to translate.

[256] Fix | Delete

* @param string $context Optional. Context for the string. Default empty string.

[257] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[258] Fix | Delete

* @param string $locale Optional. Locale. Default current locale.

[259] Fix | Delete

* @return string|false Translation on success, false otherwise.

[260] Fix | Delete

*/

[261] Fix | Delete

public function translate( string $text, string $context = '', string $textdomain = 'default', ?string $locale = null ) {

[262] Fix | Delete

if ( '' !== $context ) {

[263] Fix | Delete

$context .= "\4";

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

$translation = $this->locate_translation( "{$context}{$text}", $textdomain, $locale );

[267] Fix | Delete

[268] Fix | Delete

if ( false === $translation ) {

[269] Fix | Delete

return false;

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

return $translation['entries'][0];

[273] Fix | Delete

}

[274] Fix | Delete

[275] Fix | Delete

/**

[276] Fix | Delete

* Translates plurals.

[277] Fix | Delete

*

[278] Fix | Delete

* Checks both singular+plural combinations as well as just singulars,

[279] Fix | Delete

* in case the translation file does not store the plural.

[280] Fix | Delete

*

[281] Fix | Delete

* @since 6.5.0

[282] Fix | Delete

*

[283] Fix | Delete

* @param array $plurals {

[284] Fix | Delete

* Pair of singular and plural translations.

[285] Fix | Delete

*

[286] Fix | Delete

* @type string $0 Singular translation.

[287] Fix | Delete

* @type string $1 Plural translation.

[288] Fix | Delete

* }

[289] Fix | Delete

* @param int $number Number of items.

[290] Fix | Delete

* @param string $context Optional. Context for the string. Default empty string.

[291] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[292] Fix | Delete

* @param string|null $locale Optional. Locale. Default current locale.

[293] Fix | Delete

* @return string|false Translation on success, false otherwise.

[294] Fix | Delete

*/

[295] Fix | Delete

public function translate_plural( array $plurals, int $number, string $context = '', string $textdomain = 'default', ?string $locale = null ) {

[296] Fix | Delete

if ( '' !== $context ) {

[297] Fix | Delete

$context .= "\4";

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

$text = implode( "\0", $plurals );

[301] Fix | Delete

$translation = $this->locate_translation( "{$context}{$text}", $textdomain, $locale );

[302] Fix | Delete

[303] Fix | Delete

if ( false === $translation ) {

[304] Fix | Delete

$text = $plurals[0];

[305] Fix | Delete

$translation = $this->locate_translation( "{$context}{$text}", $textdomain, $locale );

[306] Fix | Delete

[307] Fix | Delete

if ( false === $translation ) {

[308] Fix | Delete

return false;

[309] Fix | Delete

}

[310] Fix | Delete

}

[311] Fix | Delete

[312] Fix | Delete

/** @var WP_Translation_File $source */

[313] Fix | Delete

$source = $translation['source'];

[314] Fix | Delete

$num = $source->get_plural_form( $number );

[315] Fix | Delete

[316] Fix | Delete

// See \Translations::translate_plural().

[317] Fix | Delete

return $translation['entries'][ $num ] ?? $translation['entries'][0];

[318] Fix | Delete

}

[319] Fix | Delete

[320] Fix | Delete

/**

[321] Fix | Delete

* Returns all existing headers for a given text domain.

[322] Fix | Delete

*

[323] Fix | Delete

* @since 6.5.0

[324] Fix | Delete

*

[325] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[326] Fix | Delete

* @return array<string, string> Headers.

[327] Fix | Delete

*/

[328] Fix | Delete

public function get_headers( string $textdomain = 'default' ): array {

[329] Fix | Delete

if ( array() === $this->loaded_translations ) {

[330] Fix | Delete

return array();

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

$headers = array();

[334] Fix | Delete

[335] Fix | Delete

foreach ( $this->get_files( $textdomain ) as $moe ) {

[336] Fix | Delete

foreach ( $moe->headers() as $header => $value ) {

[337] Fix | Delete

$headers[ $this->normalize_header( $header ) ] = $value;

[338] Fix | Delete

}

[339] Fix | Delete

}

[340] Fix | Delete

[341] Fix | Delete

return $headers;

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

/**

[345] Fix | Delete

* Normalizes header names to be capitalized.

[346] Fix | Delete

*

[347] Fix | Delete

* @since 6.5.0

[348] Fix | Delete

*

[349] Fix | Delete

* @param string $header Header name.

[350] Fix | Delete

* @return string Normalized header name.

[351] Fix | Delete

*/

[352] Fix | Delete

protected function normalize_header( string $header ): string {

[353] Fix | Delete

$parts = explode( '-', $header );

[354] Fix | Delete

$parts = array_map( 'ucfirst', $parts );

[355] Fix | Delete

return implode( '-', $parts );

[356] Fix | Delete

}

[357] Fix | Delete

[358] Fix | Delete

/**

[359] Fix | Delete

* Returns all entries for a given text domain.

[360] Fix | Delete

*

[361] Fix | Delete

* @since 6.5.0

[362] Fix | Delete

*

[363] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[364] Fix | Delete

* @return array<string, string> Entries.

[365] Fix | Delete

*/

[366] Fix | Delete

public function get_entries( string $textdomain = 'default' ): array {

[367] Fix | Delete

if ( array() === $this->loaded_translations ) {

[368] Fix | Delete

return array();

[369] Fix | Delete

}

[370] Fix | Delete

[371] Fix | Delete

$entries = array();

[372] Fix | Delete

[373] Fix | Delete

foreach ( $this->get_files( $textdomain ) as $moe ) {

[374] Fix | Delete

$entries = array_merge( $entries, $moe->entries() );

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

return $entries;

[378] Fix | Delete

}

[379] Fix | Delete

[380] Fix | Delete

/**

[381] Fix | Delete

* Locates translation for a given string and text domain.

[382] Fix | Delete

*

[383] Fix | Delete

* @since 6.5.0

[384] Fix | Delete

*

[385] Fix | Delete

* @param string $singular Singular translation.

[386] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[387] Fix | Delete

* @param string $locale Optional. Locale. Default current locale.

[388] Fix | Delete

* @return array{source: WP_Translation_File, entries: string[]}|false {

[389] Fix | Delete

* Translations on success, false otherwise.

[390] Fix | Delete

*

[391] Fix | Delete

* @type WP_Translation_File $source Translation file instance.

[392] Fix | Delete

* @type string[] $entries Array of translation entries.

[393] Fix | Delete

* }

[394] Fix | Delete

*/

[395] Fix | Delete

protected function locate_translation( string $singular, string $textdomain = 'default', ?string $locale = null ) {

[396] Fix | Delete

if ( array() === $this->loaded_translations ) {

[397] Fix | Delete

return false;

[398] Fix | Delete

}

[399] Fix | Delete

[400] Fix | Delete

// Find the translation in all loaded files for this text domain.

[401] Fix | Delete

foreach ( $this->get_files( $textdomain, $locale ) as $moe ) {

[402] Fix | Delete

$translation = $moe->translate( $singular );

[403] Fix | Delete

if ( false !== $translation ) {

[404] Fix | Delete

return array(

[405] Fix | Delete

'entries' => explode( "\0", $translation ),

[406] Fix | Delete

'source' => $moe,

[407] Fix | Delete

);

[408] Fix | Delete

}

[409] Fix | Delete

if ( null !== $moe->error() ) {

[410] Fix | Delete

// Unload this file, something is wrong.

[411] Fix | Delete

$this->unload_file( $moe, $textdomain, $locale );

[412] Fix | Delete

}

[413] Fix | Delete

}

[414] Fix | Delete

[415] Fix | Delete

// Nothing could be found.

[416] Fix | Delete

return false;

[417] Fix | Delete

}

[418] Fix | Delete

[419] Fix | Delete

/**

[420] Fix | Delete

* Returns all translation files for a given text domain.

[421] Fix | Delete

*

[422] Fix | Delete

* @since 6.5.0

[423] Fix | Delete

*

[424] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[425] Fix | Delete

* @param string $locale Optional. Locale. Default current locale.

[426] Fix | Delete

* @return WP_Translation_File[] List of translation files.

[427] Fix | Delete

*/

[428] Fix | Delete

protected function get_files( string $textdomain = 'default', ?string $locale = null ): array {

[429] Fix | Delete

if ( null === $locale ) {

[430] Fix | Delete

$locale = $this->current_locale;

[431] Fix | Delete

}

[432] Fix | Delete

[433] Fix | Delete

return $this->loaded_translations[ $locale ][ $textdomain ] ?? array();

[434] Fix | Delete

}

[435] Fix | Delete

[436] Fix | Delete

/**

[437] Fix | Delete

* Returns a boolean to indicate whether a translation exists for a given string with optional text domain and locale.

[438] Fix | Delete

*

[439] Fix | Delete

* @since 6.7.0

[440] Fix | Delete

*

[441] Fix | Delete

* @param string $singular Singular translation to check.

[442] Fix | Delete

* @param string $textdomain Optional. Text domain. Default 'default'.

[443] Fix | Delete

* @param ?string $locale Optional. Locale. Default current locale.

[444] Fix | Delete

* @return bool True if the translation exists, false otherwise.

[445] Fix | Delete

*/

[446] Fix | Delete

public function has_translation( string $singular, string $textdomain = 'default', ?string $locale = null ): bool {

[447] Fix | Delete

if ( null === $locale ) {

[448] Fix | Delete

$locale = $this->current_locale;

[449] Fix | Delete

}

[450] Fix | Delete

[451] Fix | Delete

return false !== $this->locate_translation( $singular, $textdomain, $locale );

[452] Fix | Delete

}

[453] Fix | Delete

}

[454] Fix | Delete

[455] Fix | Delete