return apply_filters( 'locale', $locale );
}
+/**
+ * Retrieves the locale of a user.
+ *
+ * If the user has a locale set to a non-empty string then it will be
+ * returned. Otherwise it returns the locale of get_locale().
+ *
+ * @since 4.7.0
+ *
+ * @param int|WP_User $user_id User's ID or a WP_User object. Defaults to current user.
+ * @return string The locale of the user.
+ */
+function get_user_locale( $user_id = 0 ) {
+ $user = false;
+ if ( 0 === $user_id && function_exists( 'wp_get_current_user' ) ) {
+ $user = wp_get_current_user();
+ } elseif ( $user_id instanceof WP_User ) {
+ $user = $user_id;
+ } elseif ( $user_id && is_numeric( $user_id ) ) {
+ $user = get_user_by( 'id', $user_id );
+ }
+
+ if ( ! $user ) {
+ return get_locale();
+ }
+
+ $locale = $user->locale;
+ return $locale ? $locale : get_locale();
+}
+
/**
* Retrieve the translation of $text.
*
*/
function translate( $text, $domain = 'default' ) {
$translations = get_translations_for_domain( $domain );
- $translations = $translations->translate( $text );
+ $translation = $translations->translate( $text );
/**
* Filters text with its translation.
*
* @since 2.0.11
*
- * @param string $translations Translated text.
+ * @param string $translation Translated text.
* @param string $text Text to translate.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
- return apply_filters( 'gettext', $translations, $text, $domain );
+ return apply_filters( 'gettext', $translation, $text, $domain );
}
/**
*/
function translate_with_gettext_context( $text, $context, $domain = 'default' ) {
$translations = get_translations_for_domain( $domain );
- $translations = $translations->translate( $text, $context );
+ $translation = $translations->translate( $text, $context );
/**
* Filters text with its translation based on context information.
*
* @since 2.8.0
*
- * @param string $translations Translated text.
+ * @param string $translation Translated text.
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
- return apply_filters( 'gettext_with_context', $translations, $text, $context, $domain );
+ return apply_filters( 'gettext_with_context', $translation, $text, $context, $domain );
}
/**
*
* Example:
*
- * $people = sprintf( _n( '%s person', '%s people', $count, 'text-domain' ), number_format_i18n( $count ) );
+ * printf( _n( '%s person', '%s people', $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.8.0
*
*/
function _n( $single, $plural, $number, $domain = 'default' ) {
$translations = get_translations_for_domain( $domain );
- $translation = $translations->translate_plural( $single, $plural, $number );
+ $translation = $translations->translate_plural( $single, $plural, $number );
/**
* Filters the singular or plural form of a string.
* Used when you want to use the appropriate form of a string with context based on whether a
* number is singular or plural.
*
- * Example:
+ * Example of a generic phrase which is disambiguated via the context parameter:
*
- * $people = sprintf( _n( '%s person', '%s people', $count, 'context', 'text-domain' ), number_format_i18n( $count ) );
+ * printf( _nx( '%s group', '%s groups', $people, 'group of people', 'text-domain' ), number_format_i18n( $people ) );
+ * printf( _nx( '%s group', '%s groups', $animals, 'group of animals', 'text-domain' ), number_format_i18n( $animals ) );
*
* @since 2.8.0
*
*/
function _nx($single, $plural, $number, $context, $domain = 'default') {
$translations = get_translations_for_domain( $domain );
- $translation = $translations->translate_plural( $single, $plural, $number, $context );
+ $translation = $translations->translate_plural( $single, $plural, $number, $context );
/**
* Filters the singular or plural form of a string with gettext context.
*
* Example:
*
- * $messages = array(
- * 'post' => _n_noop( '%s post', '%s posts', 'text-domain' ),
- * 'page' => _n_noop( '%s pages', '%s pages', 'text-domain' ),
- * );
+ * $message = _n_noop( '%s post', '%s posts', 'text-domain' );
* ...
- * $message = $messages[ $type ];
- * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
+ * printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.5.0
*
* Used when you want to keep structures with translatable plural
* strings and use them later when the number is known.
*
- * Example:
+ * Example of a generic phrase which is disambiguated via the context parameter:
*
* $messages = array(
- * 'post' => _n_noop( '%s post', '%s posts', 'context', 'text-domain' ),
- * 'page' => _n_noop( '%s pages', '%s pages', 'context', 'text-domain' ),
+ * 'people' => _nx_noop( '%s group', '%s groups', 'people', 'text-domain' ),
+ * 'animals' => _nx_noop( '%s group', '%s groups', 'animals', 'text-domain' ),
* );
* ...
* $message = $messages[ $type ];
- * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
+ * printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.8.0
*
*
* Example:
*
- * $messages = array(
- * 'post' => _n_noop( '%s post', '%s posts', 'text-domain' ),
- * 'page' => _n_noop( '%s pages', '%s pages', 'text-domain' ),
- * );
+ * $message = _n_noop( '%s post', '%s posts', 'text-domain' );
* ...
- * $message = $messages[ $type ];
- * $usable_text = sprintf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
+ * printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 3.1.0
*
*/
function load_default_textdomain( $locale = null ) {
if ( null === $locale ) {
- $locale = get_locale();
+ $locale = is_admin() ? get_user_locale() : get_locale();
}
// Unload previously loaded strings so we can switch translations.
* @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
*
* @param string $domain Unique identifier for retrieving translated strings
- * @param string $deprecated Optional. Use the $plugin_rel_path parameter instead. Defaukt false.
+ * @param string $deprecated Optional. Use the $plugin_rel_path parameter instead. Default false.
* @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR where the .mo file resides.
* Default false.
* @return bool True when textdomain is successfully loaded, false otherwise.
* @param string $locale The plugin's current locale.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
- $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
+ $locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
$mofile = $domain . '-' . $locale . '.mo';
*/
function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
/** This filter is documented in wp-includes/l10n.php */
- $locale = apply_filters( 'plugin_locale', get_locale(), $domain );
+ $locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
$mofile = $domain . '-' . $locale . '.mo';
* @param string $locale The theme's current locale.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
- $locale = apply_filters( 'theme_locale', get_locale(), $domain );
+ $locale = apply_filters( 'theme_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
$mofile = $domain . '-' . $locale . '.mo';
* the translation file from `wp-content/languages`, removing the need
* to call load_plugin_texdomain() or load_theme_texdomain().
*
- * Holds a cached list of available .mo files to improve performance.
- *
* @since 4.6.0
* @access private
*
$l10n_unloaded = (array) $l10n_unloaded;
- static $cached_mofiles = null;
-
// Short-circuit if domain is 'default' which is reserved for core.
if ( 'default' === $domain || isset( $l10n_unloaded[ $domain ] ) ) {
return false;
}
+ $translation_path = _get_path_to_translation( $domain );
+ if ( false === $translation_path ) {
+ return false;
+ }
+
+ return load_textdomain( $domain, $translation_path );
+}
+
+/**
+ * Gets the path to a translation file for loading a textdomain just in time.
+ *
+ * Caches the retrieved results internally.
+ *
+ * @since 4.7.0
+ * @access private
+ *
+ * @see _load_textdomain_just_in_time()
+ *
+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+ * @param bool $reset Whether to reset the internal cache. Used by the switch to locale functionality.
+ * @return string|false The path to the translation file or false if no translation file was found.
+ */
+function _get_path_to_translation( $domain, $reset = false ) {
+ static $available_translations = array();
+
+ if ( true === $reset ) {
+ $available_translations = array();
+ }
+
+ if ( ! isset( $available_translations[ $domain ] ) ) {
+ $available_translations[ $domain ] = _get_path_to_translation_from_lang_dir( $domain );
+ }
+
+ return $available_translations[ $domain ];
+}
+
+/**
+ * Gets the path to a translation file in the languages directory for the current locale.
+ *
+ * Holds a cached list of available .mo files to improve performance.
+ *
+ * @since 4.7.0
+ * @access private
+ *
+ * @see _get_path_to_translation()
+ *
+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+ * @return string|false The path to the translation file or false if no translation file was found.
+ */
+function _get_path_to_translation_from_lang_dir( $domain ) {
+ static $cached_mofiles = null;
+
if ( null === $cached_mofiles ) {
$cached_mofiles = array();
);
foreach ( $locations as $location ) {
- foreach ( get_available_languages( $location ) as $file ) {
- $cached_mofiles[] = "{$location}/{$file}.mo";
+ $mofiles = glob( $location . '/*.mo' );
+ if ( $mofiles ) {
+ $cached_mofiles = array_merge( $cached_mofiles, $mofiles );
}
}
}
- $locale = get_locale();
+ $locale = is_admin() ? get_user_locale() : get_locale();
$mofile = "{$domain}-{$locale}.mo";
- if ( in_array( WP_LANG_DIR . '/plugins/' . $mofile, $cached_mofiles ) ) {
- return load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile );
+ $path = WP_LANG_DIR . '/plugins/' . $mofile;
+ if ( in_array( $path, $cached_mofiles ) ) {
+ return $path;
}
- if ( in_array( WP_LANG_DIR . '/themes/' . $mofile, $cached_mofiles ) ) {
- return load_textdomain( $domain, WP_LANG_DIR . '/themes/' . $mofile );
+ $path = WP_LANG_DIR . '/themes/' . $mofile;
+ if ( in_array( $path, $cached_mofiles ) ) {
+ return $path;
}
return false;
* @global array $l10n
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
- * @return NOOP_Translations A Translations instance.
+ * @return Translations|NOOP_Translations A Translations instance.
*/
function get_translations_for_domain( $domain ) {
global $l10n;
* The default directory is WP_LANG_DIR.
*
* @since 3.0.0
+ * @since 4.7.0 The results are now filterable with the {@see 'get_available_languages'} filter.
*
* @param string $dir A directory to search for language files.
* Default WP_LANG_DIR.
function get_available_languages( $dir = null ) {
$languages = array();
- $lang_files = glob( ( is_null( $dir) ? WP_LANG_DIR : $dir ) . '/*.mo' );
+ $lang_files = glob( ( is_null( $dir ) ? WP_LANG_DIR : $dir ) . '/*.mo' );
if ( $lang_files ) {
foreach ( $lang_files as $lang_file ) {
$lang_file = basename( $lang_file, '.mo' );
}
}
- return $languages;
+ /**
+ * Filters the list of available language codes.
+ *
+ * @since 4.7.0
+ *
+ * @param array $languages An array of available language codes.
+ * @param string $dir The directory where the language files were found.
+ */
+ return apply_filters( 'get_available_languages', $languages, $dir );
}
/**
*
* @since 4.0.0
* @since 4.3.0 Introduced the `echo` argument.
+ * @since 4.7.0 Introduced the `show_option_site_default` argument.
*
* @see get_available_languages()
* @see wp_get_available_translations()
* @type bool|int $echo Whether to echo the generated markup. Accepts 0, 1, or their
* boolean equivalents. Default 1.
* @type bool $show_available_translations Whether to show available translations. Default true.
+ * @type bool $show_option_site_default Whether to show an option to fall back to the site's locale. Default false.
* }
* @return string HTML content
*/
'selected' => '',
'echo' => 1,
'show_available_translations' => true,
+ 'show_option_site_default' => false,
) );
+ // English (United States) uses an empty string for the value attribute.
+ if ( 'en_US' === $args['selected'] ) {
+ $args['selected'] = '';
+ }
+
$translations = $args['translations'];
if ( empty( $translations ) ) {
require_once( ABSPATH . 'wp-admin/includes/translation-install.php' );
if ( $translations_available ) {
$structure[] = '<optgroup label="' . esc_attr_x( 'Installed', 'translations' ) . '">';
}
- $structure[] = '<option value="" lang="en" data-installed="1">English (United States)</option>';
+
+ if ( $args['show_option_site_default'] ) {
+ $structure[] = sprintf(
+ '<option value="site-default" data-installed="1"%s>%s</option>',
+ selected( 'site-default', $args['selected'], false ),
+ _x( 'Site Default', 'default site language' )
+ );
+ }
+
+ $structure[] = sprintf(
+ '<option value="" lang="en" data-installed="1"%s>English (United States)</option>',
+ selected( '', $args['selected'], false )
+ );
+
foreach ( $languages as $language ) {
$structure[] = sprintf(
'<option value="%s" lang="%s"%s data-installed="1">%s</option>',
return $output;
}
+
+/**
+ * Checks if current locale is RTL.
+ *
+ * @since 3.0.0
+ *
+ * @global WP_Locale $wp_locale
+ *
+ * @return bool Whether locale is RTL.
+ */
+function is_rtl() {
+ global $wp_locale;
+ if ( ! ( $wp_locale instanceof WP_Locale ) ) {
+ return false;
+ }
+ return $wp_locale->is_rtl();
+}
+
+/**
+ * Switches the translations according to the given locale.
+ *
+ * @since 4.7.0
+ *
+ * @global WP_Locale_Switcher $wp_locale_switcher
+ *
+ * @param string $locale The locale.
+ * @return bool True on success, false on failure.
+ */
+function switch_to_locale( $locale ) {
+ /* @var WP_Locale_Switcher $wp_locale_switcher */
+ global $wp_locale_switcher;
+
+ return $wp_locale_switcher->switch_to_locale( $locale );
+}
+
+/**
+ * Restores the translations according to the previous locale.
+ *
+ * @since 4.7.0
+ *
+ * @global WP_Locale_Switcher $wp_locale_switcher
+ *
+ * @return string|false Locale on success, false on error.
+ */
+function restore_previous_locale() {
+ /* @var WP_Locale_Switcher $wp_locale_switcher */
+ global $wp_locale_switcher;
+
+ return $wp_locale_switcher->restore_previous_locale();
+}
+
+/**
+ * Restores the translations according to the original locale.
+ *
+ * @since 4.7.0
+ *
+ * @global WP_Locale_Switcher $wp_locale_switcher
+ *
+ * @return string|false Locale on success, false on error.
+ */
+function restore_current_locale() {
+ /* @var WP_Locale_Switcher $wp_locale_switcher */
+ global $wp_locale_switcher;
+
+ return $wp_locale_switcher->restore_current_locale();
+}
+
+/**
+ * Whether switch_to_locale() is in effect.
+ *
+ * @since 4.7.0
+ *
+ * @global WP_Locale_Switcher $wp_locale_switcher
+ *
+ * @return bool True if the locale has been switched, false otherwise.
+ */
+function is_locale_switched() {
+ /* @var WP_Locale_Switcher $wp_locale_switcher */
+ global $wp_locale_switcher;
+
+ return $wp_locale_switcher->is_switched();
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff