<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Locale API: WP_Locale_Switcher class

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage i18n

[5] Fix | Delete

* @since 4.7.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Core class used for switching locales.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 4.7.0

[12] Fix | Delete

*/

[13] Fix | Delete

#[AllowDynamicProperties]

[14] Fix | Delete

class WP_Locale_Switcher {

[15] Fix | Delete

/**

[16] Fix | Delete

* Locale switching stack.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 6.2.0

[19] Fix | Delete

* @var array

[20] Fix | Delete

*/

[21] Fix | Delete

private $stack = array();

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Original locale.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 4.7.0

[27] Fix | Delete

* @var string

[28] Fix | Delete

*/

[29] Fix | Delete

private $original_locale;

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Holds all available languages.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 4.7.0

[35] Fix | Delete

* @var string[] An array of language codes (file names without the .mo extension).

[36] Fix | Delete

*/

[37] Fix | Delete

private $available_languages;

[38] Fix | Delete

[39] Fix | Delete

/**

[40] Fix | Delete

* Constructor.

[41] Fix | Delete

*

[42] Fix | Delete

* Stores the original locale as well as a list of all available languages.

[43] Fix | Delete

*

[44] Fix | Delete

* @since 4.7.0

[45] Fix | Delete

*/

[46] Fix | Delete

public function __construct() {

[47] Fix | Delete

$this->original_locale = determine_locale();

[48] Fix | Delete

$this->available_languages = array_merge( array( 'en_US' ), get_available_languages() );

[49] Fix | Delete

}

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Initializes the locale switcher.

[53] Fix | Delete

*

[54] Fix | Delete

* Hooks into the {@see 'locale'} and {@see 'determine_locale'} filters

[55] Fix | Delete

* to change the locale on the fly.

[56] Fix | Delete

*

[57] Fix | Delete

* @since 4.7.0

[58] Fix | Delete

*/

[59] Fix | Delete

public function init() {

[60] Fix | Delete

add_filter( 'locale', array( $this, 'filter_locale' ) );

[61] Fix | Delete

add_filter( 'determine_locale', array( $this, 'filter_locale' ) );

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Switches the translations according to the given locale.

[66] Fix | Delete

*

[67] Fix | Delete

* @since 4.7.0

[68] Fix | Delete

*

[69] Fix | Delete

* @param string $locale The locale to switch to.

[70] Fix | Delete

* @param int|false $user_id Optional. User ID as context. Default false.

[71] Fix | Delete

* @return bool True on success, false on failure.

[72] Fix | Delete

*/

[73] Fix | Delete

public function switch_to_locale( $locale, $user_id = false ) {

[74] Fix | Delete

$current_locale = determine_locale();

[75] Fix | Delete

if ( $current_locale === $locale ) {

[76] Fix | Delete

return false;

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

if ( ! in_array( $locale, $this->available_languages, true ) ) {

[80] Fix | Delete

return false;

[81] Fix | Delete

}

[82] Fix | Delete

[83] Fix | Delete

$this->stack[] = array( $locale, $user_id );

[84] Fix | Delete

[85] Fix | Delete

$this->change_locale( $locale );

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Fires when the locale is switched.

[89] Fix | Delete

*

[90] Fix | Delete

* @since 4.7.0

[91] Fix | Delete

* @since 6.2.0 The `$user_id` parameter was added.

[92] Fix | Delete

*

[93] Fix | Delete

* @param string $locale The new locale.

[94] Fix | Delete

* @param false|int $user_id User ID for context if available.

[95] Fix | Delete

*/

[96] Fix | Delete

do_action( 'switch_locale', $locale, $user_id );

[97] Fix | Delete

[98] Fix | Delete

return true;

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

/**

[102] Fix | Delete

* Switches the translations according to the given user's locale.

[103] Fix | Delete

*

[104] Fix | Delete

* @since 6.2.0

[105] Fix | Delete

*

[106] Fix | Delete

* @param int $user_id User ID.

[107] Fix | Delete

* @return bool True on success, false on failure.

[108] Fix | Delete

*/

[109] Fix | Delete

public function switch_to_user_locale( $user_id ) {

[110] Fix | Delete

$locale = get_user_locale( $user_id );

[111] Fix | Delete

return $this->switch_to_locale( $locale, $user_id );

[112] Fix | Delete

}

[113] Fix | Delete

[114] Fix | Delete

/**

[115] Fix | Delete

* Restores the translations according to the previous locale.

[116] Fix | Delete

*

[117] Fix | Delete

* @since 4.7.0

[118] Fix | Delete

*

[119] Fix | Delete

* @return string|false Locale on success, false on failure.

[120] Fix | Delete

*/

[121] Fix | Delete

public function restore_previous_locale() {

[122] Fix | Delete

$previous_locale = array_pop( $this->stack );

[123] Fix | Delete

[124] Fix | Delete

if ( null === $previous_locale ) {

[125] Fix | Delete

// The stack is empty, bail.

[126] Fix | Delete

return false;

[127] Fix | Delete

}

[128] Fix | Delete

[129] Fix | Delete

$entry = end( $this->stack );

[130] Fix | Delete

$locale = is_array( $entry ) ? $entry[0] : false;

[131] Fix | Delete

[132] Fix | Delete

if ( ! $locale ) {

[133] Fix | Delete

// There's nothing left in the stack: go back to the original locale.

[134] Fix | Delete

$locale = $this->original_locale;

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

$this->change_locale( $locale );

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Fires when the locale is restored to the previous one.

[141] Fix | Delete

*

[142] Fix | Delete

* @since 4.7.0

[143] Fix | Delete

*

[144] Fix | Delete

* @param string $locale The new locale.

[145] Fix | Delete

* @param string $previous_locale The previous locale.

[146] Fix | Delete

*/

[147] Fix | Delete

do_action( 'restore_previous_locale', $locale, $previous_locale[0] );

[148] Fix | Delete

[149] Fix | Delete

return $locale;

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Restores the translations according to the original locale.

[154] Fix | Delete

*

[155] Fix | Delete

* @since 4.7.0

[156] Fix | Delete

*

[157] Fix | Delete

* @return string|false Locale on success, false on failure.

[158] Fix | Delete

*/

[159] Fix | Delete

public function restore_current_locale() {

[160] Fix | Delete

if ( empty( $this->stack ) ) {

[161] Fix | Delete

return false;

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

$this->stack = array( array( $this->original_locale, false ) );

[165] Fix | Delete

[166] Fix | Delete

return $this->restore_previous_locale();

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

/**

[170] Fix | Delete

* Whether switch_to_locale() is in effect.

[171] Fix | Delete

*

[172] Fix | Delete

* @since 4.7.0

[173] Fix | Delete

*

[174] Fix | Delete

* @return bool True if the locale has been switched, false otherwise.

[175] Fix | Delete

*/

[176] Fix | Delete

public function is_switched() {

[177] Fix | Delete

return ! empty( $this->stack );

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/**

[181] Fix | Delete

* Returns the locale currently switched to.

[182] Fix | Delete

*

[183] Fix | Delete

* @since 6.2.0

[184] Fix | Delete

*

[185] Fix | Delete

* @return string|false Locale if the locale has been switched, false otherwise.

[186] Fix | Delete

*/

[187] Fix | Delete

public function get_switched_locale() {

[188] Fix | Delete

$entry = end( $this->stack );

[189] Fix | Delete

[190] Fix | Delete

if ( $entry ) {

[191] Fix | Delete

return $entry[0];

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

return false;

[195] Fix | Delete

}

[196] Fix | Delete

[197] Fix | Delete

/**

[198] Fix | Delete

* Returns the user ID related to the currently switched locale.

[199] Fix | Delete

*

[200] Fix | Delete

* @since 6.2.0

[201] Fix | Delete

*

[202] Fix | Delete

* @return int|false User ID if set and if the locale has been switched, false otherwise.

[203] Fix | Delete

*/

[204] Fix | Delete

public function get_switched_user_id() {

[205] Fix | Delete

$entry = end( $this->stack );

[206] Fix | Delete

[207] Fix | Delete

if ( $entry ) {

[208] Fix | Delete

return $entry[1];

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

return false;

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

/**

[215] Fix | Delete

* Filters the locale of the WordPress installation.

[216] Fix | Delete

*

[217] Fix | Delete

* @since 4.7.0

[218] Fix | Delete

*

[219] Fix | Delete

* @param string $locale The locale of the WordPress installation.

[220] Fix | Delete

* @return string The locale currently being switched to.

[221] Fix | Delete

*/

[222] Fix | Delete

public function filter_locale( $locale ) {

[223] Fix | Delete

$switched_locale = $this->get_switched_locale();

[224] Fix | Delete

[225] Fix | Delete

if ( $switched_locale ) {

[226] Fix | Delete

return $switched_locale;

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

return $locale;

[230] Fix | Delete

}

[231] Fix | Delete

[232] Fix | Delete

/**

[233] Fix | Delete

* Load translations for a given locale.

[234] Fix | Delete

*

[235] Fix | Delete

* When switching to a locale, translations for this locale must be loaded from scratch.

[236] Fix | Delete

*

[237] Fix | Delete

* @since 4.7.0

[238] Fix | Delete

*

[239] Fix | Delete

* @global Mo[] $l10n An array of all currently loaded text domains.

[240] Fix | Delete

*

[241] Fix | Delete

* @param string $locale The locale to load translations for.

[242] Fix | Delete

*/

[243] Fix | Delete

private function load_translations( $locale ) {

[244] Fix | Delete

global $l10n;

[245] Fix | Delete

[246] Fix | Delete

$domains = $l10n ? array_keys( $l10n ) : array();

[247] Fix | Delete

[248] Fix | Delete

load_default_textdomain( $locale );

[249] Fix | Delete

[250] Fix | Delete

foreach ( $domains as $domain ) {

[251] Fix | Delete

// The default text domain is handled by `load_default_textdomain()`.

[252] Fix | Delete

if ( 'default' === $domain ) {

[253] Fix | Delete

continue;

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

/*

[257] Fix | Delete

* Unload current text domain but allow them to be reloaded

[258] Fix | Delete

* after switching back or to another locale.

[259] Fix | Delete

*/

[260] Fix | Delete

unload_textdomain( $domain, true );

[261] Fix | Delete

get_translations_for_domain( $domain );

[262] Fix | Delete

}

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

/**

[266] Fix | Delete

* Changes the site's locale to the given one.

[267] Fix | Delete

*

[268] Fix | Delete

* Loads the translations, changes the global `$wp_locale` object and updates

[269] Fix | Delete

* all post type labels.

[270] Fix | Delete

*

[271] Fix | Delete

* @since 4.7.0

[272] Fix | Delete

*

[273] Fix | Delete

* @global WP_Locale $wp_locale WordPress date and time locale object.

[274] Fix | Delete

* @global PHPMailer\PHPMailer\PHPMailer $phpmailer

[275] Fix | Delete

*

[276] Fix | Delete

* @param string $locale The locale to change to.

[277] Fix | Delete

*/

[278] Fix | Delete

private function change_locale( $locale ) {

[279] Fix | Delete

global $wp_locale, $phpmailer;

[280] Fix | Delete

[281] Fix | Delete

$this->load_translations( $locale );

[282] Fix | Delete

[283] Fix | Delete

$wp_locale = new WP_Locale();

[284] Fix | Delete

[285] Fix | Delete

WP_Translation_Controller::get_instance()->set_locale( $locale );

[286] Fix | Delete

[287] Fix | Delete

if ( $phpmailer instanceof WP_PHPMailer ) {

[288] Fix | Delete

$phpmailer->SetLanguage();

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

/**

[292] Fix | Delete

* Fires when the locale is switched to or restored.

[293] Fix | Delete

*

[294] Fix | Delete

* @since 4.7.0

[295] Fix | Delete

*

[296] Fix | Delete

* @param string $locale The new locale.

[297] Fix | Delete

*/

[298] Fix | Delete

do_action( 'change_locale', $locale );

[299] Fix | Delete

}

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete