X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/98a4d31e52bd56c908617df281730bd4ba58d110..6c8f14c09105d0afa4c1574215c59b5021040e76:/wp-includes/l10n.php diff --git a/wp-includes/l10n.php b/wp-includes/l10n.php index 04850497..750e08de 100644 --- a/wp-includes/l10n.php +++ b/wp-includes/l10n.php @@ -16,7 +16,7 @@ * defined. Then it is filtered through the '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 + * The process to get the locale should only be done once, but the locale will * always be filtered using the 'locale' hook. * * @since 1.5.0 @@ -28,22 +28,32 @@ function get_locale() { global $locale; - if (isset($locale)) + if ( isset( $locale ) ) return apply_filters( 'locale', $locale ); // WPLANG is defined in wp-config. - if (defined('WPLANG')) + if ( defined( 'WPLANG' ) ) $locale = WPLANG; - if (empty($locale)) + // If multisite, check options. + if ( is_multisite() ) { + // Don't check blog option when installing. + if ( defined( 'WP_INSTALLING' ) || ( false === $ms_locale = get_option( 'WPLANG' ) ) ) + $ms_locale = get_site_option('WPLANG'); + + if ( $ms_locale !== false ) + $locale = $ms_locale; + } + + if ( empty( $locale ) ) $locale = 'en_US'; - return apply_filters('locale', $locale); + return apply_filters( 'locale', $locale ); } /** * Retrieves the translation of $text. If there is no translation, or - * the domain isn't loaded the original text is returned. + * the domain isn't loaded, the original text is returned. * * @see __() Don't use translate() directly, use __() * @since 2.2.0 @@ -55,8 +65,8 @@ function get_locale() { * @return string Translated text */ function translate( $text, $domain = 'default' ) { - $translations = &get_translations_for_domain( $domain ); - return apply_filters('gettext', $translations->translate($text), $text, $domain); + $translations = get_translations_for_domain( $domain ); + return apply_filters( 'gettext', $translations->translate( $text ), $text, $domain ); } function before_last_bar( $string ) { @@ -67,30 +77,14 @@ function before_last_bar( $string ) { return substr( $string, 0, $last_bar ); } -/** - * Translates $text like translate(), but assumes that the text - * contains a context after its last vertical bar. - * - * @since 2.5 - * @uses translate() - * - * @param string $text Text to translate - * @param string $domain Domain to retrieve the translated text - * @return string Translated text - */ -function translate_with_context( $text, $domain = 'default' ) { - return before_last_bar( translate( $text, $domain ) ); - -} - function translate_with_gettext_context( $text, $context, $domain = 'default' ) { - $translations = &get_translations_for_domain( $domain ); - return apply_filters( 'gettext_with_context', $translations->translate( $text, $context ), $text, $context, $domain); + $translations = get_translations_for_domain( $domain ); + return apply_filters( 'gettext_with_context', $translations->translate( $text, $context ), $text, $context, $domain ); } /** * Retrieves the translation of $text. If there is no translation, or - * the domain isn't loaded the original text is returned. + * the domain isn't loaded, the original text is returned. * * @see translate() An alias of translate() * @since 2.1.0 @@ -105,7 +99,7 @@ function __( $text, $domain = 'default' ) { /** * Retrieves the translation of $text and escapes it for safe use in an attribute. - * If there is no translation, or the domain isn't loaded the original text is returned. + * If there is no translation, or the domain isn't loaded, the original text is returned. * * @see translate() An alias of translate() * @see esc_attr() @@ -121,7 +115,7 @@ function esc_attr__( $text, $domain = 'default' ) { /** * Retrieves the translation of $text and escapes it for safe use in HTML output. - * If there is no translation, or the domain isn't loaded the original text is returned. + * If there is no translation, or the domain isn't loaded, the original text is returned. * * @see translate() An alias of translate() * @see esc_html() @@ -177,40 +171,46 @@ function esc_html_e( $text, $domain = 'default' ) { } /** - * Retrieve translated string with vertical bar context + * Retrieve translated string with gettext context * * Quite a few times, there will be collisions with similar translatable text * found in more than two places but with different translated context. * - * In order to use the separate contexts, the _c() function is used and the - * translatable string uses a pipe ('|') which has the context the string is in. + * By including the context in the pot file translators can translate the two + * strings differently. * - * When the translated string is returned, it is everything before the pipe, not - * including the pipe character. If there is no pipe in the translated text then - * everything is returned. - * - * @since 2.2.0 + * @since 2.8.0 * * @param string $text Text to translate + * @param string $context Context information for the translators * @param string $domain Optional. Domain to retrieve the translated text * @return string Translated context string without pipe */ -function _c($text, $domain = 'default') { - return translate_with_context($text, $domain); +function _x( $text, $context, $domain = 'default' ) { + return translate_with_gettext_context( $text, $context, $domain ); } -function _x( $single, $context, $domain = 'default' ) { - return translate_with_gettext_context( $single, $context, $domain ); +/** + * Displays translated string with gettext context + * + * @see _x + * @since 3.0.0 + * + * @param string $text Text to translate + * @param string $context Context information for the translators + * @param string $domain Optional. Domain to retrieve the translated text + * @return string Translated context string without pipe + */ +function _ex( $text, $context, $domain = 'default' ) { + echo _x( $text, $context, $domain ); } function esc_attr_x( $single, $context, $domain = 'default' ) { return esc_attr( translate_with_gettext_context( $single, $context, $domain ) ); } -function __ngettext() { - _deprecated_function( __FUNCTION__, '2.8', '_n()' ); - $args = func_get_args(); - return call_user_func_array('_n', $args); +function esc_html_x( $single, $context, $domain = 'default' ) { + return esc_html( translate_with_gettext_context( $single, $context, $domain ) ); } /** @@ -224,7 +224,7 @@ function __ngettext() { * to the 'ngettext' filter hook along with the same parameters. The expected * type will be a string. * - * @since 1.2.0 + * @since 2.8.0 * @uses $l10n Gets list of domain translated string (gettext_reader) objects * @uses apply_filters() Calls 'ngettext' hook on domains text returned, * along with $single, $plural, and $number parameters. Expected to return string. @@ -235,41 +235,29 @@ function __ngettext() { * @param string $domain Optional. The domain identifier the text should be retrieved in * @return string Either $single or $plural translated text */ -function _n($single, $plural, $number, $domain = 'default') { - $translations = &get_translations_for_domain( $domain ); +function _n( $single, $plural, $number, $domain = 'default' ) { + $translations = get_translations_for_domain( $domain ); $translation = $translations->translate_plural( $single, $plural, $number ); return apply_filters( 'ngettext', $translation, $single, $plural, $number, $domain ); } /** - * @see _n() A version of _n(), which supports contexts -- - * strips everything from the translation after the last bar + * A hybrid of _n() and _x(). It supports contexts and plurals. + * + * @see _n() + * @see _x() * */ -function _nc( $single, $plural, $number, $domain = 'default' ) { - return before_last_bar( _n( $single, $plural, $number, $domain ) ); -} - function _nx($single, $plural, $number, $context, $domain = 'default') { - $translations = &get_translations_for_domain( $domain ); + $translations = get_translations_for_domain( $domain ); $translation = $translations->translate_plural( $single, $plural, $number, $context ); - return apply_filters( 'ngettext_with_context ', $translation, $single, $plural, $number, $context, $domain ); -} - -/** - * @deprecated Use _n_noop() - */ -function __ngettext_noop() { - _deprecated_function( __FUNCTION__, '2.8', '_n_noop()' ); - $args = func_get_args(); - return call_user_func_array('_n_noop', $args); - + return apply_filters( 'ngettext_with_context', $translation, $single, $plural, $number, $context, $domain ); } /** * Register plural strings in POT file, but don't translate them. * - * Used when you want do keep structures with translatable plural strings and + * Used when you want to keep structures with translatable plural strings and * use them later. * * Example: @@ -279,15 +267,16 @@ function __ngettext_noop() { * ); * ... * $message = $messages[$type]; - * $usable_text = sprintf(_n($message[0], $message[1], $count), $count); + * $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count ); * * @since 2.5 - * @param $single Single form to be i18ned - * @param $plural Plural form to be i18ned - * @return array array($single, $plural) + * @param string $singular Single form to be i18ned + * @param string $plural Plural form to be i18ned + * @param string $domain Optional. The domain identifier the text will be retrieved in + * @return array array($singular, $plural) */ -function _n_noop( $single, $plural ) { - return array( $single, $plural ); +function _n_noop( $singular, $plural, $domain = null ) { + return array( 0 => $singular, 1 => $plural, 'singular' => $singular, 'plural' => $plural, 'context' => null, 'domain' => $domain ); } /** @@ -295,10 +284,28 @@ function _n_noop( $single, $plural ) { * * @see _n_noop() */ -function _nx_noop( $single, $plural, $context ) { - return array( $single, $plural, $context ); +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() + * + * @since 3.1 + * @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. The domain identifier the text should be retrieved in. If $nooped_plural contains + * a domain passed to _n_noop() or _nx_noop(), it will override this value. + */ +function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) { + if ( $nooped_plural['domain'] ) + $domain = $nooped_plural['domain']; + + if ( $nooped_plural['context'] ) + return _nx( $nooped_plural['singular'], $nooped_plural['plural'], $count, $nooped_plural['context'], $domain ); + else + return _n( $nooped_plural['singular'], $nooped_plural['plural'], $count, $domain ); +} /** * Loads a MO file into the domain $domain. @@ -314,11 +321,21 @@ function _nx_noop( $single, $plural, $context ) { * * @param string $domain Unique identifier for retrieving translated strings * @param string $mofile Path to the .mo file - * @return bool true on success, false on failure + * @return bool True on success, false on failure */ -function load_textdomain($domain, $mofile) { +function load_textdomain( $domain, $mofile ) { global $l10n; + $plugin_override = apply_filters( 'override_load_textdomain', false, $domain, $mofile ); + + if ( true == $plugin_override ) { + return true; + } + + do_action( 'load_textdomain', $domain, $mofile ); + + $mofile = apply_filters( 'load_textdomain_mofile', $mofile, $domain ); + if ( !is_readable( $mofile ) ) return false; $mo = new MO(); @@ -328,23 +345,59 @@ function load_textdomain($domain, $mofile) { $mo->merge_with( $l10n[$domain] ); $l10n[$domain] = &$mo; + return true; } +/** + * Unloads translations for a domain + * + * @since 3.0.0 + * @param string $domain Textdomain to be unloaded + * @return bool Whether textdomain was unloaded + */ +function unload_textdomain( $domain ) { + global $l10n; + + $plugin_override = apply_filters( 'override_unload_textdomain', false, $domain ); + + if ( $plugin_override ) + return true; + + do_action( 'unload_textdomain', $domain ); + + if ( isset( $l10n[$domain] ) ) { + unset( $l10n[$domain] ); + return true; + } + + return false; +} + /** * Loads default translated strings based on locale. * * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The - * translated (.mo) file is named based off of the locale. + * translated (.mo) file is named based on the locale. * * @since 1.5.0 */ function load_default_textdomain() { $locale = get_locale(); - $mofile = WP_LANG_DIR . "/$locale.mo"; + load_textdomain( 'default', WP_LANG_DIR . "/$locale.mo" ); + + if ( ( is_multisite() || ( defined( 'WP_INSTALLING_NETWORK' ) && WP_INSTALLING_NETWORK ) ) && ! file_exists( WP_LANG_DIR . "/admin-$locale.mo" ) ) { + load_textdomain( 'default', WP_LANG_DIR . "/ms-$locale.mo" ); + return; + } + + if ( is_admin() || ( defined( 'WP_REPAIRING' ) && WP_REPAIRING ) ) + load_textdomain( 'default', WP_LANG_DIR . "/admin-$locale.mo" ); + + if ( is_network_admin() || ( defined( 'WP_INSTALLING_NETWORK' ) && WP_INSTALLING_NETWORK ) ) + load_textdomain( 'default', WP_LANG_DIR . "/admin-network-$locale.mo" ); - return load_textdomain('default', $mofile); } /** @@ -358,20 +411,37 @@ function load_default_textdomain() { * @param string $domain Unique identifier for retrieving translated strings * @param string $abs_rel_path Optional. Relative path to ABSPATH of a folder, * where the .mo file resides. Deprecated, but still functional until 2.7 - * @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precendence over $abs_rel_path + * @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precedence over $abs_rel_path */ -function load_plugin_textdomain($domain, $abs_rel_path = false, $plugin_rel_path = false) { - $locale = get_locale(); - - if ( false !== $plugin_rel_path ) - $path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/'); - else if ( false !== $abs_rel_path) - $path = ABSPATH . trim( $abs_rel_path, '/'); - else +function load_plugin_textdomain( $domain, $abs_rel_path = false, $plugin_rel_path = false ) { + $locale = apply_filters( 'plugin_locale', get_locale(), $domain ); + + if ( false !== $plugin_rel_path ) { + $path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/' ); + } else if ( false !== $abs_rel_path ) { + _deprecated_argument( __FUNCTION__, '2.7' ); + $path = ABSPATH . trim( $abs_rel_path, '/' ); + } else { $path = WP_PLUGIN_DIR; + } $mofile = $path . '/'. $domain . '-' . $locale . '.mo'; - return load_textdomain($domain, $mofile); + return load_textdomain( $domain, $mofile ); +} + +/** + * Load the translated strings for a plugin residing in the mu-plugins dir. + * + * @since 3.0.0 + * + * @param string $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. Defaults to empty string. + */ +function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) { + $locale = apply_filters( 'plugin_locale', get_locale(), $domain ); + $path = WPMU_PLUGIN_DIR . '/' . ltrim( $mu_plugin_rel_path, '/' ); + load_textdomain( $domain, trailingslashit( $path ) . "$domain-$locale.mo" ); } /** @@ -386,15 +456,40 @@ function load_plugin_textdomain($domain, $abs_rel_path = false, $plugin_rel_path * * @param string $domain Unique identifier for retrieving translated strings */ -function load_theme_textdomain($domain, $path = false) { - $locale = get_locale(); +function load_theme_textdomain( $domain, $path = false ) { + $locale = apply_filters( 'theme_locale', get_locale(), $domain ); + + if ( ! $path ) + $path = get_template_directory(); - $path = ( empty( $path ) ) ? get_template_directory() : $path; + // Load the textdomain from the Theme provided location, or theme directory first + $mofile = "{$path}/{$locale}.mo"; + if ( $loaded = load_textdomain($domain, $mofile) ) + return $loaded; - $mofile = "$path/$locale.mo"; + // Else, load textdomain from the Language directory + $mofile = WP_LANG_DIR . "/themes/{$domain}-{$locale}.mo"; return load_textdomain($domain, $mofile); } +/** + * Loads the child themes translated strings. + * + * If the current locale exists as a .mo file in the child themes root directory, it + * will be included in the translated strings by the $domain. + * + * The .mo files must be named based on the locale exactly. + * + * @since 2.9.0 + * + * @param string $domain Unique identifier for retrieving translated strings + */ +function load_child_theme_textdomain( $domain, $path = false ) { + if ( ! $path ) + $path = get_stylesheet_directory(); + return load_theme_textdomain( $domain, $path ); +} + /** * Returns the Translations instance for a domain. If there isn't one, * returns empty Translations instance. @@ -402,13 +497,24 @@ function load_theme_textdomain($domain, $path = false) { * @param string $domain * @return object A Translation instance */ -function &get_translations_for_domain( $domain ) { +function get_translations_for_domain( $domain ) { global $l10n; - $empty = &new Translations; - if ( isset($l10n[$domain]) ) - return $l10n[$domain]; - else - return $empty; + if ( !isset( $l10n[$domain] ) ) { + $l10n[$domain] = new NOOP_Translations; + } + return $l10n[$domain]; +} + +/** + * Whether there are translations for the domain + * + * @since 3.0.0 + * @param string $domain + * @return bool Whether there are translations + */ +function is_textdomain_loaded( $domain ) { + global $l10n; + return isset( $l10n[$domain] ); } /** @@ -424,4 +530,24 @@ function &get_translations_for_domain( $domain ) { function translate_user_role( $name ) { return translate_with_gettext_context( before_last_bar($name), 'User role' ); } -?> + +/** + * Get all available languages based on the presence of *.mo files in a given directory. The default directory is WP_LANG_DIR. + * + * @since 3.0.0 + * + * @param string $dir A directory in which to search for language files. The default directory is WP_LANG_DIR. + * @return array Array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names. + */ +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; + } + + return $languages; +} \ No newline at end of file