]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/l10n.php
Wordpress 2.8-scripts
[autoinstalls/wordpress.git] / wp-includes / l10n.php
index 35f89c58ebf5d5930db3f532bf772aafa2273ae7..335bc119c851f08738bb5151562702a9b8892352 100644 (file)
@@ -7,25 +7,23 @@
  */
 
 /**
  */
 
 /**
- * get_locale() - Gets the current locale
+ * Gets 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 '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.
+ * 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.
  *
  *
- * The process to get the locale should only be done once
- * but the locale will always be filtered using the
- * 'locale' hook.
+ * 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
  *
  * @since 1.5.0
- * @uses apply_filters() Calls 'locale' hook on locale value
- * @uses $locale Gets the locale stored in the global
+ * @uses apply_filters() Calls 'locale' hook on locale value.
+ * @uses $locale Gets the locale stored in the global.
  *
  *
- * @return string The locale of the blog or from the 'locale' hook
+ * @return string The locale of the blog or from the 'locale' hook.
  */
 function get_locale() {
        global $locale;
  */
 function get_locale() {
        global $locale;
@@ -40,48 +38,38 @@ function get_locale() {
        if (empty($locale))
                $locale = 'en_US';
 
        if (empty($locale))
                $locale = 'en_US';
 
-       $locale = apply_filters('locale', $locale);
-
-       return $locale;
+       return apply_filters('locale', $locale);
 }
 
 /**
 }
 
 /**
- * translate() - Retrieve the translated text
- *
- * If the domain is set in the $l10n global, then the text is run
- * through the domain's translate method. After it is passed to
- * the 'gettext' filter hook, along with the untranslated text as
- * the second parameter.
- *
- * If the domain is not set, the $text is just returned.
+ * Retrieves the translation of $text. If there is no translation, or
+ * the domain isn't loaded the original text is returned.
  *
  *
+ * @see __() Don't use translate() directly, use __()
  * @since 2.2.0
  * @since 2.2.0
- * @uses $l10n Gets list of domain translated string (gettext_reader) objects
  * @uses apply_filters() Calls 'gettext' on domain translated text
  * @uses apply_filters() Calls 'gettext' on domain translated text
- *             with the untranslated text as second parameter
+ *             with the untranslated text as second parameter.
  *
  *
- * @param string $text Text to translate
- * @param string $domain Domain to retrieve the translated text
+ * @param string $text Text to translate.
+ * @param string $domain Domain to retrieve the translated text.
  * @return string Translated text
  */
  * @return string Translated text
  */
-function translate($text, $domain = 'default') {
-       global $l10n;
+function translate( $text, $domain = 'default' ) {
+       $translations = &get_translations_for_domain( $domain );
+       return apply_filters('gettext', $translations->translate($text), $text, $domain);
+}
 
 
-       if (isset($l10n[$domain]))
-               return apply_filters('gettext', $l10n[$domain]->translate($text), $text);
+function before_last_bar( $string ) {
+       $last_bar = strrpos( $string, '|' );
+       if ( false == $last_bar )
+               return $string;
        else
        else
-               return $text;
+               return substr( $string, 0, $last_bar );
 }
 
 /**
 }
 
 /**
- * translate_with_context() - Retrieve the translated text and strip context
- *
- * If the domain is set in the $l10n global, then the text is run
- * through the domain's translate method. After it is passed to
- * the 'gettext' filter hook, along with the untranslated text as
- * the second parameter.
- *
- * If the domain is not set, the $text is just returned.
+ * Translates $text like translate(), but assumes that the text
+ * contains a context after its last vertical bar.
  *
  * @since 2.5
  * @uses translate()
  *
  * @since 2.5
  * @uses translate()
@@ -90,21 +78,19 @@ function translate($text, $domain = 'default') {
  * @param string $domain Domain to retrieve the translated text
  * @return string Translated text
  */
  * @param string $domain Domain to retrieve the translated text
  * @return string Translated text
  */
-function translate_with_context($text, $domain = 'default') {
-       $whole = translate($text, $domain);
-       $last_bar = strrpos($whole, '|');
-       if ( false == $last_bar ) {
-               return $whole;
-       } else {
-               return substr($whole, 0, $last_bar);
-       }
+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);
 }
 
 /**
 }
 
 /**
- * __() - Retrieve a translated string
- *
- * __() is a convenience function which retrieves the translated
- * string from the translate().
+ * Retrieves the translation of $text. If there is no translation, or
+ * the domain isn't loaded the original text is returned.
  *
  * @see translate() An alias of translate()
  * @since 2.1.0
  *
  * @see translate() An alias of translate()
  * @since 2.1.0
@@ -113,42 +99,95 @@ function translate_with_context($text, $domain = 'default') {
  * @param string $domain Optional. Domain to retrieve the translated text
  * @return string Translated text
  */
  * @param string $domain Optional. Domain to retrieve the translated text
  * @return string Translated text
  */
-function __($text, $domain = 'default') {
-       return translate($text, $domain);
+function __( $text, $domain = 'default' ) {
+       return translate( $text, $domain );
+}
+
+/**
+ * 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.
+ *
+ * @see translate() An alias of translate()
+ * @see esc_attr()
+ * @since 2.8.0
+ *
+ * @param string $text Text to translate
+ * @param string $domain Optional. Domain to retrieve the translated text
+ * @return string Translated text
+ */
+function esc_attr__( $text, $domain = 'default' ) {
+       return esc_attr( translate( $text, $domain ) );
 }
 
 }
 
-// .
 /**
 /**
- * _e() - Display a translated string
+ * 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.
  *
  *
- * _e() is a convenience function which displays the returned
- * translated text from translate().
+ * @see translate() An alias of translate()
+ * @see esc_html()
+ * @since 2.8.0
+ *
+ * @param string $text Text to translate
+ * @param string $domain Optional. Domain to retrieve the translated text
+ * @return string Translated text
+ */
+function esc_html__( $text, $domain = 'default' ) {
+       return esc_html( translate( $text, $domain ) );
+}
+
+/**
+ * Displays the returned translated text from translate().
  *
  *
- * @see translate() Echos returned translate() string
+ * @see translate() Echoes returned translate() string
  * @since 1.2.0
  *
  * @param string $text Text to translate
  * @param string $domain Optional. Domain to retrieve the translated text
  */
  * @since 1.2.0
  *
  * @param string $text Text to translate
  * @param string $domain Optional. Domain to retrieve the translated text
  */
-function _e($text, $domain = 'default') {
-       echo translate($text, $domain);
+function _e( $text, $domain = 'default' ) {
+       echo translate( $text, $domain );
+}
+
+/**
+ * Displays translated text that has been escaped for safe use in an attribute.
+ *
+ * @see translate() Echoes returned translate() string
+ * @see esc_attr()
+ * @since 2.8.0
+ *
+ * @param string $text Text to translate
+ * @param string $domain Optional. Domain to retrieve the translated text
+ */
+function esc_attr_e( $text, $domain = 'default' ) {
+       echo esc_attr( translate( $text, $domain ) );
+}
+
+/**
+ * Displays translated text that has been escaped for safe use in HTML output.
+ *
+ * @see translate() Echoes returned translate() string
+ * @see esc_html()
+ * @since 2.8.0
+ *
+ * @param string $text Text to translate
+ * @param string $domain Optional. Domain to retrieve the translated text
+ */
+function esc_html_e( $text, $domain = 'default' ) {
+       echo esc_html( translate( $text, $domain ) );
 }
 
 /**
 }
 
 /**
- * _c() - Retrieve context translated string
+ * Retrieve translated string with vertical bar context
  *
  *
- * Quite a few times, there will be collisions with similar
- * translatable text found in more than two places but with
- * different translated 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.
+ * 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.
  *
  *
- * 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.
+ * 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.2.0
  *
@@ -160,16 +199,30 @@ function _c($text, $domain = 'default') {
        return translate_with_context($text, $domain);
 }
 
        return translate_with_context($text, $domain);
 }
 
+function _x( $single, $context, $domain = 'default' ) {
+       return translate_with_gettext_context( $single, $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);
+}
+
 /**
 /**
- * __ngettext() - Retrieve the plural or single form based on the amount
+ * Retrieve the plural or single form based on the amount.
  *
  *
- * If the domain is not set in the $l10n list, then a comparsion
- * will be made and either $plural or $single parameters returned.
+ * If the domain is not set in the $l10n list, then a comparison will be made
+ * and either $plural or $single parameters returned.
  *
  *
- * If the domain does exist, then the parameters $single, $plural,
- * and $number will first be passed to the 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.
+ * If the domain does exist, then the parameters $single, $plural, and $number
+ * will first be passed to the 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.
  *
  * @since 1.2.0
  * @uses $l10n Gets list of domain translated string (gettext_reader) objects
  *
  * @since 1.2.0
  * @uses $l10n Gets list of domain translated string (gettext_reader) objects
@@ -182,53 +235,79 @@ function _c($text, $domain = 'default') {
  * @param string $domain Optional. The domain identifier the text should be retrieved in
  * @return string Either $single or $plural translated text
  */
  * @param string $domain Optional. The domain identifier the text should be retrieved in
  * @return string Either $single or $plural translated text
  */
-function __ngettext($single, $plural, $number, $domain = 'default') {
-       global $l10n;
+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
+ *
+ */
+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 );
+       $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);
 
 
-       if (isset($l10n[$domain])) {
-               return apply_filters('ngettext', $l10n[$domain]->ngettext($single, $plural, $number), $single, $plural, $number);
-       } else {
-               if ($number != 1)
-                       return $plural;
-               else
-                       return $single;
-       }
 }
 
 /**
 }
 
 /**
- * __ngettext_noop() - register plural strings in POT file, but don't translate them
+ * Register plural strings in POT file, but don't translate them.
  *
  * Used when you want do keep structures with translatable plural strings and
  * use them later.
  *
  * Example:
  *  $messages = array(
  *
  * Used when you want do keep structures with translatable plural strings and
  * use them later.
  *
  * Example:
  *  $messages = array(
- *     'post' => ngettext_noop('%s post', '%s posts'),
- *     'page' => ngettext_noop('%s pages', '%s pages')
+ *     'post' => _n_noop('%s post', '%s posts'),
+ *     'page' => _n_noop('%s pages', '%s pages')
  *  );
  *  ...
  *  $message = $messages[$type];
  *  );
  *  ...
  *  $message = $messages[$type];
- *  $usable_text = sprintf(__ngettext($message[0], $message[1], $count), $count);
+ *  $usable_text = sprintf(_n($message[0], $message[1], $count), $count);
  *
  * @since 2.5
  * @param $single Single form to be i18ned
  * @param $plural Plural form to be i18ned
  *
  * @since 2.5
  * @param $single Single form to be i18ned
  * @param $plural Plural form to be i18ned
- * @param $number Not used, here for compatibility with __ngettext, optional
- * @param $domain Not used, here for compatibility with __ngettext, optional
  * @return array array($single, $plural)
  */
  * @return array array($single, $plural)
  */
-function __ngettext_noop($single, $plural, $number=1, $domain = 'default') {
-       return array($single, $plural);
+function _n_noop( $single, $plural ) {
+       return array( $single, $plural );
 }
 
 /**
 }
 
 /**
- * load_textdomain() - Loads MO file into the list of domains
+ * Register plural strings with context in POT file, but don't translate them.
  *
  *
- * If the domain already exists, the inclusion will fail. If the
- * MO file is not readable, the inclusion will fail.
+ * @see _n_noop()
+ */
+function _nx_noop( $single, $plural, $context ) {
+       return array( $single, $plural, $context );
+}
+
+
+/**
+ * Loads MO file into the list of domains.
+ *
+ * If the domain already exists, the inclusion will fail. If the MO file is not
+ * readable, the inclusion will fail.
  *
  *
- * On success, the mofile will be placed in the $l10n global by
- * $domain and will be an gettext_reader object.
+ * On success, the .mo file will be placed in the $l10n global by $domain
+ * and will be an gettext_reader object.
  *
  * @since 1.5.0
  * @uses $l10n Gets list of domain translated string (gettext_reader) objects
  *
  * @since 1.5.0
  * @uses $l10n Gets list of domain translated string (gettext_reader) objects
@@ -242,28 +321,22 @@ function __ngettext_noop($single, $plural, $number=1, $domain = 'default') {
 function load_textdomain($domain, $mofile) {
        global $l10n;
 
 function load_textdomain($domain, $mofile) {
        global $l10n;
 
-       if ( is_readable($mofile))
-               $input = new CachedFileReader($mofile);
-       else
-               return;
+       if ( !is_readable($mofile)) return;
 
 
-       $gettext = new gettext_reader($input);
+       $mo = new MO();
+       $mo->import_from_file( $mofile );
 
 
-       if (isset($l10n[$domain])) {
-               $l10n[$domain]->load_tables();
-               $gettext->load_tables();
-               $l10n[$domain]->cache_translations = array_merge($gettext->cache_translations, $l10n[$domain]->cache_translations);
-       } else
-               $l10n[$domain] = $gettext;
+       if (isset($l10n[$domain]))
+               $mo->merge_with( $l10n[$domain] );
 
 
-       unset($input, $gettext);
+       $l10n[$domain] = &$mo;
 }
 
 /**
 }
 
 /**
- * load_default_textdomain() - Loads default translated strings based on locale
+ * 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.
+ * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The
+ * translated (.mo) file is named based off of the locale.
  *
  * @since 1.5.0
  */
  *
  * @since 1.5.0
  */
@@ -276,11 +349,10 @@ function load_default_textdomain() {
 }
 
 /**
 }
 
 /**
- * load_plugin_textdomain() - Loads the plugin's translated strings
+ * Loads the 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 domain with a
- * dash followed by a dash, and then the locale exactly.
+ * 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 domain with a dash, and then the locale exactly.
  *
  * @since 1.5.0
  *
  *
  * @since 1.5.0
  *
@@ -291,7 +363,7 @@ function load_default_textdomain() {
  */
 function load_plugin_textdomain($domain, $abs_rel_path = false, $plugin_rel_path = false) {
        $locale = get_locale();
  */
 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)
        if ( false !== $plugin_rel_path )
                $path = WP_PLUGIN_DIR . '/' . trim( $plugin_rel_path, '/');
        else if ( false !== $abs_rel_path)
@@ -304,7 +376,7 @@ function load_plugin_textdomain($domain, $abs_rel_path = false, $plugin_rel_path
 }
 
 /**
 }
 
 /**
- * load_theme_textdomain() - Includes theme's translated strings for the theme
+ * Loads the theme's translated strings.
  *
  * If the current locale exists as a .mo file in the theme's root directory, it
  * will be included in the translated strings by the $domain.
  *
  * If the current locale exists as a .mo file in the theme's root directory, it
  * will be included in the translated strings by the $domain.
@@ -315,11 +387,42 @@ function load_plugin_textdomain($domain, $abs_rel_path = false, $plugin_rel_path
  *
  * @param string $domain Unique identifier for retrieving translated strings
  */
  *
  * @param string $domain Unique identifier for retrieving translated strings
  */
-function load_theme_textdomain($domain) {
+function load_theme_textdomain($domain, $path = false) {
        $locale = get_locale();
 
        $locale = get_locale();
 
-       $mofile = get_template_directory() . "/$locale.mo";
+       $path = ( empty( $path ) ) ? get_template_directory() : $path;
+
+       $mofile = "$path/$locale.mo";
        load_textdomain($domain, $mofile);
 }
 
        load_textdomain($domain, $mofile);
 }
 
+/**
+ * Returns the Translations instance for a domain. If there isn't one,
+ * returns empty Translations instance.
+ *
+ * @param string $domain
+ * @return object A Translation instance
+ */
+function &get_translations_for_domain( $domain ) {
+       global $l10n;
+       $empty = &new Translations;
+       if ( isset($l10n[$domain]) )
+               return $l10n[$domain];
+       else
+               return $empty;
+}
+
+/**
+ * Translates role name. Since the role names are in the database and
+ * not in the source there 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
+ * 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
+ * won't suffer from that problem.
+ */
+function translate_user_role( $name ) {
+       return before_last_bar( translate_with_gettext_context( $name, 'User role' ) );
+}
 ?>
 ?>