--- a/wp/wp-includes/l10n.php Tue Jun 09 11:14:17 2015 +0000
+++ b/wp/wp-includes/l10n.php Mon Oct 14 17:39:30 2019 +0200
@@ -1,34 +1,38 @@
<?php
/**
- * WordPress Translation API
+ * Core Translation API
*
* @package WordPress
* @subpackage i18n
+ * @since 1.2.0
*/
/**
- * Get the current locale.
+ * Retrieves the current locale.
*
- * If the locale is set, then it will filter the locale in the 'locale' filter
- * hook and return the value.
+ * If the locale is set, then it will filter the locale in the {@see 'locale'}
+ * filter hook and return the value.
*
* If the locale is not set already, then the WPLANG constant is used if it is
- * defined. Then it is filtered through the 'locale' filter hook and the value
- * for the locale global set and the locale is returned.
+ * defined. Then it is filtered through the {@see 'locale'} filter hook and
+ * the value for the locale global set and the locale is returned.
*
* The process to get the locale should only be done once, but the locale will
- * always be filtered using the 'locale' hook.
+ * always be filtered using the {@see 'locale'} hook.
*
* @since 1.5.0
*
- * @return string The locale of the blog or from the 'locale' hook.
+ * @global string $locale
+ * @global string $wp_local_package
+ *
+ * @return string The locale of the blog or from the {@see 'locale'} hook.
*/
function get_locale() {
global $locale, $wp_local_package;
if ( isset( $locale ) ) {
/**
- * Filter WordPress install's locale ID.
+ * Filters the locale ID of the WordPress installation.
*
* @since 1.5.0
*
@@ -49,7 +53,7 @@
// If multisite, check options.
if ( is_multisite() ) {
// Don't check blog option when installing.
- if ( defined( 'WP_INSTALLING' ) || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) {
+ if ( wp_installing() || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) {
$ms_locale = get_site_option( 'WPLANG' );
}
@@ -72,32 +76,62 @@
}
/**
+ * 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.
*
* If there is no translation, or the text domain isn't loaded, the original text is returned.
*
- * *Note:* Don't use {@see translate()} directly, use `{@see __()} or related functions.
+ * *Note:* Don't use translate() directly, use __() or related functions.
*
* @since 2.2.0
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text
*/
function translate( $text, $domain = 'default' ) {
$translations = get_translations_for_domain( $domain );
- $translations = $translations->translate( $text );
+ $translation = $translations->translate( $text );
/**
- * Filter text with its translation.
+ * 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 );
}
/**
@@ -113,10 +147,11 @@
*/
function before_last_bar( $string ) {
$last_bar = strrpos( $string, '|' );
- if ( false == $last_bar )
+ if ( false === $last_bar ) {
return $string;
- else
+ } else {
return substr( $string, 0, $last_bar );
+ }
}
/**
@@ -125,37 +160,42 @@
* If there is no translation, or the text domain isn't loaded the original
* text is returned.
*
+ * *Note:* Don't use translate_with_gettext_context() directly, use _x() or related functions.
+ *
* @since 2.8.0
*
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text on success, original text on failure.
*/
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 );
/**
- * Filter text with its translation based on context information.
+ * 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 );
}
/**
- * Retrieve the translation of $text. If there is no translation,
- * or the text domain isn't loaded, the original text is returned.
+ * Retrieve the translation of $text.
+ *
+ * If there is no translation, or the text domain isn't loaded, the original text is returned.
*
* @since 2.1.0
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text.
*/
function __( $text, $domain = 'default' ) {
@@ -171,6 +211,7 @@
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text on success, original text on failure.
*/
function esc_attr__( $text, $domain = 'default' ) {
@@ -180,12 +221,14 @@
/**
* Retrieve the translation of $text and escapes it for safe use in HTML output.
*
- * If there is no translation, or the text domain isn't loaded, the original text is returned.
+ * If there is no translation, or the text domain isn't loaded, the original text
+ * is escaped and returned..
*
* @since 2.8.0
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text
*/
function esc_html__( $text, $domain = 'default' ) {
@@ -199,6 +242,7 @@
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
*/
function _e( $text, $domain = 'default' ) {
echo translate( $text, $domain );
@@ -211,6 +255,7 @@
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
*/
function esc_attr_e( $text, $domain = 'default' ) {
echo esc_attr( translate( $text, $domain ) );
@@ -223,6 +268,7 @@
*
* @param string $text Text to translate.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
*/
function esc_html_e( $text, $domain = 'default' ) {
echo esc_html( translate( $text, $domain ) );
@@ -242,6 +288,7 @@
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated context string without pipe.
*/
function _x( $text, $context, $domain = 'default' ) {
@@ -256,6 +303,7 @@
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated context string without pipe.
*/
function _ex( $text, $context, $domain = 'default' ) {
@@ -270,6 +318,7 @@
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text
*/
function esc_attr_x( $text, $context, $domain = 'default' ) {
@@ -284,6 +333,7 @@
* @param string $text Text to translate.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default 'default'.
* @return string Translated text.
*/
function esc_html_x( $text, $context, $domain = 'default' ) {
@@ -291,67 +341,78 @@
}
/**
- * Retrieve the plural or single form based on the supplied amount.
- *
- * If the text domain is not set in the $l10n list, then a comparison will be made
- * and either $plural or $single parameters returned.
+ * Translates and retrieves the singular or plural form based on the supplied number.
*
- * If the text domain does exist, then the parameters $single, $plural, and $number
- * will first be passed to the text domain's ngettext method. Then it will be passed
- * to the 'ngettext' filter hook along with the same parameters. The expected
- * type will be a string.
+ * Used when you want to use the appropriate form of a string based on whether a
+ * number is singular or plural.
+ *
+ * Example:
+ *
+ * printf( _n( '%s person', '%s people', $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.8.0
*
- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param int $number The number to compare against to use either $single or $plural.
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param int $number The number to compare against to use either the singular or plural form.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
- * @return string Either $single or $plural translated text.
+ * Default 'default'.
+ * @return string The translated singular or plural form.
*/
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 );
+
/**
- * Filter text with its translation when plural option is available.
+ * Filters the singular or plural form of a string.
*
* @since 2.2.0
*
* @param string $translation Translated text.
- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param string $number The number to compare against to use either $single or $plural.
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param string $number The number to compare against to use either the singular or plural form.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
return apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain );
}
/**
- * Retrieve the plural or single form based on the supplied amount with gettext context.
+ * Translates and retrieves the singular or plural form based on the supplied number, with gettext context.
+ *
+ * This is a hybrid of _n() and _x(). It supports context and plurals.
*
- * This is a hybrid of _n() and _x(). It supports contexts and plurals.
+ * Used when you want to use the appropriate form of a string with context based on whether a
+ * number is singular or plural.
+ *
+ * Example of a generic phrase which is disambiguated via the context parameter:
+ *
+ * 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
*
- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param int $number The number to compare against to use either $single or $plural.
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param int $number The number to compare against to use either the singular or plural form.
* @param string $context Context information for the translators.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
- * @return string Either $single or $plural translated text with context.
+ * Default 'default'.
+ * @return string The translated singular or plural form.
*/
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 );
+
/**
- * Filter text with its translation while plural option and context are available.
+ * Filters the singular or plural form of a string with gettext context.
*
* @since 2.8.0
*
* @param string $translation Translated text.
- * @param string $single The text that will be used if $number is 1.
- * @param string $plural The text that will be used if $number is not 1.
- * @param string $number The number to compare against to use either $single or $plural.
+ * @param string $single The text to be used if the number is singular.
+ * @param string $plural The text to be used if the number is plural.
+ * @param string $number The number to compare against to use either the singular or plural form.
* @param string $context Context information for the translators.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
@@ -359,55 +420,95 @@
}
/**
- * Register plural strings in POT file, but don't translate them.
+ * Registers plural strings in POT file, but does not translate them.
*
* Used when you want to keep structures with translatable plural
- * strings and use them later.
+ * strings and use them later when the number is known.
*
* Example:
*
- * $messages = array(
- * 'post' => _n_noop( '%s post', '%s posts' ),
- * 'page' => _n_noop( '%s pages', '%s pages' ),
- * );
+ * $message = _n_noop( '%s post', '%s posts', 'text-domain' );
* ...
- * $message = $messages[ $type ];
- * $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count );
+ * printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.5.0
*
- * @param string $singular Single form to be i18ned.
- * @param string $plural Plural form to be i18ned.
+ * @param string $singular Singular form to be localized.
+ * @param string $plural Plural form to be localized.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
- * @return array array($singular, $plural)
+ * Default null.
+ * @return array {
+ * Array of translation information for the strings.
+ *
+ * @type string $0 Singular form to be localized. No longer used.
+ * @type string $1 Plural form to be localized. No longer used.
+ * @type string $singular Singular form to be localized.
+ * @type string $plural Plural form to be localized.
+ * @type null $context Context information for the translators.
+ * @type string $domain Text domain.
+ * }
*/
function _n_noop( $singular, $plural, $domain = null ) {
return array( 0 => $singular, 1 => $plural, 'singular' => $singular, 'plural' => $plural, 'context' => null, 'domain' => $domain );
}
/**
- * Register plural strings with context in POT file, but don't translate them.
+ * Registers plural strings with gettext context in POT file, but does not translate them.
+ *
+ * Used when you want to keep structures with translatable plural
+ * strings and use them later when the number is known.
+ *
+ * Example of a generic phrase which is disambiguated via the context parameter:
+ *
+ * $messages = array(
+ * 'people' => _nx_noop( '%s group', '%s groups', 'people', 'text-domain' ),
+ * 'animals' => _nx_noop( '%s group', '%s groups', 'animals', 'text-domain' ),
+ * );
+ * ...
+ * $message = $messages[ $type ];
+ * printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 2.8.0
- * @param string $singular
- * @param string $plural
- * @param string $context
- * @param string|null $domain
- * @return array
+ *
+ * @param string $singular Singular form to be localized.
+ * @param string $plural Plural form to be localized.
+ * @param string $context Context information for the translators.
+ * @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings.
+ * Default null.
+ * @return array {
+ * Array of translation information for the strings.
+ *
+ * @type string $0 Singular form to be localized. No longer used.
+ * @type string $1 Plural form to be localized. No longer used.
+ * @type string $2 Context information for the translators. No longer used.
+ * @type string $singular Singular form to be localized.
+ * @type string $plural Plural form to be localized.
+ * @type string $context Context information for the translators.
+ * @type string $domain Text domain.
+ * }
*/
function _nx_noop( $singular, $plural, $context, $domain = null ) {
return array( 0 => $singular, 1 => $plural, 2 => $context, 'singular' => $singular, 'plural' => $plural, 'context' => $context, 'domain' => $domain );
}
/**
- * Translate the result of _n_noop() or _nx_noop().
+ * Translates and retrieves the singular or plural form of a string that's been registered
+ * with _n_noop() or _nx_noop().
+ *
+ * Used when you want to use a translatable plural string once the number is known.
+ *
+ * Example:
+ *
+ * $message = _n_noop( '%s post', '%s posts', 'text-domain' );
+ * ...
+ * printf( translate_nooped_plural( $message, $count, 'text-domain' ), number_format_i18n( $count ) );
*
* @since 3.1.0
*
- * @param array $nooped_plural Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()
- * @param int $count Number of objects
+ * @param array $nooped_plural Array with singular, plural, and context keys, usually the result of _n_noop() or _nx_noop().
+ * @param int $count Number of objects.
* @param string $domain Optional. Text domain. Unique identifier for retrieving translated strings. If $nooped_plural contains
- * a text domain passed to _n_noop() or _nx_noop(), it will override this value.
+ * a text domain passed to _n_noop() or _nx_noop(), it will override this value. Default 'default'.
* @return string Either $single or $plural translated text.
*/
function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {
@@ -431,25 +532,32 @@
*
* @since 1.5.0
*
+ * @global array $l10n An array of all currently loaded text domains.
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
+ *
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @param string $mofile Path to the .mo file.
* @return bool True on success, false on failure.
*/
function load_textdomain( $domain, $mofile ) {
- global $l10n;
+ global $l10n, $l10n_unloaded;
+
+ $l10n_unloaded = (array) $l10n_unloaded;
/**
- * Filter text domain and/or MO file path for loading translations.
+ * Filters whether to override the .mo file loading.
*
* @since 2.9.0
*
- * @param bool $override Whether to override the text domain. Default false.
+ * @param bool $override Whether to override the .mo file loading. Default false.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @param string $mofile Path to the MO file.
*/
$plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile );
if ( true == $plugin_override ) {
+ unset( $l10n_unloaded[ $domain ] );
+
return true;
}
@@ -464,7 +572,7 @@
do_action( 'load_textdomain', $domain, $mofile );
/**
- * Filter MO file path for loading translations for a specific text domain.
+ * Filters MO file path for loading translations for a specific text domain.
*
* @since 2.9.0
*
@@ -481,6 +589,8 @@
if ( isset( $l10n[$domain] ) )
$mo->merge_with( $l10n[$domain] );
+ unset( $l10n_unloaded[ $domain ] );
+
$l10n[$domain] = &$mo;
return true;
@@ -491,24 +601,32 @@
*
* @since 3.0.0
*
+ * @global array $l10n An array of all currently loaded text domains.
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
+ *
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @return bool Whether textdomain was unloaded.
*/
function unload_textdomain( $domain ) {
- global $l10n;
+ global $l10n, $l10n_unloaded;
+
+ $l10n_unloaded = (array) $l10n_unloaded;
/**
- * Filter the text domain for loading translation.
+ * Filters whether to override the text domain unloading.
*
* @since 3.0.0
*
- * @param bool $override Whether to override unloading the text domain. Default false.
+ * @param bool $override Whether to override the text domain unloading. Default false.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
$plugin_override = apply_filters( 'override_unload_textdomain', false, $domain );
- if ( $plugin_override )
+ if ( $plugin_override ) {
+ $l10n_unloaded[ $domain ] = true;
+
return true;
+ }
/**
* Fires before the text domain is unloaded.
@@ -521,6 +639,9 @@
if ( isset( $l10n[$domain] ) ) {
unset( $l10n[$domain] );
+
+ $l10n_unloaded[ $domain ] = true;
+
return true;
}
@@ -537,12 +658,12 @@
*
* @since 1.5.0
*
- * @param string $locale Optional. Locale to load. Default is the value of {@see get_locale()}.
+ * @param string $locale Optional. Locale to load. Default is the value of get_locale().
* @return bool Whether the textdomain was loaded.
*/
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.
@@ -555,7 +676,7 @@
return $return;
}
- if ( is_admin() || defined( 'WP_INSTALLING' ) || ( defined( 'WP_REPAIRING' ) && WP_REPAIRING ) ) {
+ if ( is_admin() || wp_installing() || ( defined( 'WP_REPAIRING' ) && WP_REPAIRING ) ) {
load_textdomain( 'default', WP_LANG_DIR . "/admin-$locale.mo" );
}
@@ -566,74 +687,76 @@
}
/**
- * Load a plugin's translated strings.
+ * Loads a plugin's translated strings.
*
* If the path is not given then it will be the root of the plugin directory.
*
* The .mo file should be named based on the text domain with a dash, and then the locale exactly.
*
* @since 1.5.0
+ * @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 Use the $plugin_rel_path parameter instead.
+ * @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.
*/
function load_plugin_textdomain( $domain, $deprecated = false, $plugin_rel_path = false ) {
- $locale = get_locale();
/**
- * Filter a plugin's locale.
+ * Filters a plugin's locale.
*
* @since 3.0.0
*
* @param string $locale The plugin's current locale.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
- $locale = apply_filters( 'plugin_locale', $locale, $domain );
+ $locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
+
+ $mofile = $domain . '-' . $locale . '.mo';
- if ( false !== $plugin_rel_path ) {
+ // Try to load from the languages directory first.
+ if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile ) ) {
+ return true;
+ }
+
+ if ( false !== $plugin_rel_path ) {
$path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' );
} elseif ( false !== $deprecated ) {
- _deprecated_argument( __FUNCTION__, '2.7' );
+ _deprecated_argument( __FUNCTION__, '2.7.0' );
$path = ABSPATH . trim( $deprecated, '/' );
} else {
$path = WP_PLUGIN_DIR;
}
- // Load the textdomain according to the plugin first
- $mofile = $domain . '-' . $locale . '.mo';
- if ( $loaded = load_textdomain( $domain, $path . '/'. $mofile ) )
- return $loaded;
-
- // Otherwise, load from the languages directory
- $mofile = WP_LANG_DIR . '/plugins/' . $mofile;
- return load_textdomain( $domain, $mofile );
+ return load_textdomain( $domain, $path . '/' . $mofile );
}
/**
* Load the translated strings for a plugin residing in the mu-plugins directory.
*
* @since 3.0.0
+ * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
- * @param string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which the .mo file resides.
- * Default empty string.
+ * @param string $mu_plugin_rel_path Optional. Relative to `WPMU_PLUGIN_DIR` directory in which the .mo
+ * file resides. Default empty string.
* @return bool True when textdomain is successfully loaded, false otherwise.
*/
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 );
- $path = trailingslashit( WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ) );
+ $locale = apply_filters( 'plugin_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
- // Load the textdomain according to the plugin first
$mofile = $domain . '-' . $locale . '.mo';
- if ( $loaded = load_textdomain( $domain, $path . $mofile ) )
- return $loaded;
- // Otherwise, load from the languages directory
- $mofile = WP_LANG_DIR . '/plugins/' . $mofile;
- return load_textdomain( $domain, $mofile );
+ // Try to load from the languages directory first.
+ if ( load_textdomain( $domain, WP_LANG_DIR . '/plugins/' . $mofile ) ) {
+ return true;
+ }
+
+ $path = WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' );
+
+ return load_textdomain( $domain, $path . '/' . $mofile );
}
/**
@@ -645,6 +768,7 @@
* The .mo files must be named based on the locale exactly.
*
* @since 1.5.0
+ * @since 4.6.0 The function now tries to load the .mo file from the languages directory first.
*
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @param string $path Optional. Path to the directory containing the .mo file.
@@ -652,28 +776,28 @@
* @return bool True when textdomain is successfully loaded, false otherwise.
*/
function load_theme_textdomain( $domain, $path = false ) {
- $locale = get_locale();
/**
- * Filter a theme's locale.
+ * Filters a theme's locale.
*
* @since 3.0.0
*
* @param string $locale The theme's current locale.
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
*/
- $locale = apply_filters( 'theme_locale', $locale, $domain );
+ $locale = apply_filters( 'theme_locale', is_admin() ? get_user_locale() : get_locale(), $domain );
- if ( ! $path )
- $path = get_template_directory();
+ $mofile = $domain . '-' . $locale . '.mo';
- // Load the textdomain according to the theme
- $mofile = untrailingslashit( $path ) . "/{$locale}.mo";
- if ( $loaded = load_textdomain( $domain, $mofile ) )
- return $loaded;
+ // Try to load from the languages directory first.
+ if ( load_textdomain( $domain, WP_LANG_DIR . '/themes/' . $mofile ) ) {
+ return true;
+ }
- // Otherwise, load from the languages directory
- $mofile = WP_LANG_DIR . "/themes/{$domain}-{$locale}.mo";
- return load_textdomain( $domain, $mofile );
+ if ( ! $path ) {
+ $path = get_template_directory();
+ }
+
+ return load_textdomain( $domain, $path . '/' . $locale . '.mo' );
}
/**
@@ -698,21 +822,139 @@
}
/**
+ * Loads plugin and theme textdomains just-in-time.
+ *
+ * When a textdomain is encountered for the first time, we try to load
+ * the translation file from `wp-content/languages`, removing the need
+ * to call load_plugin_texdomain() or load_theme_texdomain().
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @see get_translations_for_domain()
+ * @global array $l10n_unloaded An array of all text domains that have been unloaded again.
+ *
+ * @param string $domain Text domain. Unique identifier for retrieving translated strings.
+ * @return bool True when the textdomain is successfully loaded, false otherwise.
+ */
+function _load_textdomain_just_in_time( $domain ) {
+ global $l10n_unloaded;
+
+ $l10n_unloaded = (array) $l10n_unloaded;
+
+ // 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();
+
+ $locations = array(
+ WP_LANG_DIR . '/plugins',
+ WP_LANG_DIR . '/themes',
+ );
+
+ foreach ( $locations as $location ) {
+ $mofiles = glob( $location . '/*.mo' );
+ if ( $mofiles ) {
+ $cached_mofiles = array_merge( $cached_mofiles, $mofiles );
+ }
+ }
+ }
+
+ $locale = is_admin() ? get_user_locale() : get_locale();
+ $mofile = "{$domain}-{$locale}.mo";
+
+ $path = WP_LANG_DIR . '/plugins/' . $mofile;
+ if ( in_array( $path, $cached_mofiles ) ) {
+ return $path;
+ }
+
+ $path = WP_LANG_DIR . '/themes/' . $mofile;
+ if ( in_array( $path, $cached_mofiles ) ) {
+ return $path;
+ }
+
+ return false;
+}
+
+/**
* Return the Translations instance for a text domain.
*
* If there isn't one, returns empty Translations instance.
*
* @since 2.8.0
*
+ * @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;
- if ( !isset( $l10n[$domain] ) ) {
- $l10n[$domain] = new NOOP_Translations;
+ if ( isset( $l10n[ $domain ] ) || ( _load_textdomain_just_in_time( $domain ) && isset( $l10n[ $domain ] ) ) ) {
+ return $l10n[ $domain ];
}
- return $l10n[$domain];
+
+ static $noop_translations = null;
+ if ( null === $noop_translations ) {
+ $noop_translations = new NOOP_Translations;
+ }
+
+ return $noop_translations;
}
/**
@@ -720,12 +962,14 @@
*
* @since 3.0.0
*
+ * @global array $l10n
+ *
* @param string $domain Text domain. Unique identifier for retrieving translated strings.
* @return bool Whether there are translations.
*/
function is_textdomain_loaded( $domain ) {
global $l10n;
- return isset( $l10n[$domain] );
+ return isset( $l10n[ $domain ] );
}
/**
@@ -735,9 +979,9 @@
* are dummy gettext calls to get them into the POT file and this function
* properly translates them back.
*
- * The before_last_bar() call is needed, because older installs keep the roles
+ * The before_last_bar() call is needed, because older installations keep the roles
* using the old context format: 'Role name|User role' and just skipping the
- * content after the last bar is easier than fixing them in the DB. New installs
+ * content after the last bar is easier than fixing them in the DB. New installations
* won't suffer from that problem.
*
* @since 2.8.0
@@ -755,6 +999,7 @@
* 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.
@@ -763,14 +1008,26 @@
function get_available_languages( $dir = null ) {
$languages = array();
- foreach( (array)glob( ( is_null( $dir) ? WP_LANG_DIR : $dir ) . '/*.mo' ) as $lang_file ) {
- $lang_file = basename($lang_file, '.mo');
- if ( 0 !== strpos( $lang_file, 'continents-cities' ) && 0 !== strpos( $lang_file, 'ms-' ) &&
- 0 !== strpos( $lang_file, 'admin-' ))
- $languages[] = $lang_file;
+ $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' );
+ if ( 0 !== strpos( $lang_file, 'continents-cities' ) && 0 !== strpos( $lang_file, 'ms-' ) &&
+ 0 !== strpos( $lang_file, 'admin-' ) ) {
+ $languages[] = $lang_file;
+ }
+ }
}
- 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 );
}
/**
@@ -803,13 +1060,13 @@
$language_data = array();
foreach ( $files as $file ) {
- if ( '.' === $file[0] || is_dir( $file ) ) {
+ if ( '.' === $file[0] || is_dir( WP_LANG_DIR . "$dir/$file" ) ) {
continue;
}
if ( substr( $file, -3 ) !== '.po' ) {
continue;
}
- if ( ! preg_match( '/(?:(.+)-)?([A-Za-z_]{2,6}).po/', $file, $match ) ) {
+ if ( ! preg_match( '/(?:(.+)-)?([a-z]{2,3}(?:_[A-Z]{2})?(?:_[a-z0-9]+)?).po/', $file, $match ) ) {
continue;
}
if ( ! in_array( substr( $file, 0, -3 ) . '.mo', $files ) ) {
@@ -851,6 +1108,8 @@
* Language selector.
*
* @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()
@@ -858,39 +1117,55 @@
* @param string|array $args {
* Optional. Array or string of arguments for outputting the language selector.
*
- * @type string $id ID attribute of the select element. Default empty.
- * @type string $name Name attribute of the select element. Default empty.
- * @type array $languages List of installed languages, contain only the locales.
- * Default empty array.
- * @type array $translations List of available translations. Default result of
- * {@see wp_get_available_translations()}.
- * @type string $selected Language which should be selected. Default empty.
- * @type bool $show_available_translations Whether to show available translations. Default true.
+ * @type string $id ID attribute of the select element. Default 'locale'.
+ * @type string $name Name attribute of the select element. Default 'locale'.
+ * @type array $languages List of installed languages, contain only the locales.
+ * Default empty array.
+ * @type array $translations List of available translations. Default result of
+ * wp_get_available_translations().
+ * @type string $selected Language which should be selected. Default empty.
+ * @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
*/
function wp_dropdown_languages( $args = array() ) {
- $args = wp_parse_args( $args, array(
- 'id' => '',
- 'name' => '',
+ $parsed_args = wp_parse_args( $args, array(
+ 'id' => 'locale',
+ 'name' => 'locale',
'languages' => array(),
'translations' => array(),
'selected' => '',
+ 'echo' => 1,
'show_available_translations' => true,
+ 'show_option_site_default' => false,
) );
- $translations = $args['translations'];
+ // Bail if no ID or no name.
+ if ( ! $parsed_args['id'] || ! $parsed_args['name'] ) {
+ return;
+ }
+
+ // English (United States) uses an empty string for the value attribute.
+ if ( 'en_US' === $parsed_args['selected'] ) {
+ $parsed_args['selected'] = '';
+ }
+
+ $translations = $parsed_args['translations'];
if ( empty( $translations ) ) {
require_once( ABSPATH . 'wp-admin/includes/translation-install.php' );
$translations = wp_get_available_translations();
}
/*
- * $args['languages'] should only contain the locales. Find the locale in
+ * $parsed_args['languages'] should only contain the locales. Find the locale in
* $translations to get the native name. Fall back to locale.
*/
$languages = array();
- foreach ( $args['languages'] as $locale ) {
+ foreach ( $parsed_args['languages'] as $locale ) {
if ( isset( $translations[ $locale ] ) ) {
$translation = $translations[ $locale ];
$languages[] = array(
@@ -910,9 +1185,7 @@
}
}
- $translations_available = ( ! empty( $translations ) && $args['show_available_translations'] );
-
- printf( '<select name="%s" id="%s">', esc_attr( $args['name'] ), esc_attr( $args['id'] ) );
+ $translations_available = ( ! empty( $translations ) && $parsed_args['show_available_translations'] );
// Holds the HTML markup.
$structure = array();
@@ -921,13 +1194,29 @@
if ( $translations_available ) {
$structure[] = '<optgroup label="' . esc_attr_x( 'Installed', 'translations' ) . '">';
}
- $structure[] = '<option value="" lang="en" data-installed="1">English (United States)</option>';
+
+ // Site default.
+ if ( $parsed_args['show_option_site_default'] ) {
+ $structure[] = sprintf(
+ '<option value="site-default" data-installed="1"%s>%s</option>',
+ selected( 'site-default', $parsed_args['selected'], false ),
+ _x( 'Site Default', 'default site language' )
+ );
+ }
+
+ // Always show English.
+ $structure[] = sprintf(
+ '<option value="" lang="en" data-installed="1"%s>English (United States)</option>',
+ selected( '', $parsed_args['selected'], false )
+ );
+
+ // List installed languages.
foreach ( $languages as $language ) {
$structure[] = sprintf(
'<option value="%s" lang="%s"%s data-installed="1">%s</option>',
esc_attr( $language['language'] ),
esc_attr( $language['lang'] ),
- selected( $language['language'], $args['selected'], false ),
+ selected( $language['language'], $parsed_args['selected'], false ),
esc_html( $language['native_name'] )
);
}
@@ -943,14 +1232,103 @@
'<option value="%s" lang="%s"%s>%s</option>',
esc_attr( $translation['language'] ),
esc_attr( current( $translation['iso'] ) ),
- selected( $translation['language'], $args['selected'], false ),
+ selected( $translation['language'], $parsed_args['selected'], false ),
esc_html( $translation['native_name'] )
);
}
$structure[] = '</optgroup>';
}
- echo join( "\n", $structure );
+ // Combine the output string.
+ $output = sprintf( '<select name="%s" id="%s">', esc_attr( $parsed_args['name'] ), esc_attr( $parsed_args['id'] ) );
+ $output .= join( "\n", $structure );
+ $output .= '</select>';
+
+ if ( $parsed_args['echo'] ) {
+ echo $output;
+ }
+
+ 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 );
+}
- echo '</select>';
+/**
+ * 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();
+}