if (empty($locale))
$locale = 'en_US';
- $locale = apply_filters('locale', $locale);
-
- return $locale;
+ return apply_filters('locale', $locale);
}
/**
- * 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
- * @uses $l10n Gets list of domain translated string (gettext_reader) objects.
* @uses apply_filters() Calls 'gettext' on domain translated text
* with the untranslated text as second parameter.
*
* @param string $domain Domain to retrieve the translated text.
* @return string Translated text
*/
-function translate($text, $domain = 'default') {
- global $l10n;
-
- if (isset($l10n[$domain]))
- return apply_filters('gettext', $l10n[$domain]->translate($text), $text, $domain);
- else
- return apply_filters('gettext', $text, $text, $domain);
+function translate( $text, $domain = 'default' ) {
+ $translations = &get_translations_for_domain( $domain );
+ return apply_filters('gettext', $translations->translate($text), $text, $domain);
}
function before_last_bar( $string ) {
}
/**
- * 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()
}
+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);
+}
+
/**
- * 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
* @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 ) );
+}
+
+/**
+ * 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.
+ *
+ * @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
*/
-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 ) );
}
/**
- * Retrieve context translated string.
+ * 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 ) );
+}
+
+/**
+ * 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.
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);
+}
+
/**
* 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
+ * 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
* @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;
-
- 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;
- }
+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 __ngettext() An alias of __ngettext
+ * @see _n() A version of _n(), which supports contexts --
+ * strips everything from the translation after the last bar
*
*/
-function _n() {
- $args = func_get_args();
- return call_user_func_array('__ngettext', $args);
+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 );
}
/**
- * @see _n() A version of _n(), which supports contexts --
- * strips everything from the translation after the last bar
- *
+ * @deprecated Use _n_noop()
*/
-function _nc( $single, $plural, $number, $domain = 'default' ) {
- return before_last_bar( __ngettext( $single, $plural, $number, $domain ) );
+function __ngettext_noop() {
+ _deprecated_function( __FUNCTION__, '2.8', '_n_noop()' );
+ $args = func_get_args();
+ return call_user_func_array('_n_noop', $args);
+
}
/**
*
* 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];
- * $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
- * @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)
*/
-function __ngettext_noop($single, $plural, $number=1, $domain = 'default') {
- return array($single, $plural);
+function _n_noop( $single, $plural ) {
+ return array( $single, $plural );
}
/**
- * @see __ngettext_noop() An alias of __ngettext_noop()
+ * Register plural strings with context in POT file, but don't translate them.
*
+ * @see _n_noop()
*/
-function _n_noop() {
- $args = func_get_args();
- return call_user_func_array('__ngettext_noop', $args);
+function _nx_noop( $single, $plural, $context ) {
+ return array( $single, $plural, $context );
}
+
/**
- * Loads MO file into the list of domains.
+ * Loads a MO file into the domain $domain.
*
- * If the domain already exists, the inclusion will fail. If the MO file is not
- * readable, the inclusion will fail.
+ * If the domain already exists, the translations will be merged. If both
+ * sets have the same string, the translation from the original value will be taken.
*
- * 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 a MO object.
*
* @since 1.5.0
- * @uses $l10n Gets list of domain translated string (gettext_reader) objects
- * @uses CacheFileReader Reads the MO file
- * @uses gettext_reader Allows for retrieving translated strings
+ * @uses $l10n Gets list of domain translated string objects
*
* @param string $domain Unique identifier for retrieving translated strings
* @param string $mofile Path to the .mo file
- * @return null On failure returns null and also on success returns nothing.
+ * @return bool true on success, false on failure
*/
function load_textdomain($domain, $mofile) {
global $l10n;
- if ( is_readable($mofile))
- $input = new CachedFileReader($mofile);
- else
- return;
+ if ( !is_readable( $mofile ) ) return false;
- $gettext = new gettext_reader($input);
+ $mo = new MO();
+ if ( !$mo->import_from_file( $mofile ) ) return false;
- 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;
+ return true;
}
/**
$mofile = WP_LANG_DIR . "/$locale.mo";
- load_textdomain('default', $mofile);
+ return load_textdomain('default', $mofile);
}
/**
* 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.
+ * The .mo file should be named based on the domain with a dash, and then the locale exactly.
*
* @since 1.5.0
*
$path = WP_PLUGIN_DIR;
$mofile = $path . '/'. $domain . '-' . $locale . '.mo';
- load_textdomain($domain, $mofile);
+ return load_textdomain($domain, $mofile);
}
/**
$path = ( empty( $path ) ) ? get_template_directory() : $path;
$mofile = "$path/$locale.mo";
- load_textdomain($domain, $mofile);
+ return 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 translate_with_gettext_context( before_last_bar($name), 'User role' );
+}
?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff